> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yorlet.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

Welcome to the Yorlet API Reference. The API is designed to use standard HTTP protocols and return JSON payloads in response to HTTP requests, and are internally implemented based on the RESTful principles.

<Note>
  These docs are for the preview version of the API. To use this API please include the `Yorlet-Version` header with the value `2025-08-21.preview`.
</Note>

We recommend building against this version of the API to ensure compatibility with the latest features and improvements. You can view the legacy docs [here](https://api-docs.yorlet.com).