Client SDKworkflow-deployments

Execute Stream

Beta
Executes a deployed Workflow and streams back its results.

Authentication

X-API-KEYstring
API Key authentication via header

Path parameters

idstringRequired
Either the Workflow Deployment's ID or its unique name

Headers

X-API-VersionstringOptional

Request

This endpoint expects an object.
inputsmap from strings to anyOptional
A mapping from input name to value.
triggerstring or nullOptional>=1 character
The name or ID of a workflow trigger to use for this execution. If not specified, then a default manual trigger will be chosen.
release_tagstring or nullOptional>=1 character
Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
external_idstring or nullOptional>=1 character
Optionally include a unique identifier for tracking purposes. Must be unique within a given Workspace.
metadatamap from strings to any or nullOptional
Arbitrary JSON metadata associated with this request. Can be used to capture additional monitoring data such as user id, session id, etc. for future analysis.
previous_execution_idstring or nullOptionalformat: "uuid"
The ID of a previous workflow execution to reference for context.

Response

node.execution.initiatedobject
OR
node.execution.streamingobject
OR
node.execution.fulfilledobject
OR
node.execution.rejectedobject
OR
node.execution.pausedobject
OR
node.execution.resumedobject
OR
node.execution.logobject
OR
workflow.execution.initiatedobject
OR
workflow.execution.streamingobject
OR
workflow.execution.rejectedobject
OR
workflow.execution.fulfilledobject
OR
workflow.execution.pausedobject
OR
workflow.execution.resumedobject
OR
workflow.execution.snapshottedobject

Errors