Base URL
All API endpoints are available at:Authentication
All API requests require authentication using a Bearer token. Include your API key in theAuthorization header:
Request Format
- All request bodies should be JSON with
Content-Type: application/json - Path parameters use the format
/{org}/{repo}/...whereorgis your organization slug - Query parameters are used for filtering, pagination, and optional settings
Response Format
Most endpoints return JSON responses. However, some endpoints support content negotiation via theAccept header to return alternative formats:
Example JSON response:
Pagination
List endpoints support cursor-based pagination:
Paginated responses include:
Error Handling
Errors return a consistent JSON structure with an appropriate HTTP status code:Error Codes
Server errors (5xx) additionally include an
error.trace_id. Quote it when reporting an issue.
Scopes
API keys have scoped permissions that control access:
Scope hierarchy:
admin → write → read. Each scope includes everything below it.
