calls
Create Call
Create an asynchronous call. Use result_schema and recipient_result_schema to ask CALL-E to extract structured JSON results from terminal call evidence.
Headers
Idempotency-KeyStable caller-provided key used to make create-call retries safe. Reusing the same key with the same request returns the original call instead of creating a duplicate.
Create Call › Request Body
taskNatural-language instruction for the call task. Include the goal, relevant details the voice agent should know, and the exact information you want collected.
Optional explicit recipients for this call task. Omit it when the task text already contains the phone targets CALL-E should use.
Optional JSON Schema object that defines the structured result CALL-E should extract for the whole call task.
CALL-E passes the schema, including field description values, to the extraction model after the call reaches a terminal state. Use descriptions to explain field meaning and enum selection logic, for example: "Use strong when the prospect asks about pricing, demos, or next steps."
Descriptions guide extraction but are not hard validation rules. Hard validation comes from type, required, enum, and additionalProperties.
Supported schema features are type, properties, required, enum, nested object fields, simple array.items, description, and additionalProperties: false. Unsupported features include $ref, oneOf, anyOf, allOf, recursive schemas, complex format validation, and additionalProperties: true.
Prefer string enums over booleans for business decisions that may be unclear, and include an unknown enum value when the call may not provide enough evidence.
Optional JSON Schema object that defines the structured result CALL-E should extract independently for each recipient.
This is useful for batch calls where each recipient needs their own outcome, such as can_attend, confirmed, requested_callback, or interest_level.
Do not use reserved recipient response field names such as summary, status, transcript, call_id, or timing fields as custom result fields. Use names such as customer_summary, notes, or reason instead.
Field description values are passed to the extraction model and should explain how enum values should be selected. Descriptions guide extraction but are not hard validation rules. Hard validation comes from type, required, enum, and additionalProperties.
Object schemas are strict by default. Fields not declared in properties are rejected, and unsupported or invalid recipient results are returned as null.
Optional caller-owned metadata echoed on the call and webhook payloads. Use this for workflow ids, tenant ids, or internal correlation keys.
webhook_urlOptional per-request HTTPS webhook URL. When provided, CALL-E sends terminal call events to this URL in addition to project-level webhook delivery.
Create Call › Responses
Call task accepted.
idPublic CALL-E call task identifier. Store this id to fetch state, list events, and correlate webhooks.
objectAlways call_task for call task responses.
statusCurrent call task lifecycle state.
taskOriginal task instruction submitted when the call task was created.
Recipient states for this call task.
Schema-valid structured result object extracted for the whole call task using result_schema.
null means CALL-E could not produce a schema-valid task-level result from the terminal call evidence, or no result_schema was provided. Check recipient-level structured_result when you use recipient_result_schema for batch calls.
summaryShort human-readable summary of the call task outcome. null while the call task is still running or when no useful summary is available.
task_completedPost-summary judgment for whether the task reached a clear end state for the user. null until CALL-E has a terminal post-summary outcome.
Confidence for task_completed. null until CALL-E has a terminal post-summary outcome.
evidenceShort evidence items supporting the post-summary task outcome. Empty until CALL-E has terminal evidence.
Caller-owned metadata submitted on the create call request.
failure_codeMachine-readable failure reason when status is failed; otherwise null.
failure_messageHuman-readable failure explanation when status is failed; otherwise null.
created_atISO 8601 timestamp when CALL-E accepted the call request.
completed_atISO 8601 timestamp when the call reached a terminal state. null while queued or in progress.
Get Call
Get a call by id.
path Parameters
call_id^call_[A-Za-z0-9_-]+… · requiredPublic CALL-E call identifier returned by create call. It starts with call_ and is safe to store in your workflow records.
Get Call › Responses
Current call state.
idPublic CALL-E call task identifier. Store this id to fetch state, list events, and correlate webhooks.
objectAlways call_task for call task responses.
statusCurrent call task lifecycle state.
taskOriginal task instruction submitted when the call task was created.
Recipient states for this call task.
Schema-valid structured result object extracted for the whole call task using result_schema.
null means CALL-E could not produce a schema-valid task-level result from the terminal call evidence, or no result_schema was provided. Check recipient-level structured_result when you use recipient_result_schema for batch calls.
summaryShort human-readable summary of the call task outcome. null while the call task is still running or when no useful summary is available.
task_completedPost-summary judgment for whether the task reached a clear end state for the user. null until CALL-E has a terminal post-summary outcome.
Confidence for task_completed. null until CALL-E has a terminal post-summary outcome.
evidenceShort evidence items supporting the post-summary task outcome. Empty until CALL-E has terminal evidence.
Caller-owned metadata submitted on the create call request.
failure_codeMachine-readable failure reason when status is failed; otherwise null.
failure_messageHuman-readable failure explanation when status is failed; otherwise null.
created_atISO 8601 timestamp when CALL-E accepted the call request.
completed_atISO 8601 timestamp when the call reached a terminal state. null while queued or in progress.
List Call Events
List developer-facing call events.
path Parameters
call_id^call_[A-Za-z0-9_-]+… · requiredPublic CALL-E call identifier returned by create call. It starts with call_ and is safe to store in your workflow records.
query Parameters
cursorCursor returned by the previous event page. Omit it to start at the first available event page for the call.
limitMaximum number of events to return in one page.
List Call Events › Responses
Call event page.
objectAlways list for paginated list responses.
Events in this page, ordered from oldest to newest for the requested cursor window.
next_cursorCursor for the next page. null means there are no more events.