Client SDKWorkflows

Execute Workflow as Stream

GA
Executes a deployed Workflow and streams back its results.

Authentication

X-API-KEYstring
API Key authentication via header

Headers

X-API-VersionstringOptional

Request

This endpoint expects an object.
inputslist of objectsRequired
The list of inputs defined in the Workflow's Deployment with their corresponding values.
expand_metaobject or nullOptional

An optionally specified configuration used to opt in to including additional metadata about this workflow execution in the API response. Corresponding values will be returned under the execution_meta key within NODE events in the response stream.

workflow_deployment_idstring or nullOptionalformat: "uuid"

The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name.

workflow_deployment_namestring or nullOptional>=1 character

The name of the Workflow Deployment. Must provide either this or workflow_deployment_id.

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.
event_typeslist of enumsOptional

Optionally specify which events you want to receive. Defaults to only WORKFLOW events. Note that the schema of non-WORKFLOW events is unstable and should be used with caution.

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 initial State loading.

Response

WORKFLOWobject
OR
NODEobject

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error