Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
An AI agent calls the customer and reports what happened.
POST /v1/calls
Idempotency-Key: 6f1c2b7e-...
{
"agent_id": "agt_credfin_dpd_8_30_m",
"to": "9876543210",
"variables": { "borrower_first_name": "Mohit", "total_overdue": 4574 },
"metadata": { "loan_id": "CF-LN-208841" },
"schedule_at": "2026-11-05T05:30:00Z"
}
| Field | Notes |
|---|---|
agent_id | One of GET /v1/agents. |
variables | The agent’s required variables. Missing: 422 missing_variables. |
from | Optional preferred caller number (GET /v1/numbers). |
schedule_at | Optional, up to 7 days ahead. |
scheduled_for says when it dials.
Status: queued → dialling → completed · no_answer · busy · failed · canceled.
Results: outcome, summary, final_variables on the call; GET /v1/calls/{id}/transcript, /analysis, /recording.
Stop it: DELETE /v1/calls/{id} (queued) · POST /v1/calls/{id}/hangup (live).
Webhooks: call.ended, then call.analyzed.