Voiceflow bearer token
Add workflow branch
curl --request POST \
--url https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>/branch \
--header 'Authorization: Bearer <token>'
--header 'Content-Type: application/json' \
--data '{
"label": "<string>",
"matchAll": true,
"assertions": [
{
"id": "<string>",
"lhs": {
"variableID": "<string>",
"path": "<string>"
},
"operation": "<ConditionOperation>",
"rhs": "<VariableReferenceString>"
}
],
"to": "<string>",
"kind": "condition"
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>/branch?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"label": "<string>",
"matchAll": true,
"assertions": [
{
"id": "<string>",
"lhs": {
"variableID": "<string>",
"path": "<string>"
},
"operation": "<ConditionOperation>",
"rhs": "<VariableReferenceString>"
}
],
"to": "<string>",
"kind": "condition"
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>/branch?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"label": "<string>",
"matchAll": True,
"assertions": [
{
"id": "<string>",
"lhs": {
"variableID": "<string>",
"path": "<string>"
},
"operation": "<ConditionOperation>",
"rhs": "<VariableReferenceString>"
}
],
"to": "<string>",
"kind": "condition"
},
)
data = response.json()vf workflow add-branch --workflow-id <workflowID> --step-id <stepID> --project-id <projectID> --environment-alias <environmentAlias> \
< body.json{
"message": "<string>",
"branchID": "<string>",
"step": {
"id": "<string>",
"kind": "message",
"exitClass": "sequential",
"content": {
"responseType": "message",
"messageID": "<string>",
"waitForUserResponse": true
},
"fallsThroughTo": "<string>",
"suppressedPorts": [
"<string>"
],
"links": [
{
"port": "<string>",
"label": "<string>",
"to": "<string>",
"actions": [
"<StableWorkflowPortAction>"
],
"overridden": true,
"effectiveTo": "<string>"
}
],
"reconciledPorts": {
"added": [
"<string>"
],
"removed": [
"<string>"
]
},
"warnings": [
{
"code": "<StableWorkflowDiagnosticCode>",
"detail": "<string>"
}
]
},
"unresolvedReferences": [
{
"path": "<string>",
"token": "<string>",
"reason": "unknown"
}
]
}Gives a Condition, Buttons, Card, Carousel, Code or Crew step one more way out. When you send `to`, the call also links the new branch to a block.
POST
/v1/stable/workflow/{workflowID}/step/{stepID}/branch
Add workflow branch
curl --request POST \
--url https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>/branch \
--header 'Authorization: Bearer <token>'
--header 'Content-Type: application/json' \
--data '{
"label": "<string>",
"matchAll": true,
"assertions": [
{
"id": "<string>",
"lhs": {
"variableID": "<string>",
"path": "<string>"
},
"operation": "<ConditionOperation>",
"rhs": "<VariableReferenceString>"
}
],
"to": "<string>",
"kind": "condition"
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>/branch?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"label": "<string>",
"matchAll": true,
"assertions": [
{
"id": "<string>",
"lhs": {
"variableID": "<string>",
"path": "<string>"
},
"operation": "<ConditionOperation>",
"rhs": "<VariableReferenceString>"
}
],
"to": "<string>",
"kind": "condition"
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>/branch?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"label": "<string>",
"matchAll": True,
"assertions": [
{
"id": "<string>",
"lhs": {
"variableID": "<string>",
"path": "<string>"
},
"operation": "<ConditionOperation>",
"rhs": "<VariableReferenceString>"
}
],
"to": "<string>",
"kind": "condition"
},
)
data = response.json()vf workflow add-branch --workflow-id <workflowID> --step-id <stepID> --project-id <projectID> --environment-alias <environmentAlias> \
< body.json{
"message": "<string>",
"branchID": "<string>",
"step": {
"id": "<string>",
"kind": "message",
"exitClass": "sequential",
"content": {
"responseType": "message",
"messageID": "<string>",
"waitForUserResponse": true
},
"fallsThroughTo": "<string>",
"suppressedPorts": [
"<string>"
],
"links": [
{
"port": "<string>",
"label": "<string>",
"to": "<string>",
"actions": [
"<StableWorkflowPortAction>"
],
"overridden": true,
"effectiveTo": "<string>"
}
],
"reconciledPorts": {
"added": [
"<string>"
],
"removed": [
"<string>"
]
},
"warnings": [
{
"code": "<StableWorkflowDiagnosticCode>",
"detail": "<string>"
}
]
},
"unresolvedReferences": [
{
"path": "<string>",
"token": "<string>",
"reason": "unknown"
}
]
}Authorizations
Query Parameters
Body
Show child attributes
Option 1 · StableWorkflowConditionBranchAdd
Show child attributes
Show child attributes
Plain text; markdown is not interpreted. {variable_name} inserts a variable or entity, {variable_name.path} a field of a variable. Escape a literal { or \ with a backslash. A name matching neither is stored as literal text and reported in unresolvedReferences; secrets are not available here.
Option 2 · StableWorkflowButtonsBranchAdd
Show child attributes
Plain text; markdown is not interpreted. {variable_name} inserts a variable or entity, {variable_name.path} a field of a variable. Escape a literal { or \ with a backslash. A name matching neither is stored as literal text and reported in unresolvedReferences; secrets are not available here.
VariableReferenceString — see its attributes above
Option 3 · StableWorkflowCardBranchAdd
Show child attributes
Plain text; markdown is not interpreted. {variable_name} inserts a variable or entity, {variable_name.path} a field of a variable. Escape a literal { or \ with a backslash. A name matching neither is stored as literal text and reported in unresolvedReferences; secrets are not available here.
VariableReferenceString — see its attributes above
Option 4 · StableWorkflowCarouselBranchAdd
Show child attributes
Plain text; markdown is not interpreted. {variable_name} inserts a variable or entity, {variable_name.path} a field of a variable. Escape a literal { or \ with a backslash. A name matching neither is stored as literal text and reported in unresolvedReferences; secrets are not available here.
VariableReferenceString — see its attributes above
Option 5 · StableWorkflowCodeBranchAdd
Option 6 · StableWorkflowCrewBranchAdd
Show child attributes
Response
201 - application/jsonReturns the new branch's ID, which is also its port key, and the step with the branch added.
Show child attributes
What the step does. api, function, integration and mcp are Tool steps. playbook and operator are Agent steps. goToBlock jumps to a block or a workflow start and ends the path. callForward transfers a phone call and ends the path. legacy is a step these operations show but cannot change.
Available options:
message, end, set, workflow, listen, condition, buttons, card, carousel, code, api, function, integration, mcp, playbook, operator, crew, handoff, legacy, goToBlock, callForwardHow the step leaves. sequential: it continues to the step below it, or through next when it is last. branch: it leaves through one of its links, so it must be last. async-branch: a Card or Carousel, whose linked buttons run from any position. terminal: it ends the path.
Available options:
sequential, branch, async-branch, terminalThe step's settings, shaped by its kind. A step these operations cannot show reads as readOnly.
Show child attributes
Option 1 · StableWorkflowStepMessageContent
Show child attributes
Option 1
object · 3 attributes:
responseType, messageID, waitForUserResponseOption 2
object · 3 attributes:
responseType, promptID, waitForUserResponseOption 2 · StableWorkflowStepEndContent
Show child attributes
Option 1
object · 3 attributes:
responseType, messageID, responseEnabledOption 2
object · 3 attributes:
responseType, promptID, responseEnabledOption 3 · StableWorkflowStepSetContent
Show child attributes
Option 4 · StableWorkflowStepWorkflowContent
Option 5 · StableWorkflowStepListenContent
Option 6 · StableWorkflowStepConditionContent
Option 7 · StableWorkflowStepButtonsContent
Option 8 · StableWorkflowStepCardContent
Show child attributes
Option 9 · StableWorkflowStepCarouselContent
Show child attributes
Option 10 · StableWorkflowStepCodeContent
Option 11 · StableWorkflowStepApiContent
Show child attributes
Option 12 · StableWorkflowStepFunctionContent
Show child attributes
Option 13 · StableWorkflowStepIntegrationContent
Show child attributes
Option 14 · StableWorkflowStepMcpContent
Show child attributes
Option 15 · StableWorkflowStepOperatorContent
Show child attributes
Option 16 · StableWorkflowStepPlaybookContent
Show child attributes
Option 17 · StableWorkflowStepCrewContent
Show child attributes
Option 18 · StableWorkflowStepHandoffContent
Show child attributes
Option 19 · StableWorkflowStepGoToBlockContent
Show child attributes
Option 20 · StableWorkflowStepCallForwardContent
Show child attributes
Plain text; markdown is not interpreted. {variable_name} inserts a variable or entity, {variable_name.path} a field of a variable. Escape a literal { or \ with a backslash. A name matching neither is stored as literal text and reported in unresolvedReferences; secrets are not available here.
VariableReferenceString — see its attributes above
Show child attributes
The port actions this exit runs, in order, before it reaches to.
Show child attributes
What the step does. api, function, integration and mcp are Tool steps. playbook and operator are Agent steps. goToBlock jumps to a block or a workflow start and ends the path. callForward transfers a phone call and ends the path. legacy is a step these operations show but cannot change.
Available options:
message, end, set, workflow, listen, condition, buttons, card, carousel, code, api, function, integration, mcp, playbook, operator, crew, handoff, legacy, goToBlock, callForwardStableWorkflowStepKind — see its attributes above
The step's settings, shaped by its kind. A step these operations cannot show reads as readOnly.
StableWorkflowStepContent — see its attributes above
StableWorkflowDiagnostic — see its attributes above
References this write kept as literal text instead of binding, each with the reason. The write still succeeded.
Show child attributes
unknown: no variable or entity of that name. secret-not-allowed: the name is a project secret and this field does not accept one. path-on-non-variable: only a variable has fields. resource-id: a bare resource id, not a name. invalid-name: outside the ^\w{1,64}$ name grammar. dangling: the reference rendered as a bare id, because its row is gone or its name is outside the name grammar.
Available options:
unknown, secret-not-allowed, path-on-non-variable, resource-id, invalid-name, danglingWas this page helpful?
Thanks for your feedback.