Overview
Initiate outbound calls and trigger agents via the API
| Method | Endpoint | Quick Link |
|---|---|---|
POST | /public/agent/{uuid} | Trigger an outbound call |
POST | /telephony/initiate-call | Initiate a call (authenticated) |
GET | /workflow/{workflow_id}/runs/{run_id} | Retrieve call details |
GET | /public/download/workflow/{token}/{artifact_type} | Download recordings and transcripts |
POST | /telephony/inbound/{workflow_id} | Inbound call webhook |
Using initial context#
initial_context passes runtime data into the agent at call time. Values are available as template variables in your agent's prompt using double-brace syntax.
{
"initial_context": {
"customer_name": "Jane",
"appointment_date": "March 15"
}
}Your agent prompt can then reference {{customer_name}} and {{appointment_date}} and they will be substituted when the call starts.
Run status values#
| Status | Description |
|---|---|
pending | Call queued but not yet connected |
in_progress | Call is live |
completed | Call ended normally |
failed | Call failed before or during execution |