Endpoint
GET
/v1/stable/playbook-path

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

playbookID
string
required

The ID of the playbook the exit path belongs to.

Response

200 - application/json

Returns the exit paths of the playbook, each with its ID, name, exit condition and timestamps.

paths
object[]
required
StablePlaybookPath — see its attributes above
Endpoint
POST
/v1/stable/playbook-path

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Request body

playbookID
string
required

The ID of the playbook to add the exit path to.

name
string
required

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.

Minimum length: 1 · Maximum length: 255
description
string

The exit condition: the model reads it to decide when to leave the playbook through this path.

requiredVariables
object[]

The variables or entities the model must fill before it can leave through this path, in order.

StableRequiredVariableInput — see its attributes above
messages
object

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

201 - application/json

Returns the created exit path, including the ID assigned to it.

path
object
required
StablePlaybookPath — see its attributes above
unresolvedReferences
object[]

References this write kept as literal text instead of binding, each with the reason. The write still succeeded.

StableUnresolvedReference — see its attributes above
Endpoint
PATCH
/v1/stable/playbook-path/{pathID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

pathID
string
required

The ID of the exit path to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

playbookID
string
required

The ID of the playbook the exit path belongs to.

Request body

name
string

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.

Minimum length: 1 · Maximum length: 255
description
string

The exit condition: the model reads it to decide when to leave the playbook through this path.

requiredVariables
object[]

Replaces the stored list, in order. Leave it out to keep it; send [] to remove every one.

StableRequiredVariableInput — see its attributes above
messages
object

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

200 - application/json

Returns the updated exit path.

path
object
required
StablePlaybookPath — see its attributes above
unresolvedReferences
object[]

References this write kept as literal text instead of binding, each with the reason. The write still succeeded.

StableUnresolvedReference — see its attributes above
Endpoint
DELETE
/v1/stable/playbook-path/{pathID}

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.

Request
Response

Authentication

Authorization
string
header
required

Voiceflow bearer token

Path parameters

pathID
string
required

The ID of the exit path to operate on.

Query parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

playbookID
string
required

The ID of the playbook the exit path belongs to.

Response

200 - application/json

Confirms the exit path was deleted.

message
string
required

A human-readable message confirming the deletion.

Schemas

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.