Voiceflow bearer token
Get workflow step
curl --request GET \
--url https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID> \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf workflow get-step --workflow-id <workflowID> --step-id <stepID> --project-id <projectID> --environment-alias <environmentAlias>{
"workflowID": "<string>",
"blockID": "<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>"
}
]
},
"portAction": {
"stepID": "<string>",
"port": "<string>",
"index": 0
}
}Reads a single step without fetching the whole workflow. An action ID from an exit’s actions reads the same way.
GET
/v1/stable/workflow/{workflowID}/step/{stepID}
Get workflow step
curl --request GET \
--url https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID> \
--header 'Authorization: Bearer <token>'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'GET',
headers: {
Authorization: 'Bearer <token>',
},
});
const data = await response.json();import requests
response = requests.get(
'https://realtime-api.voiceflow.com/v1/stable/workflow/<workflowID>/step/<stepID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
)
data = response.json()vf workflow get-step --workflow-id <workflowID> --step-id <stepID> --project-id <projectID> --environment-alias <environmentAlias>{
"workflowID": "<string>",
"blockID": "<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>"
}
]
},
"portAction": {
"stepID": "<string>",
"port": "<string>",
"index": 0
}
}Authorizations
Query Parameters
Response
200 - application/jsonReturns the step's kind, content, exit class and links, along with the block it is in.
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.
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
Was this page helpful?
Thanks for your feedback.