Skip to main content
POST
Create Call

Authorizations

X-API-Key
string
header
required

Workspace API key (e.g. kej_live_...)

Body

application/json

Public API call creation request.

contact_id
string | null

Existing contact ID

contact
ContactInput · object | null

New contact to create inline

persona_id
string | null

Agent (persona) to use

agent_id
string | null

Voice config ID

phone_number_id
string | null

Pin a specific origin phone number

schedule_at
string<date-time> | null

Schedule for later (ISO 8601)

priority
integer
default:50

Queue priority (higher = sooner)

Required range: 0 <= x <= 100
config
CallConfig · object | null

Call configuration

external_reference
string | null

External tracking ID

Maximum string length: 255
context
Context · object | null

Template variables for prompt

Response

Successful Response

Response after creating a call via public API.

id
string
required

Call ID

contact_id
string
required

Contact ID

status
string
required
created_at
string<date-time>
required
scheduled_at
string<date-time> | null