API Reference
The Celeris API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Base URL
https://api.celeriscloud.io/v1 Authentication
The Celeris API uses API keys to authenticate requests. You can view and manage your API keys in the Dashboard.
Your API keys carry many privileges, so be sure to keep them secure. Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, etc.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Core Resources
Error Codes
Celeris uses conventional HTTP response codes to indicate the success or failure of an API request.
| Code | Description |
|---|---|
200 | OK - Everything worked as expected |
400 | Bad Request - Invalid parameters |
401 | Unauthorized - Invalid API key |
403 | Forbidden - Insufficient permissions |
404 | Not Found - Resource does not exist |
429 | Too Many Requests - Rate limit exceeded |
500 | Server Error - Something went wrong on our end |
Rate Limits
API requests are rate limited based on your plan. Rate limit information is included in response headers.
Workflows API Coming Soon
The Workflows API allows you to build and execute automation workflows that chain multiple agents and actions together.