Workflows

Execute Workflow as Stream

GA
POST
Executes a deployed Workflow and streams back its results.

Request

This endpoint expects an object.
inputs
list of unionsRequired
The list of inputs defined in the Workflow's Deployment with their corresponding values.
expand_meta
objectOptional

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_id
stringOptional

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

workflow_deployment_name
stringOptional

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

release_tag
stringOptional
Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
external_id
stringOptional
Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.
event_types
list 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.
Allowed values: NODEWORKFLOW

Response

This endpoint returns a stream of union
Workflow
OR
Node
Built with