Sign in
Hosted Call Agent

Get Hosted Agent Config

get/api/v1/phone/hosted-agent-config

Query parameters

agent_identity_idstring uuid nullable

Target identity. Agent-scoped keys resolve their own; required for admin/JWT.

Target identity. Agent-scoped keys resolve their own; required for admin/JWT.

Response

Successful Response

agent_identity_idstring required
voice'alloy' | 'ash' | 'ballad' | 'coral' | 'echo' | 'sage' | 'shimmer' | 'verse' | 'marin' | 'cedar'
modelstring nullable

Compatibility field; accepted values are not stored or used.

effective_voice'alloy' | 'ash' | 'ballad' | 'coral' | 'echo' | 'sage' | 'shimmer' | 'verse' | 'marin' | 'cedar' required
effective_modelstring required

Server-selected model used for hosted calls.

instructionsstring nullable
authority_mode'contact_scoped' | 'yolo'

Changes

No recorded changes to this endpoint across all 1 revision of this API.