Execute Workflow as Stream

GA
POST

Executes a deployed Workflow and streams back its results.

Request

This endpoint expects an object.
inputslist of objectsRequired

The list of inputs defined in the Workflow’s Deployment with their corresponding values.

expand_metaobjectOptional

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_idstringOptional

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

workflow_deployment_namestringOptional=1 character

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

release_tagstringOptional=1 character

Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment

external_idstringOptional=1 character

Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.

event_typeslist of "NODE" or "WORKFLOW"Optional
Allowed values: NODEWORKFLOW

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 anyOptional

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.

Response

This endpoint returns a stream of object.
Workflow

A WORKFLOW-level event emitted from the workflow’s execution.

OR
Node

A NODE-level event emitted from the workflow’s execution.

Built with