Skip to main content
POST

Authorizations

x-api-key
string
header
required

Echo API key — format: echo_<64 hex chars>. Returned once on signup.

Body

application/json

message is required on the LLM path (when agent_id is omitted). On the agent path (when agent_id is set), message is optional — the agent's system_prompt drives the call. Supply variables to fill any {{token}} placeholders in the prompt.

customer_id
string<uuid>
required

Must belong to your project

Example:

"8cc6199f-9466-46f2-9db7-936f3c2c1c0b"

message
string

Required for LLM path. Optional for agent path.

Example:

"Your appointment tomorrow at 10 AM has been confirmed."

context
string | null
Example:

"Patient has been a client for 3 years."

agent_id
string<uuid> | null

If set, uses Agent path. Omit for LLM-generated call.

Example:

"ddb8be3b-a426-4122-b877-a0cba363c89d"

variables
object

Custom variables injected into the agent's system_prompt via {{key}} syntax.

Example:
collect_feedback
boolean
default:false

LLM path only — ask the caller to confirm/cancel/reschedule.

max_duration_seconds
integer
default:180

LLM path only.

Required range: 30 <= x <= 600

Response

Call queued

notification
object
call
object