PUT
/
agents
/
{id}
curl --request PUT \
  --url https://api.vogent.ai/api/agents/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "defaultVoiceId": "<string>",
  "defaultVersionedPromptId": "<string>",
  "inboundWebhookResponse": true,
  "inboundWebhookUrl": "<string>",
  "metadata": {},
  "openingLine": {
    "lineType": "INBOUND_ONLY",
    "content": "<string>"
  },
  "voiceVolumeLevel": -100,
  "backgroundNoiseType": "noise",
  "linkedFunctionDefinitionIds": [
    "<string>"
  ],
  "transcriberParams": {
    "keywords": [
      "<string>"
    ]
  },
  "utteranceDetectorConfig": {
    "sensitivity": "ULTRA_FAST"
  }
}'
{
  "id": "<string>",
  "name": "<string>",
  "transcriberParams": {
    "keywords": [
      "<string>"
    ]
  },
  "metadata": {},
  "utteranceDetectorConfig": {
    "sensitivity": "ULTRA_FAST"
  }
}

Path Parameters

id
string
required

ID of the agent.

Body

application/json
Updates an agent
name
string

The name of the agent.

defaultVoiceId
string

The ID of the default voice to use.

defaultVersionedPromptId
string

The default versioned prompt to use for this agent.

inboundWebhookResponse
boolean
inboundWebhookUrl
string
metadata
object
openingLine
object | null

Details about the Agent's opening line. If unspecified, or null no opening line will be created.

voiceVolumeLevel
integer
default:-100

A value, generally between -300 and 300, indicating the volume level to use for the voice. The default is -100.

backgroundNoiseType
enum<string>

The background audio that's used by the agent.

Available options:
noise,
office
linkedFunctionDefinitionIds
string[]

The function definitions that should be available to this agent

transcriberParams
object
utteranceDetectorConfig
object

Response

200
application/json
Successful operation
id
string
required
name
string
required
transcriberParams
object
metadata
object
utteranceDetectorConfig
object