Skip to main content
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.
These docs are for the latest version of the API. To use this API please upgrade to the latest version or include the Yorlet-Version header with the value of 2025-08-21 or higher. 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.

Versioning

Learn how to version your API requests

Changelog

Learn about the changes introduced in each version of the API