Agents

Create a new agent

Create a new voice AI agent

POST
/agents
Authorization<token>

API key in the format: Bearer YOUR_API_KEY

In: header

namestring
Length1 <= length <= 255
systemPrompt?string
Lengthlength <= 32000
slmModelId?string|null
Formatuuid
voiceId?string|null
Formatuuid
voiceSpeed?number
Default1
Range0.6 <= value <= 1.5
voiceStability?number

Voice stability setting (ElevenLabs/Faseeh only)

Default0.5
Range0 <= value <= 1
turnEndpointDelay?integer|null

Silence duration in ms before the agent responds (default: 100)

Range50 <= value <= 2000
minTurnDuration?integer|null

Minimum speech duration in ms to count as a valid turn (default: 50)

Range0 <= value <= 2000
minInterruptionDuration?integer|null

How long in ms the user must speak to interrupt the agent (default: 100)

Range0 <= value <= 2000
frameActivationThreshold?number|null

VAD probability threshold for speech detection (default: 0.35)

Range0 <= value <= 1
postSpeechCooldown?integer|null

Echo guard timeout in ms after agent stops speaking (default: 400)

Range0 <= value <= 5000
ultravadEotThreshold?number|null

End-of-turn probability threshold (default: 0.1)

Range0 <= value <= 1
speculativeSilenceMs?integer|null

How quickly in ms to start speculative inference on silence (default: 150)

Range0 <= value <= 5000
fallbackSilenceMs?integer|null

Fallback timeout in ms if endpointing fails (default: 3000)

Range0 <= value <= 10000
allowEndCall?boolean
Defaulttrue
isActive?boolean
Defaulttrue
postCallSummaryEnabled?boolean
Defaultfalse
postCallExtractionSchema?
Default[]
postCallWebhookUrl?string|null
Formaturi
postCallWebhookSecret?string|null
firstSpeaker?string
Default"user"
Value in"user" | "agent"
agentGreeting?string|null
Lengthlength <= 1000
agentGreetingEnabled?boolean
Defaultfalse
firstMessageUninterruptible?boolean

Whether the agent's first message cannot be interrupted by the user (only applies when firstSpeaker is 'agent')

Defaultfalse
firstMessageDelay?integer

Milliseconds to wait before the agent sends its first message (only applies when firstSpeaker is 'agent')

Default0
Range0 <= value <= 10000
maxCallDurationSeconds?integer
Default600
Range30 <= value <= 3600
languageHint?string|null

ISO 639-1 language code hint for transcription (e.g., 'ar', 'en')

Lengthlength <= 10
knowledgeSearchInstructions?string|null

Custom instructions for when the agent should search its knowledge base

Lengthlength <= 2000
backgroundSoundId?string|null

ID of the background sound to play during calls

Formatuuid
backgroundSoundVolume?number

Volume of the background sound (0.0 to 1.0)

Default0.15
Range0 <= value <= 1
holdMessage?string|null

Message the agent speaks to the caller when placing them on hold during a warm transfer

Lengthlength <= 500
holdMusicUrl?string|null

URL of hold music audio to play while the caller is on hold during a warm transfer

Lengthlength <= 500

Response Body

application/json

application/json

application/json

curl -X POST "https://api.chorus-ai.co/v1/agents" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "systemPrompt": "string",
    "slmModelId": "063c8b9b-716c-4479-8636-e6af423a21d0",
    "voiceId": "a03665cd-ad55-4641-90b0-a6149c64fe33",
    "voiceSpeed": 1,
    "voiceStability": 0.5,
    "turnEndpointDelay": 50,
    "minTurnDuration": 2000,
    "minInterruptionDuration": 2000,
    "frameActivationThreshold": 1,
    "postSpeechCooldown": 5000,
    "ultravadEotThreshold": 1,
    "speculativeSilenceMs": 5000,
    "fallbackSilenceMs": 10000,
    "isActive": true,
    "allowEndCall": true,
    "postCallSummaryEnabled": false,
    "postCallExtractionSchema": [],
    "postCallWebhookUrl": "http://example.com",
    "postCallWebhookSecret": "string",
    "firstSpeaker": "user",
    "agentGreeting": "string",
    "agentGreetingEnabled": true,
    "firstMessageUninterruptible": false,
    "firstMessageDelay": 0,
    "maxCallDurationSeconds": 600,
    "languageHint": "string",
    "knowledgeSearchInstructions": "string",
    "backgroundSoundId": "2d4fd124-f5e0-412f-938f-f63bafc5b5c7",
    "backgroundSoundVolume": 0.15,
    "holdMessage": "string",
    "holdMusicUrl": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
{
  "error": "string",
  "details": [
    {}
  ]
}
{
  "error": "string",
  "details": [
    {}
  ]
}

Last updated on