Skip to main content
POST
Create an AI phone agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

Agent display name

type
enum<string>

Agent type: "inbound" (receives calls, default) or "outbound" (makes calls)

Available options:
inbound,
outbound
voice_id
string | null

Voice ID from the /phone/voices endpoint. Omit for default voice.

language
string[]

ISO-639-1 language codes the agent should speak. A subset of {en, es, fr, de, hi, ru, pt, ja, it, nl} can be combined freely. Any other code (e.g. "ar", "tr", "zh") must be the only entry.

Minimum array length: 1
first_message
string | null

What the agent says when it picks up (default: "Hello?")

instructions
string[] | null

Training scenario IDs to attach to this agent

handoff_phone_number
string | null

Phone number to transfer to when handing off to a human (E.164 format)

use_org_knowledgebase
boolean | null

Whether the agent can search your knowledge base during calls (default: false)

actionIds
string[] | null

Action IDs the agent can call during conversations

Response

Default Response

id
string
required
org_id
string
required
phone_number
string | null
required
name
string | null
required
type
enum<string>
required
Available options:
inbound,
outbound
language
string[]
required
accent
string | null
required
handoff_phone_number
string | null
required
speed
number | null
required
interruptible
boolean
required
actionIds
string[] | null
required
instructions
string[] | null
required
data_collection_fields
string[] | null
required
data_collection_webhook_url
string | null
required
model
enum<string>
required
Available options:
oppie-vox,
oppie-vox-turbo,
oppie-vox-2,
oppie-vox-livekit
voice_id
string | null
required
first_message
string | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
provider_external_id
string | null
required
flow
unknown
required
custom_llm
string | null
required
use_org_knowledgebase
boolean
required
background_noise_preset
enum<string> | null
required
Available options:
office,
bar,
city-street
recording_enabled
boolean
required
stt_keyterms
string[]
required
stt_model
enum<string> | null
required
Available options:
deepgram/flux-general,
deepgram/nova-3,
deepgram/nova-3-medical,
cartesia/ink-whisper,
elevenlabs/scribe_v2_realtime,
xai/stt-1,
assemblyai/universal-3-5-pro,
speechmatics/enhanced
tts_speed_pct
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
failover_transfer_destination_id
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$