Workflows

Execute Workflow

GA
POST
Executes a deployed Workflow and returns its outputs.

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.

Response

This endpoint returns an object
execution_id
string
data
union
run_id
stringOptional
external_id
stringOptional
Built with