API Reference¶
REST API documentation for tenants integrating with the platform.
Auto-generated OpenAPI docs
Full interactive API reference is available at https://api.platform.com/docs (Swagger UI) and https://api.platform.com/redoc (ReDoc). The content here covers concepts not in the spec.
In this section¶
- Authentication — how to obtain and use API keys
- REST Endpoints — overview of endpoint structure
- Webhooks — subscribing to platform events
- Rate Limits — per-key limits and how to handle 429s
- Error Codes — standard error response format
- SDK Examples — Python and JavaScript examples
API versioning¶
All endpoints are prefixed with a version: /api/v1/...
Breaking changes go in a new version. v1 is supported until v2 has been generally available for 12 months minimum.
Base URLs¶
| Environment | URL |
|---|---|
| Production | https://api.platform.com/api/v1 |
| Staging | https://api.staging.platform.com/api/v1 |
Note: API requests are not subdomain-scoped to tenant. The tenant is identified by the API key.