Get agent
curl --request GET \
--url https://realtime-api.voiceflow.com/v1/stable/agent \
--header 'Authorization: Bearer <token>'{
"agent": {
"llm": {
"priorityProcessing": true,
"defaults": {
"maxTokens": 123,
"temperature": 123
}
},
"prompt": [
"<string>"
],
"includeGuidelines": true,
"playbooks": [
{
"description": "<string>",
"playbookID": "<string>",
"condition": {
"type": "value-variable",
"matchAll": true,
"assertions": [
{
"key": "<string>",
"lhs": {
"variableID": "<string>",
"path": "<string>"
},
"rhs": [
"<string>"
],
"operation": "is"
}
]
},
"requiredVariables": [
{
"id": "<string>",
"description": "<string>",
"variableOrEntityID": "<string>"
}
]
}
],
"workflows": [
{
"description": "<string>",
"workflowID": "<string>",
"condition": {
"type": "value-variable",
"matchAll": true,
"assertions": [
{
"key": "<string>",
"lhs": {
"variableID": "<string>",
"path": "<string>"
},
"rhs": [
"<string>"
],
"operation": "is"
}
]
},
"requiredVariables": [
{
"id": "<string>",
"description": "<string>",
"variableOrEntityID": "<string>"
}
]
}
],
"endTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {
"execution": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"failure": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"delay": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"completion": {
"enabled": true,
"examples": [
[
"<string>"
]
]
}
}
},
"toolSound": {
"ref": "<string>",
"volume": 0.75
}
},
"cardTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {
"execution": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"failure": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"delay": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"completion": {
"enabled": true,
"examples": [
[
"<string>"
]
]
}
}
}
},
"buttonTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {
"execution": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"failure": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"delay": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"completion": {
"enabled": true,
"examples": [
[
"<string>"
]
]
}
}
}
},
"instructions": [
"<string>"
],
"carouselTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {
"execution": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"failure": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"delay": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"completion": {
"enabled": true,
"examples": [
[
"<string>"
]
]
}
}
}
},
"skipTurnTool": {
"enabled": true,
"description": "<string>"
},
"pathToolOrder": [
"<string>"
],
"webSearchTool": {
"enabled": true,
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {
"execution": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"failure": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"delay": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"completion": {
"enabled": true,
"examples": [
[
"<string>"
]
]
}
}
},
"toolSound": {
"ref": "<string>",
"volume": 0.75
},
"description": "<string>",
"allowedDomains": [
"<string>"
],
"sourceUrlsCount": 3
},
"callForwardTool": {
"enabled": true,
"address": [
"<string>"
],
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {
"execution": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"failure": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"delay": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"completion": {
"enabled": true,
"examples": [
[
"<string>"
]
]
}
}
},
"extension": [
"<string>"
],
"toolSound": {
"ref": "<string>",
"volume": 0.75
},
"callerIDPassthrough": true
},
"knowledgeBaseTool": {
"enabled": true,
"description": "<string>",
"query": [
"<string>"
],
"filters": [
{
"key": "<string>",
"description": null,
"defaultValue": [
"<string>"
]
}
],
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {
"execution": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"failure": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"delay": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"completion": {
"enabled": true,
"examples": [
[
"<string>"
]
]
}
}
},
"toolSound": {
"ref": "<string>",
"volume": 0.75
},
"chunkLimit": 123,
"sourceUrlsCount": 3
},
"voice": {
"stt": {
"provider": "elevenlabs",
"model": "scribe_v2_realtime",
"vadSilenceThresholdSecs": 1.65,
"vadThreshold": 0.5,
"minSpeechDurationMS": 1025,
"minSilenceDurationMS": 1025
},
"tts": {
"provider": "amazon",
"voice": "<string>"
},
"pronunciationDictionary": [
{
"from": "<string>",
"to": "<string>"
}
],
"failureMessage": "<string>",
"hasCallRecording": true,
"audioCue": 123,
"backgroundAudio": "<string>",
"backgroundAudioSettings": {
"volume": 0.75
},
"audioSync": true,
"keypadInput": {
"enabled": true,
"delimiter": [],
"timeoutInSeconds": 123
},
"silenceTimeoutMs": 123,
"maxDuration": {
"enabled": true,
"seconds": 123,
"message": "<string>"
}
}
}
}Returns the environment’s agent: the global prompt, the instructions that route a turn, and the settings wrapping both.
GET
/
v1
/
stable
/
agent
Get agent
curl --request GET \
--url https://realtime-api.voiceflow.com/v1/stable/agent \
--header 'Authorization: Bearer <token>'{
"agent": {
"llm": {
"priorityProcessing": true,
"defaults": {
"maxTokens": 123,
"temperature": 123
}
},
"prompt": [
"<string>"
],
"includeGuidelines": true,
"playbooks": [
{
"description": "<string>",
"playbookID": "<string>",
"condition": {
"type": "value-variable",
"matchAll": true,
"assertions": [
{
"key": "<string>",
"lhs": {
"variableID": "<string>",
"path": "<string>"
},
"rhs": [
"<string>"
],
"operation": "is"
}
]
},
"requiredVariables": [
{
"id": "<string>",
"description": "<string>",
"variableOrEntityID": "<string>"
}
]
}
],
"workflows": [
{
"description": "<string>",
"workflowID": "<string>",
"condition": {
"type": "value-variable",
"matchAll": true,
"assertions": [
{
"key": "<string>",
"lhs": {
"variableID": "<string>",
"path": "<string>"
},
"rhs": [
"<string>"
],
"operation": "is"
}
]
},
"requiredVariables": [
{
"id": "<string>",
"description": "<string>",
"variableOrEntityID": "<string>"
}
]
}
],
"endTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {
"execution": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"failure": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"delay": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"completion": {
"enabled": true,
"examples": [
[
"<string>"
]
]
}
}
},
"toolSound": {
"ref": "<string>",
"volume": 0.75
}
},
"cardTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {
"execution": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"failure": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"delay": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"completion": {
"enabled": true,
"examples": [
[
"<string>"
]
]
}
}
}
},
"buttonTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {
"execution": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"failure": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"delay": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"completion": {
"enabled": true,
"examples": [
[
"<string>"
]
]
}
}
}
},
"instructions": [
"<string>"
],
"carouselTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {
"execution": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"failure": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"delay": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"completion": {
"enabled": true,
"examples": [
[
"<string>"
]
]
}
}
}
},
"skipTurnTool": {
"enabled": true,
"description": "<string>"
},
"pathToolOrder": [
"<string>"
],
"webSearchTool": {
"enabled": true,
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {
"execution": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"failure": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"delay": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"completion": {
"enabled": true,
"examples": [
[
"<string>"
]
]
}
}
},
"toolSound": {
"ref": "<string>",
"volume": 0.75
},
"description": "<string>",
"allowedDomains": [
"<string>"
],
"sourceUrlsCount": 3
},
"callForwardTool": {
"enabled": true,
"address": [
"<string>"
],
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {
"execution": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"failure": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"delay": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"completion": {
"enabled": true,
"examples": [
[
"<string>"
]
]
}
}
},
"extension": [
"<string>"
],
"toolSound": {
"ref": "<string>",
"volume": 0.75
},
"callerIDPassthrough": true
},
"knowledgeBaseTool": {
"enabled": true,
"description": "<string>",
"query": [
"<string>"
],
"filters": [
{
"key": "<string>",
"description": null,
"defaultValue": [
"<string>"
]
}
],
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {
"execution": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"failure": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"delay": {
"enabled": true,
"examples": [
[
"<string>"
]
]
},
"completion": {
"enabled": true,
"examples": [
[
"<string>"
]
]
}
}
},
"toolSound": {
"ref": "<string>",
"volume": 0.75
},
"chunkLimit": 123,
"sourceUrlsCount": 3
},
"voice": {
"stt": {
"provider": "elevenlabs",
"model": "scribe_v2_realtime",
"vadSilenceThresholdSecs": 1.65,
"vadThreshold": 0.5,
"minSpeechDurationMS": 1025,
"minSilenceDurationMS": 1025
},
"tts": {
"provider": "amazon",
"voice": "<string>"
},
"pronunciationDictionary": [
{
"from": "<string>",
"to": "<string>"
}
],
"failureMessage": "<string>",
"hasCallRecording": true,
"audioCue": 123,
"backgroundAudio": "<string>",
"backgroundAudioSettings": {
"volume": 0.75
},
"audioSync": true,
"keypadInput": {
"enabled": true,
"delimiter": [],
"timeoutInSeconds": 123
},
"silenceTimeoutMs": 123,
"maxDuration": {
"enabled": true,
"seconds": 123,
"message": "<string>"
}
}
}
}Authorizations
Voiceflow bearer token
Query Parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Response
200 - application/json
Returns the agent's whole configuration: its model settings, prompt, instructions, the playbooks and workflows attached to it, and its system tool setup. The voice section is optional and may be absent.
Show child attributes
Show child attributes
Was this page helpful?
⌘I