Workflows

Trigger workflow execution

Start an asynchronous workflow execution through api-service. This route forwards to workflows-engine and requires callers to pin the workflow version in the path.

The immediate response only confirms the workflow was queued. Downstream workflow lifecycle statuses are running, completed, failed, and cancelled. To queue several executions of the same version in one call, use the bulk trigger route.

post/v1/workflows/trigger/{workflowID}/{versionID}

Request

  • Base URL: https://api.eachlabs.ai
  • URL: https://api.eachlabs.ai/v1/workflows/trigger/{workflowID}/{versionID}
  • Auth: HTTP bearer

Path parameters

workflowIDstring required

Workflow ID or slug to execute.

versionIDstring required

Workflow version ID to execute.

Query parameters

webhook_urlstring uri

Optional compatibility query parameter for execution completion webhooks. The request body field takes precedence when both are present.

Request body

inputsobject

Input values defined by the workflow version. May be omitted for workflows with no inputs.

webhook_urlstring uri

Optional webhook URL for workflow execution completion.

webhook_secretstring

Optional secret used to sign workflow webhook requests.

Example request

{
  "inputs": {
    "prompt": "A cinematic establishing shot of a mountain lake"
  },
  "webhook_url": "https://your-app.com/webhook",
  "webhook_secret": "your-secret-key"
}

Response

Workflow execution queued

execution_idstring

Queued workflow execution identifier.

status'queued'

Execution queue status returned immediately after triggering.

Example response

{
  "execution_id": "exec_xyz789",
  "status": "queued"
}

Changes

No recorded changes to this operation across all 1 revision of this API.