OpenAPI Viewer
Explore endpoints in the in‑app viewer.Open
Auth & Headers
Use bearer tokens for authenticated requests. SDKs coming soon.
Response Envelope
Most endpoints return a standard envelope:
{
"code": 200,
"msg": "OK",
"data": { /* payload */ },
"total": 123 // optional for listings
}Errors use an RFC‑7807‑like structure with a detail field.
Example Request
curl -X GET \ -H 'Authorization: Bearer <YOUR_TOKEN>' -H 'Content-Type: application/json' https://api.yourdomain.com/v1/projects
Replace <YOUR_TOKEN> with your actual token.
Pagination & Filtering
- Pagination via
?limit=,?offset=(orpageon some endpoints). - Filtering via query params (e.g.,
?environment=dev). - Stable responses enable caching on the client.
Rate Limits & Errors
- 429: Rate limit exceeded — retry later or contact support to adjust quota.
- 401: Invalid or expired token — please reauthenticate.
- 4xx/5xx: JSON error messages are returned for diagnosis.