Client SDKWorkflows

Execute Workflow

Executes a deployed Workflow and returns its outputs.

Headers

X-API-KEYstringRequired

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_idstringOptionalformat: "uuid"

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 within a given Workspace.

metadataobjectOptional

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

execution_idstring
dataobject
external_idstringOptional
run_idstringOptionalDeprecated

Errors