Skip to main content

Getting Started

The Siesta AI External API lets your backend create, read, and update selected Siesta AI resources from your own systems. Use it for server-side integrations, admin workflows, reporting, and application features that need a stable HTTP contract.

Base URL​

Use the production API base URL:

https://api.siesta.ai

Endpoint paths in the reference include the /api/v1 prefix. Combine the base URL with the path shown on each endpoint.

First Request​

Start with a read-only endpoint, such as listing agents or tasks. Keep API credentials on your backend and send the required headers with each request.

curl -X GET "https://api.siesta.ai/api/v1/Agent?Limit=10" \
  -H "X-Api-Key: <api-key>" \
  -H "X-Org-Id: <organization-id>"

Use the External API Reference for exact paths, query parameters, request bodies, response schemas, and examples generated from the current OpenAPI contract.

Pagination And Errors​

List endpoints commonly accept pagination parameters such as Offset and Limit when they are present in the OpenAPI contract. Responses and error shapes are documented per endpoint in the reference.

Handle these status families consistently:

  • 2xx: request succeeded.
  • 4xx: request was rejected because of input, authentication, authorization, rate limit, or missing resource.
  • 5xx: Siesta AI could not complete the request.
  1. Read the endpoint in the reference.
  2. Copy the curl sample and replace placeholders.
  3. Test with a read-only request.
  4. Generate typed helpers from the OpenAPI document if your integration is large.
  5. Monitor API changes on What's New.