Build with the Cleo API
Submit a phone errand, follow the call, and inspect its outcome.
Content reviewed · Maintained by Cleo Powered · Report a documentation issue · Verification basis
Verify your US phone before using the API. Muse and other execution-capable bots can register your account and obtain a key with your consent. You can also sign up in Cleo and create a key in Settings. Every call still requires your authorization. Learn about API access.
Use the Cleo API to delegate a phone errand from your application. Send a destination and a clear objective. Cleo handles the conversation and returns a call record you can follow. The response contains task and call IDs, execution progress, and evidence-backed results when available.
From task to call record
Choose who to call, what to ask, and what Cleo may do.
Use the call ID to refresh progress until the call finishes.
Check the saved status and returned call data, including schema validity.
{
"to": "+15555550123",
"objective": "Ask for Saturday opening hours.",
"constraints": [
"Identify yourself as an AI assistant."
],
"result_schema": {
"type": "object",
"properties": {
"hours": {
"type": "string"
}
},
"required": [
"hours"
]
},
"limits": {
"max_duration_seconds": 120
}
}Example number only. Replace it with your own phone number for your first test. The hours schema describes a desired result. Publication depends on the conversation and validation; missing answers are not invented.
Start building
Set up authentication and understand key ownership.
Follow a callLearn which states to expect and when to sync.
Base URL
https://api.cleolabs.comSee the API overview for the complete call and health endpoint list, plus the separate platform API boundary. All call endpoints live under /v1. Requests and responses use JSON. The API places real calls; the same purpose screening and calling permissions apply to requests made with an API key.
Already using Cleo? API-created calls appear in the platform workspace that owns your key. You can review their results there, too.