Voiceflow bearer token
List playbooks
curl --request GET \
--url https://realtime-api.voiceflow.com/v1/stable/playbook \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/playbook?projectID=<projectID>&environmentAlias=<environmentAlias>&includeInstructions=<includeInstructions>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/playbook?projectID=<projectID>&environmentAlias=<environmentAlias>&includeInstructions=<includeInstructions>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf playbook list --project-id <projectID> --environment-alias <environmentAlias> --include-instructions <includeInstructions>{
"playbooks": [
{
"id": "<string>",
"name": "<string>",
"settings": {
"model": "<AIModel>",
"realtime": {
"voice": "<string>",
"eagerness": "<string>"
},
"maxTokens": 0,
"temperature": 0,
"reasoningEffort": "<AIReasoningEffort>"
},
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"description": "<string>",
"instructions": "<string>",
"pathToolOrder": [
"<string>"
],
"endTool": "<AgentEndTool>",
"cardTool": "<AgentCardTool>",
"buttonTool": "<AgentButtonTool>",
"carouselTool": "<AgentCardTool>",
"skipTurnTool": "<AgentSkipTurnTool>",
"webSearchTool": "<AgentWebSearchTool>",
"callForwardTool": "<AgentCallForwardTool>",
"knowledgeBaseTool": "<AgentKnowledgeBaseTool>",
"instructionsLineCount": 0
}
]
}Returns every playbook in the environment. A playbook is a set of instructions that drives an agent toward a goal, calling tools as it needs them. The call takes no paging parameters, so one request yields the whole set.
GET
/v1/stable/playbook
List playbooks
curl --request GET \
--url https://realtime-api.voiceflow.com/v1/stable/playbook \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/playbook?projectID=<projectID>&environmentAlias=<environmentAlias>&includeInstructions=<includeInstructions>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/playbook?projectID=<projectID>&environmentAlias=<environmentAlias>&includeInstructions=<includeInstructions>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf playbook list --project-id <projectID> --environment-alias <environmentAlias> --include-instructions <includeInstructions>{
"playbooks": [
{
"id": "<string>",
"name": "<string>",
"settings": {
"model": "<AIModel>",
"realtime": {
"voice": "<string>",
"eagerness": "<string>"
},
"maxTokens": 0,
"temperature": 0,
"reasoningEffort": "<AIReasoningEffort>"
},
"createdAt": "2026-09-10T00:00:00.000Z",
"updatedAt": "2026-09-10T00:00:00.000Z",
"description": "<string>",
"instructions": "<string>",
"pathToolOrder": [
"<string>"
],
"endTool": "<AgentEndTool>",
"cardTool": "<AgentCardTool>",
"buttonTool": "<AgentButtonTool>",
"carouselTool": "<AgentCardTool>",
"skipTurnTool": "<AgentSkipTurnTool>",
"webSearchTool": "<AgentWebSearchTool>",
"callForwardTool": "<AgentCallForwardTool>",
"knowledgeBaseTool": "<AgentKnowledgeBaseTool>",
"instructionsLineCount": 0
}
]
}Authorizations
Query Parameters
Response
200 - application/jsonReturns every playbook in the project environment, each with its name, description, instructions, model settings, and its own system tool configuration.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Option 1
string
Option 2 · MarkupSpan
Show child attributes
Option 3 · MarkupToolReference
Show child attributes
Was this page helpful?
Thanks for your feedback.