Getting Started
Siesta AI External API umožňuje vašemu backendu vytvářet, číst a upravovat vybrané Siesta AI resources z vlastních systémů. Hodí se pro server-side integrace, admin workflow, reporting a aplikační funkce, které potřebují stabilní HTTP kontrakt.
Base URL
Používejte produkční API base URL:
https://api.siesta.ai
Endpoint paths v referenci obsahují prefix /api/v1. Base URL spojte s cestou uvedenou u konkrétního endpointu.
First Request
Začněte read-only endpointem, například výpisem agents nebo tasks. API credentials držte na backendu a s každým requestem posílejte povinné headers.
curl -X GET "https://api.siesta.ai/api/v1/Agent?Limit=10" \
-H "X-Api-Key: <api-key>" \
-H "X-Org-Id: <organization-id>"
V External API Reference najdete přesné paths, query parameters, request bodies, response schemas a examples z aktuálního OpenAPI kontraktu.
Pagination And Errors
List endpointy běžně přijímají pagination parameters jako Offset a Limit, pokud jsou uvedené v OpenAPI kontraktu. Responses a error shapes jsou dokumentované u každého endpointu v referenci.
Status families zpracovávejte konzistentně:
2xx: request succeeded.4xx: request byl odmítnutý kvůli inputu, authentication, authorization, rate limitu nebo chybějícímu resource.5xx: Siesta AI nemohla request dokončit.
Recommended Workflow
- Otevřete endpoint v referenci.
- Zkopírujte curl sample a nahraďte placeholders.
- Otestujte read-only request.
- U větších integrací vygenerujte typed helpers z OpenAPI dokumentu.
- Sledujte API změny na What's New.