API Documentation
Versioned Prompts
Phone Numbers
Models
curl --request GET \
--url https://api.vogent.ai/api/agents \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"name": "<string>",
"language": "<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
},
"maxDurationSeconds": 10800,
"defaultVoiceId": "<string>",
"defaultVersionedPromptId": "<string>",
"defaultExtractorId": "<string>",
"linkedFunctionDefinitions": [
{
"functionDefinitionId": "<string>",
"lifecycleMessagesOverride": {
"started": [
"<string>"
]
}
}
],
"fillEmptyStringVariables": true
}
],
"cursor": "<string>"
}List Agents
List the agents on your account.
curl --request GET \
--url https://api.vogent.ai/api/agents \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"name": "<string>",
"language": "<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
},
"maxDurationSeconds": 10800,
"defaultVoiceId": "<string>",
"defaultVersionedPromptId": "<string>",
"defaultExtractorId": "<string>",
"linkedFunctionDefinitions": [
{
"functionDefinitionId": "<string>",
"lifecycleMessagesOverride": {
"started": [
"<string>"
]
}
}
],
"fillEmptyStringVariables": true
}
],
"cursor": "<string>"
}Authorizations
In the form Bearer <api_key_here>. You can find your api key in your dashboard.
Query Parameters
The maximum number of records to fetch.
The pagination cursor returned by the previous request. Feed the result provided by vogent verbatim.
Response
Successful operation
Show child attributes
Show child attributes
The language to use for the agent.
Configuration for endpoint detection to determine when a user has finished speaking.
Show child attributes
Show child attributes
The type of endpoint detector to use.
SIMPLE, SEMANTIC The mode for the endpoint detector (only applicable for SEMANTIC type).
CONSERVATIVE, DEFAULT, AGGRESSIVE Configuration for idle messages that the agent can say when the user is silent.
Show child attributes
Show child attributes
Whether idle messages are enabled for this agent.
The list of idle messages that the agent can say when the user is silent.
The duration in milliseconds that the user must be silent before an idle message is triggered.
x >= 5000The maximum number of idle messages that can be said during a call.
x >= 1The maximum duration of the call in seconds.
The default voice ID to use for the agent.
The default versioned prompt ID to use for the agent.
The default extractor ID to use for the agent.
The function definitions that should be available to this agent.
Show child attributes
Show child attributes
The ID of the function definition to link.
Lifecycle messages to override the defaults for this function link, or null to not override.
Show child attributes
Show child attributes
Messages to display when the function starts executing. One will be chosen at random.
If true, variables that are not specified will be filled with empty strings instead of being left as template placeholders.
A cursor you can pass to /agents to fetch the next page. If no next page exists, the cursor will be null.