Voiceflow bearer token
Playbook Paths
Define the outcomes a playbook can return.
See Authentication for credentials and permissions.
Returns every exit path of one playbook in one response. An exit path is a named way out of a playbook that the model takes when its exit condition holds, and workflows use its ID to link the path's port.
Authentication
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
The ID of the playbook the exit path belongs to.
Response
Returns the exit paths of the playbook, each with its ID, name, exit condition and timestamps.
Adds an exit path to a playbook; the model leaves the playbook through it when the path's description holds. Exit paths take effect when the playbook runs from a Playbook or Operator step in a workflow, where the new path appears as a port with no link.
Authentication
Voiceflow bearer token
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The ID of the playbook to add the exit path to.
The name of the exit path, trimmed. Use Latin letters, digits, spaces, hyphens and underscores, as the editor does: the runtime turns the name into the snake_case name of the exit tool the model calls.
The exit condition: the model reads it to decide when to leave the playbook through this path.
The variables or entities the model must fill before it can leave through this path, in order.
What the agent says as it leaves through this path. Send only a message ID that nothing else uses: no other step in any workflow, no reprompt, no agent and no playbook. For the same words in a second place, create a new message with that text.
Response
Returns the created exit path, including the ID assigned to it.
References this write kept as literal text instead of binding, each with the reason. The write still succeeded.
Changes the name, the exit condition, or both on an exit path. Workflow ports follow the path by ID, so links made on it stay in place.
Authentication
Voiceflow bearer token
Path parameters
The ID of the exit path to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
The ID of the playbook the exit path belongs to.
Request body
The name of the exit path, trimmed. Use Latin letters, digits, spaces, hyphens and underscores, as the editor does: the runtime turns the name into the snake_case name of the exit tool the model calls.
The exit condition: the model reads it to decide when to leave the playbook through this path.
Replaces the stored list, in order. Leave it out to keep it; send [] to remove every one.
Replaces the stored messages whole. Send null to remove them; leave it out to keep them. Send only a message ID that nothing else uses: no other step in any workflow, no reprompt, no agent and no playbook. For the same words in a second place, create a new message with that text.
Response
Returns the updated exit path.
References this write kept as literal text instead of binding, each with the reason. The write still succeeded.
Deletes one exit path from a playbook, together with its required variables. The response carries only a confirmation message, so refetch the playbook's paths to see what is left.
Authentication
Voiceflow bearer token
Path parameters
The ID of the exit path to operate on.
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
The ID of the playbook the exit path belongs to.
Response
Confirms the exit path was deleted.
A human-readable message confirming the deletion.