Authentication
Every request requires your API key passed as a Bearer token in theAuthorization header.
Request and response format
All request bodies must be JSON. All responses are JSON. Set theContent-Type header on every request that sends a body.
Available endpoints
See the Builds API and Deploys API pages for full parameter and response documentation.
Example authenticated request
Rate limiting
The API enforces rate limits per API key. If you exceed your limit, you will receive a429 Too Many Requests response. Check your current limits and usage in the Settings > API Keys section of the dashboard.
Error responses
The API uses standard HTTP status codes to indicate success or failure.
Error responses include a JSON body with a
message field describing the problem:
