The API is currently in Beta. Some functionality may change in future releases.
Gateway URL
Versioning
The API is currently at versionv1. All endpoints are versioned through the v1 segment in the URL prefix /api/v1/cloud — no additional version header is required.
Available APIs
Request size limits
- Maximum request body size: 4 MB
- Requests exceeding this limit are truncated, causing JSON parsing to fail with
400 invalid_request_error(message: “Request body must be valid JSON.”).
Required headers
Every API request must include the authentication header; Content-Type is recommended but not mandatory — the server can auto-detect:Beta status
- The API surface is broadly stable, but signatures may receive minor adjustments in future iterations.
- New functionality ships behind new beta identifiers.
- Lock the API version and add compatibility handling when running in production.
- All current features are available without an additional Beta header.
Quick connectivity check
Rate Limiting
The API application layer currently has no active rate limiting. The gateway layer has global burst traffic suppression and DDoS protection, which may return 429 or 503 when triggered. Clients should implement exponential backoff retry for 5xx/429 (1s → 2s → 4s, max 3 retries).Next steps
Authentication
Obtain and use a PAT.
Errors
Error codes and troubleshooting.
Pagination
Pagination for list endpoints.