Trigger an Outbound Call
Initiate an outbound call using an agent's public UUID
The simplest way to initiate a call programmatically. The uuid is visible in the dashboard URL when viewing an agent.
Use workflow_run_id from the response to later retrieve call details, recordings, and transcripts.
Pass initial_context to inject runtime data as template variables into the agent's prompt. See Using initial context.
Your telephony provider must be configured before outbound calls will connect. See Telephony for setup instructions.
POST
/api/v1/public/agent/{uuid}Parameters#
| Name | Located in | Type | Required | Description |
|---|---|---|---|---|
uuid | path | string | Yes | — |
Request body#
| Field | Type | Required | Description |
|---|---|---|---|
phone_number | string | Yes | — |
initial_context | object | No | — |
Example request body:
{
"phone_number": "+14155550100",
"initial_context": {}
}Responses#
200 — Successful Response
{
"status": "string",
"workflow_run_id": 0,
"workflow_run_name": "Example Name"
}404 — Not found
422 — Validation Error
{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}