Create playbook
curl --request POST \
--url https://realtime-api.voiceflow.com/v1/stable/playbook \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"instructions": [
"<string>"
],
"endTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {}
},
"toolSound": {
"ref": "<string>",
"volume": 0.75
}
},
"cardTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {}
}
},
"buttonTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {}
}
},
"carouselTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {}
}
},
"skipTurnTool": {
"enabled": true,
"description": "<string>"
},
"webSearchTool": {
"enabled": true,
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {}
},
"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": {}
},
"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": {}
},
"toolSound": {
"ref": "<string>",
"volume": 0.75
},
"chunkLimit": 123,
"sourceUrlsCount": 3
},
"settings": {}
}
'{
"playbook": {
"id": "<string>",
"name": "<string>",
"settings": {
"realtime": {
"voice": "<string>",
"eagerness": "<string>"
},
"maxTokens": 123,
"temperature": 123
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"instructions": [
"<string>"
],
"pathToolOrder": [
"<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>"
]
]
}
}
}
},
"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>"
},
"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
}
}
}Adds a playbook to the environment, a set of instructions that drives an agent toward a goal, calling tools as it needs them. The response carries the ID that later calls address it by.
POST
/
v1
/
stable
/
playbook
Create playbook
curl --request POST \
--url https://realtime-api.voiceflow.com/v1/stable/playbook \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"instructions": [
"<string>"
],
"endTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {}
},
"toolSound": {
"ref": "<string>",
"volume": 0.75
}
},
"cardTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {}
}
},
"buttonTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {}
}
},
"carouselTool": {
"enabled": true,
"description": "<string>",
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {}
}
},
"skipTurnTool": {
"enabled": true,
"description": "<string>"
},
"webSearchTool": {
"enabled": true,
"messages": {
"delayMessageID": "<string>",
"failureMessageID": "<string>",
"executionMessageID": "<string>",
"completionMessageID": "<string>",
"delayMessageSeconds": 123,
"generative": {}
},
"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": {}
},
"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": {}
},
"toolSound": {
"ref": "<string>",
"volume": 0.75
},
"chunkLimit": 123,
"sourceUrlsCount": 3
},
"settings": {}
}
'{
"playbook": {
"id": "<string>",
"name": "<string>",
"settings": {
"realtime": {
"voice": "<string>",
"eagerness": "<string>"
},
"maxTokens": 123,
"temperature": 123
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"instructions": [
"<string>"
],
"pathToolOrder": [
"<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>"
]
]
}
}
}
},
"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>"
},
"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
}
}
}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).
Body
application/json
A human-readable description of what the playbook does.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
201 - application/json
Returns the newly created playbook in full, including the ID assigned to it and the instructions it was created with.
Show child attributes
Show child attributes
Was this page helpful?
⌘I