Update agent

Update an existing agent

Authorization

Authorization<token>

API key in the format: Bearer YOUR_API_KEY

In: header

Path Parameters

idstring

Agent ID

Formatuuid

Request Body

name?string

Length1 <= length <= 255

systemPrompt?string

Lengthlength <= 32000

slmModelId?string|null

Formatuuid

voiceId?string|null

Formatuuid

voiceSpeed?number

Range0.6 <= value <= 1.5

voiceStability?number

Range0 <= value <= 1

turnEndpointDelay?integer|null

Range50 <= value <= 2000

minTurnDuration?integer|null

Range0 <= value <= 2000

minInterruptionDuration?integer|null

Range0 <= value <= 2000

frameActivationThreshold?number|null

Range0 <= value <= 1

postSpeechCooldown?integer|null

Range0 <= value <= 5000

ultravadEotThreshold?number|null

Range0 <= value <= 1

speculativeSilenceMs?integer|null

Range0 <= value <= 5000

fallbackSilenceMs?integer|null

Range0 <= value <= 10000

allowEndCall?boolean

isActive?boolean

postCallSummaryEnabled?boolean

postCallExtractionSchema?

postCallWebhookUrl?string|null

Formaturi

postCallWebhookSecret?string|null

firstSpeaker?string

Value in"user" | "agent"

agentGreeting?string|null

Lengthlength <= 1000

agentGreetingEnabled?boolean

firstMessageUninterruptible?boolean

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

firstMessageDelay?integer

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

Range0 <= value <= 10000

maxCallDurationSeconds?integer

Range30 <= value <= 3600

languageHint?string|null

Lengthlength <= 10

knowledgeSearchInstructions?string|null

Custom instructions for when the agent should search its knowledge base

Lengthlength <= 2000

backgroundSoundId?string|null

Formatuuid

backgroundSoundVolume?number

Range0 <= value <= 1

holdMessage?string|null

Lengthlength <= 500

holdMusicUrl?string|null

Lengthlength <= 500

Response Body

application/json

curl -X PATCH "https://api.chorus-ai.co/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X PATCH "https://api.chorus-ai.co/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'

{
  "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": [
    {}
  ]
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

application/json

application/json

application/json