Voiceflow bearer token
Add port actions
curl --request POST \
--url https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>/link/<portKey>/actions \
--header 'Authorization: Bearer <token>'
--header 'Content-Type: application/json' \
--data '{
"actions": [
{
"kind": "goToBlock",
"content": "<StableWorkflowStepGoToBlockContentInput>"
}
],
"afterActionID": "<string>",
"atStart": true,
"expectedActions": [
"<string>"
],
"to": "<string>"
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>/link/<portKey>/actions?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"actions": [
{
"kind": "goToBlock",
"content": "<StableWorkflowStepGoToBlockContentInput>"
}
],
"afterActionID": "<string>",
"atStart": true,
"expectedActions": [
"<string>"
],
"to": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>/link/<portKey>/actions?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"actions": [
{
"kind": "goToBlock",
"content": "<StableWorkflowStepGoToBlockContentInput>"
}
],
"afterActionID": "<string>",
"atStart": True,
"expectedActions": [
"<string>"
],
"to": "<string>"
},
)
data = response.json()vf workflow add-actions --workflow-id <workflowID> --step-id <stepID> --port-key <portKey> --project-id <projectID> --environment-alias <environmentAlias> \
< body.json{
"message": "<string>",
"stepID": "<string>",
"port": "<string>",
"link": {
"port": "<string>",
"label": "<string>",
"to": "<string>",
"actions": [
{
"id": "<string>",
"kind": "<StableWorkflowStepKind>",
"content": "<StableWorkflowStepContent>",
"warnings": [
"<StableWorkflowDiagnostic>"
]
}
],
"overridden": true,
"effectiveTo": "<string>"
},
"clearedTo": "<string>",
"unresolvedReferences": [
{
"path": "<string>",
"token": "<string>",
"reason": "unknown"
}
]
}Adds port actions to one exit of a step. They run in order when the conversation leaves through that exit, before the path reaches the next block. Add 1 to 10 at a time, and send the exit’s current action IDs as `expectedActions`.
POST
/v1/stable/workflow/{workflowID}/step/{stepID}/link/{portKey}/actions
Add port actions
curl --request POST \
--url https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>/link/<portKey>/actions \
--header 'Authorization: Bearer <token>'
--header 'Content-Type: application/json' \
--data '{
"actions": [
{
"kind": "goToBlock",
"content": "<StableWorkflowStepGoToBlockContentInput>"
}
],
"afterActionID": "<string>",
"atStart": true,
"expectedActions": [
"<string>"
],
"to": "<string>"
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>/link/<portKey>/actions?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"actions": [
{
"kind": "goToBlock",
"content": "<StableWorkflowStepGoToBlockContentInput>"
}
],
"afterActionID": "<string>",
"atStart": true,
"expectedActions": [
"<string>"
],
"to": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>/link/<portKey>/actions?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"actions": [
{
"kind": "goToBlock",
"content": "<StableWorkflowStepGoToBlockContentInput>"
}
],
"afterActionID": "<string>",
"atStart": True,
"expectedActions": [
"<string>"
],
"to": "<string>"
},
)
data = response.json()vf workflow add-actions --workflow-id <workflowID> --step-id <stepID> --port-key <portKey> --project-id <projectID> --environment-alias <environmentAlias> \
< body.json{
"message": "<string>",
"stepID": "<string>",
"port": "<string>",
"link": {
"port": "<string>",
"label": "<string>",
"to": "<string>",
"actions": [
{
"id": "<string>",
"kind": "<StableWorkflowStepKind>",
"content": "<StableWorkflowStepContent>",
"warnings": [
"<StableWorkflowDiagnostic>"
]
}
],
"overridden": true,
"effectiveTo": "<string>"
},
"clearedTo": "<string>",
"unresolvedReferences": [
{
"path": "<string>",
"token": "<string>",
"reason": "unknown"
}
]
}Authorizations
Query Parameters
Body
1 to 10 actions to add, in run order.
Show child attributes
Option 1
Show child attributes
Option 2
Show child attributes
Show child attributes
Option 3
Show child attributes
Show child attributes
Option 4
Show child attributes
Show child attributes
Option 5
Show child attributes
Option 6
Show child attributes
Option 7
Show child attributes
Show child attributes
Option 8
Option 9
Show child attributes
Call forward works only in a phone project. In a chat project, do not add it as a step or an action: tell the user it needs a phone project.
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 10
Show child attributes
Show child attributes
Option 11
Show child attributes
Show child attributes
Response
201 - application/jsonReturns what was written, the exit's step and port, and its link. If the last action ends the path, clearedTo names the block the exit led to before.
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, callForwardThe 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
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.