API Documentation
Versioned Prompts
Phone Numbers
Models
Agents
Create Agent
Creates a new agent.
POST
/
agents
curl --request POST \
--url https://api.vogent.ai/api/agents \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"defaultVoiceId": "<string>",
"defaultVersionedPrompt": {
"aiModelId": "<string>",
"agentType": "STANDARD",
"prompt": "<string>",
"flowDefinition": {
"nodes": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"transitionRules": [
{
"conditionType": "always",
"arrayConditionType": "any",
"field": "<string>",
"value": "<string>",
"values": [
"<string>"
],
"transitionNodeId": "<string>"
}
],
"nodeData": {}
}
],
"globalContext": "<string>",
"aiOpen": true
},
"name": "<string>",
"modelOptionValues": [
{
"optionId": "<string>",
"value": "<string>"
}
]
},
"defaultExtractor": {
"name": "<string>",
"extractorFieldsJsonSchema": "<string>"
},
"inboundWebhookResponse": true,
"inboundWebhookUrl": "<string>",
"maxDurationSeconds": 10800,
"openingLine": {
"lineType": "INBOUND_ONLY",
"content": "<string>"
},
"voiceVolumeLevel": -100,
"backgroundNoiseType": "office",
"linkedFunctionDefinitionIds": [
"<string>"
],
"linkedFunctionDefinitionInputs": [
{
"functionDefinitionId": "<string>",
"lifecycleMessagesOverride": {
"started": [
"<string>"
]
}
}
],
"metadata": {},
"transcriberParams": {
"type": "deepgram",
"keywords": [
"<string>"
]
},
"idleMessageConfig": {
"enabled": true,
"messages": [
"<string>"
],
"idleDurationMilliseconds": 5001,
"maxIdleMessages": 2
},
"utteranceDetectorConfig": {
"sensitivity": "ULTRA_FAST"
},
"language": "en"
}'
{
"id": "<string>",
"name": "<string>",
"transcriberParams": {
"type": "deepgram",
"keywords": [
"<string>"
]
},
"metadata": {},
"utteranceDetectorConfig": {
"sensitivity": "ULTRA_FAST"
},
"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>"
]
}
}
]
}
Body
application/json
Create a new agent
The body is of type object
.
Response
200
application/json
Successful operation
The response is of type object
.
curl --request POST \
--url https://api.vogent.ai/api/agents \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"defaultVoiceId": "<string>",
"defaultVersionedPrompt": {
"aiModelId": "<string>",
"agentType": "STANDARD",
"prompt": "<string>",
"flowDefinition": {
"nodes": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"transitionRules": [
{
"conditionType": "always",
"arrayConditionType": "any",
"field": "<string>",
"value": "<string>",
"values": [
"<string>"
],
"transitionNodeId": "<string>"
}
],
"nodeData": {}
}
],
"globalContext": "<string>",
"aiOpen": true
},
"name": "<string>",
"modelOptionValues": [
{
"optionId": "<string>",
"value": "<string>"
}
]
},
"defaultExtractor": {
"name": "<string>",
"extractorFieldsJsonSchema": "<string>"
},
"inboundWebhookResponse": true,
"inboundWebhookUrl": "<string>",
"maxDurationSeconds": 10800,
"openingLine": {
"lineType": "INBOUND_ONLY",
"content": "<string>"
},
"voiceVolumeLevel": -100,
"backgroundNoiseType": "office",
"linkedFunctionDefinitionIds": [
"<string>"
],
"linkedFunctionDefinitionInputs": [
{
"functionDefinitionId": "<string>",
"lifecycleMessagesOverride": {
"started": [
"<string>"
]
}
}
],
"metadata": {},
"transcriberParams": {
"type": "deepgram",
"keywords": [
"<string>"
]
},
"idleMessageConfig": {
"enabled": true,
"messages": [
"<string>"
],
"idleDurationMilliseconds": 5001,
"maxIdleMessages": 2
},
"utteranceDetectorConfig": {
"sensitivity": "ULTRA_FAST"
},
"language": "en"
}'
{
"id": "<string>",
"name": "<string>",
"transcriberParams": {
"type": "deepgram",
"keywords": [
"<string>"
]
},
"metadata": {},
"utteranceDetectorConfig": {
"sensitivity": "ULTRA_FAST"
},
"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>"
]
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.