Skip to main content
DELETE
/
agents
/
{id}
Delete Agent
curl --request DELETE \
  --url https://api.vogent.ai/api/agents/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "transcriberParams": {
    "type": "deepgram",
    "keywords": [
      "<string>"
    ]
  },
  "metadata": {},
  "utteranceDetectorConfig": {
    "sensitivity": "ULTRA_FAST"
  },
  "endpointDetectorConfig": {
    "type": "SIMPLE",
    "mode": "CONSERVATIVE"
  },
  "idleMessageConfig": {
    "enabled": true,
    "messages": [
      "<string>"
    ],
    "idleDurationMilliseconds": 5001,
    "maxIdleMessages": 2
  },
  "language": "<string>",
  "maxDurationSeconds": 10800,
  "defaultVoiceId": "<string>",
  "defaultVersionedPromptId": "<string>",
  "defaultExtractorId": "<string>",
  "linkedFunctionDefinitions": [
    {
      "functionDefinitionId": "<string>",
      "lifecycleMessagesOverride": {
        "started": [
          "<string>"
        ]
      }
    }
  ],
  "fillEmptyStringVariables": true
}

Authorizations

​
Authorization
string
header
required

In the form Bearer <api_key_here>. You can find your api key in your dashboard.

Path Parameters

​
id
string
required

ID of the agent.

Response

Successful operation

​
id
string
required
​
name
string
required
​
language
string
required

The language to use for the agent.

​
transcriberParams
object
​
metadata
object
​
utteranceDetectorConfig
object
​
endpointDetectorConfig
object

Configuration for endpoint detection to determine when a user has finished speaking.

​
idleMessageConfig
object

Configuration for idle messages that the agent can say when the user is silent.

​
maxDurationSeconds
integer
default:10800

The maximum duration of the call in seconds.

​
defaultVoiceId
string

The default voice ID to use for the agent.

​
defaultVersionedPromptId
string

The default versioned prompt ID to use for the agent.

​
defaultExtractorId
string | null

The default extractor ID to use for the agent.

​
linkedFunctionDefinitions
object[]

The function definitions that should be available to this agent.

​
fillEmptyStringVariables
boolean

If true, variables that are not specified will be filled with empty strings instead of being left as template placeholders.