Client SDKWorkflows

Execute Workflow Async

GA
Executes a deployed Workflow asynchronously and returns the execution ID.

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.
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.
previous_execution_idstring or nullOptionalformat: "uuid"
The ID of a previous Workflow Execution to reference for initial State loading.
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.

Response

execution_idstring
The ID of the workflow execution.

Errors