API overview
Which endpoints are available, how they authenticate, and what is supported today.
Content reviewed · Maintained by Cleo Powered · Report a documentation issue · Verification basis
Send API requests to https://api.cleolabs.com. This documentation website explains the API; sending a request to docs.cleopowered.com will not create a call.
Call endpoints
The four call routes submit and follow task-owned execution for API-key integrations. There is no separate public task route in this contract. All four operations require Authorization: Bearer <API_KEY>.
- Method and path
POST /v1/calls- Purpose
- Durably queue one bounded outbound task.
- Additional input
- JSON task and a separate Idempotency-Key header.
- Method and path
GET /v1/calls/{call_id}- Purpose
- Read the saved record.
- Additional input
- Call UUID in the path. No body.
- Method and path
POST /v1/calls/{call_id}/sync- Purpose
- Refresh progress from the calling service.
- Additional input
- Call UUID in the path. No body.
- Method and path
POST /v1/calls/{call_id}/cancel- Purpose
- Request cancellation.
- Additional input
- Call UUID in the path. No body.
| Method and path | Purpose | Additional input |
|---|---|---|
POST /v1/calls | Durably queue one bounded outbound task. | JSON task and a separate Idempotency-Key header. |
GET /v1/calls/{call_id} | Read the saved record. | Call UUID in the path. No body. |
POST /v1/calls/{call_id}/sync | Refresh progress from the calling service. | Call UUID in the path. No body. |
POST /v1/calls/{call_id}/cancel | Request cancellation. | Call UUID in the path. No body. |
Other exposed routes
- Authentication
- No API key
- Use
- Liveness and API readiness checks. Neither places a call.
- Authentication
- No key to view
- Use
- Generated documentation. Executing a call operation still needs a key and can place a real call.
- Route
/api/*- Authentication
- Customer session
- Use
- Separate platform API. These routes do not accept your integration API key as a substitute for a login session.
| Route | Authentication | Use |
|---|---|---|
GET /healthGET /health/ready | No API key | Liveness and API readiness checks. Neither places a call. |
GET /openapi.json | No API key | Generated schema from the deployed gateway. |
| /docs and /redoc | No key to view | Generated documentation. Executing a call operation still needs a key and can place a real call. |
/api/* | Customer session | Separate platform API. These routes do not accept your integration API key as a substitute for a login session. |
The downloadable Cleo OpenAPI file documents four call operations, four onboarding operations, and two health checks. It adds handler-enforced requirements missing from the gateway’s generated schema, including the required idempotency header and problem-JSON errors.
Current scope
- Live outbound calls only; there is no public simulation mode.
- No
GET /v1/callslist operation. Save each returned call ID. - No public API-key operations for contacts, assistants, or key management. Use the platform for those workflows.
- No webhook delivery or public transcript endpoint. Poll
/syncfor updates.
Cleo extracts structured answers from available recipient evidence. The summary or result can still be null, pending, or incomplete after a call ends. Read Results & schemas before depending on returned data.