Voiceflow bearer token
Get agent
curl --request GET \
--url https://realtime-api.voiceflow.com/v1/stable/agent \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/agent?projectID=<projectID>&environmentAlias=<environmentAlias>&includeInstructions=<includeInstructions>&includePrompt=<includePrompt>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/agent?projectID=<projectID>&environmentAlias=<environmentAlias>&includeInstructions=<includeInstructions>&includePrompt=<includePrompt>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf agent get --project-id <projectID> --environment-alias <environmentAlias> --include-instructions <includeInstructions> --include-prompt <includePrompt>{
"agent": {
"llm": {
"priorityProcessing": true,
"defaults": {
"model": "<AIModel>",
"maxTokens": 0,
"temperature": 0,
"reasoningEffort": "<AIReasoningEffort>"
}
},
"prompt": "<string>",
"includeGuidelines": true,
"voice": {
"stt": "<STTSettings>",
"tts": "<VoiceSettings>",
"pronunciationDictionary": [
"<PronunciationDictionaryEntry>"
],
"failureMessage": "<string>",
"hasCallRecording": true,
"audioCue": 0,
"backgroundAudio": "<string>",
"backgroundAudioSettings": "<BackgroundAudioSettings>",
"audioSync": true,
"keypadInput": "<VoiceKeypadSettings>",
"silenceTimeoutMs": 0,
"maxDuration": "<VoiceMaxDurationSettings>"
},
"playbooks": [
{
"condition": "<ExpressionCondition>",
"description": "<string>",
"requiredVariables": [
"<CrewNodeDataRequiredVariable>"
],
"playbookID": "<string>"
}
],
"workflows": [
{
"condition": "<ExpressionCondition>",
"description": "<string>",
"requiredVariables": [
"<CrewNodeDataRequiredVariable>"
],
"workflowID": "<string>"
}
],
"endTool": {
"enabled": true,
"messages": null,
"toolSound": null,
"description": "<string>"
},
"cardTool": {
"enabled": true,
"messages": null,
"description": "<string>"
},
"buttonTool": {
"enabled": true,
"messages": null,
"description": "<string>"
},
"instructions": "<string>",
"carouselTool": {
"enabled": true,
"messages": null,
"description": "<string>"
},
"skipTurnTool": {
"enabled": true,
"description": "<string>"
},
"pathToolOrder": [
"<string>"
],
"webSearchTool": {
"enabled": true,
"messages": null,
"toolSound": null,
"description": "<string>",
"allowedDomains": [
"<string>"
],
"sourceUrlsCount": 0
},
"callForwardTool": {
"enabled": true,
"address": "<Markup>",
"messages": null,
"extension": "<Markup>",
"toolSound": null,
"description": "<string>",
"addressType": "<CallForwardAddressType>",
"callerIDPassthrough": true
},
"knowledgeBaseTool": {
"query": "<Markup>",
"enabled": true,
"filters": [
"<AgentKnowledgeBaseMetadataKeyFilter>"
],
"messages": null,
"toolSound": null,
"chunkLimit": 0,
"description": "<string>",
"queryMode": "<AgentKnowledgeBaseToolQueryMode>",
"sourceUrlsCount": 0
},
"promptLineCount": 0,
"instructionsLineCount": 0
}
}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>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/agent?projectID=<projectID>&environmentAlias=<environmentAlias>&includeInstructions=<includeInstructions>&includePrompt=<includePrompt>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/agent?projectID=<projectID>&environmentAlias=<environmentAlias>&includeInstructions=<includeInstructions>&includePrompt=<includePrompt>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf agent get --project-id <projectID> --environment-alias <environmentAlias> --include-instructions <includeInstructions> --include-prompt <includePrompt>{
"agent": {
"llm": {
"priorityProcessing": true,
"defaults": {
"model": "<AIModel>",
"maxTokens": 0,
"temperature": 0,
"reasoningEffort": "<AIReasoningEffort>"
}
},
"prompt": "<string>",
"includeGuidelines": true,
"voice": {
"stt": "<STTSettings>",
"tts": "<VoiceSettings>",
"pronunciationDictionary": [
"<PronunciationDictionaryEntry>"
],
"failureMessage": "<string>",
"hasCallRecording": true,
"audioCue": 0,
"backgroundAudio": "<string>",
"backgroundAudioSettings": "<BackgroundAudioSettings>",
"audioSync": true,
"keypadInput": "<VoiceKeypadSettings>",
"silenceTimeoutMs": 0,
"maxDuration": "<VoiceMaxDurationSettings>"
},
"playbooks": [
{
"condition": "<ExpressionCondition>",
"description": "<string>",
"requiredVariables": [
"<CrewNodeDataRequiredVariable>"
],
"playbookID": "<string>"
}
],
"workflows": [
{
"condition": "<ExpressionCondition>",
"description": "<string>",
"requiredVariables": [
"<CrewNodeDataRequiredVariable>"
],
"workflowID": "<string>"
}
],
"endTool": {
"enabled": true,
"messages": null,
"toolSound": null,
"description": "<string>"
},
"cardTool": {
"enabled": true,
"messages": null,
"description": "<string>"
},
"buttonTool": {
"enabled": true,
"messages": null,
"description": "<string>"
},
"instructions": "<string>",
"carouselTool": {
"enabled": true,
"messages": null,
"description": "<string>"
},
"skipTurnTool": {
"enabled": true,
"description": "<string>"
},
"pathToolOrder": [
"<string>"
],
"webSearchTool": {
"enabled": true,
"messages": null,
"toolSound": null,
"description": "<string>",
"allowedDomains": [
"<string>"
],
"sourceUrlsCount": 0
},
"callForwardTool": {
"enabled": true,
"address": "<Markup>",
"messages": null,
"extension": "<Markup>",
"toolSound": null,
"description": "<string>",
"addressType": "<CallForwardAddressType>",
"callerIDPassthrough": true
},
"knowledgeBaseTool": {
"query": "<Markup>",
"enabled": true,
"filters": [
"<AgentKnowledgeBaseMetadataKeyFilter>"
],
"messages": null,
"toolSound": null,
"chunkLimit": 0,
"description": "<string>",
"queryMode": "<AgentKnowledgeBaseToolQueryMode>",
"sourceUrlsCount": 0
},
"promptLineCount": 0,
"instructionsLineCount": 0
}
}Authorizations
Query Parameters
Response
200 - application/jsonReturns 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
Playbooks available for the agent to invoke. This list REPLACES the registry: send the complete list you want, or omit the field to leave routing untouched. An agent with no playbooks AND no workflows registered cannot run - the runtime fails the conversation - so never send an empty list unless workflows still holds at least one.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Option 1
string
Option 2 · MarkupSpan
Show child attributes
Option 3 · MarkupToolReference
Workflows available for the agent to invoke. This list REPLACES the registry: send the complete list you want, or omit the field to leave routing untouched. An agent with no workflows AND no playbooks registered cannot run, so never send an empty list unless playbooks still holds at least one.
Show child attributes
Show child attributes
ConditionAssertion — see its attributes above
CrewNodeDataRequiredVariable — see its attributes above
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Markup — see its attributes above
Show child attributes
Was this page helpful?
Thanks for your feedback.