v1

latestOpenAPI 3.1.0MIT2026-07-26134154266.9 KB

Create an AI phone agent

Create an AI phone agent powered by the latest voice model. Use GET /phone/voices to browse available voices. Only name is required — everything else has sensible defaults.

post/phone

Request body

namestring required

Agent display name

type'inbound' | 'outbound'

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

voice_idstring nullable

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

languagestring[]

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.

first_messagestring nullable

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

instructionsstring[] nullable

Training scenario IDs to attach to this agent

handoff_phone_numberstring nullable

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

use_org_knowledgebaseboolean nullable

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

actionIdsstring[] nullable

Action IDs the agent can call during conversations

Response

Default Response

idstring required

org_idstring required

phone_numberstring nullable required

namestring nullable required

type'inbound' | 'outbound' required

languagestring[] required

accentstring nullable required

handoff_phone_numberstring nullable required

speednumber nullable required

interruptibleboolean required

actionIdsstring[] nullable required

instructionsstring[] nullable required

data_collection_fieldsstring[] nullable required

data_collection_webhook_urlstring nullable required

model'oppie-vox' | 'oppie-vox-turbo' | 'oppie-vox-2' | 'oppie-vox-livekit' required

voice_idstring nullable required

first_messagestring nullable required

created_atstring date-time required

updated_atstring date-time required

provider_external_idstring nullable required

{"stackTrail":"components:schemas:PhoneAgentDto:properties:flow:anyOf","oasType":"schema","type":"unknown","nullable":true}

custom_llmstring nullable required

use_org_knowledgebaseboolean required

background_noise_preset'office' | 'bar' | 'city-street' nullable required

recording_enabledboolean required

stt_keytermsstring[] required

tts_speed_pctinteger nullable required

failover_transfer_destination_idstring uuid nullable required