API Referencev2 API (Current)Workflows

Run Workflow

Execute a workflow asynchronously.

Returns execution ID immediately and processes in background via Inngest. Use the GET /workflows/executions/{execution_id} endpoint to check status and retrieve results.

Authentication

X-Browser-Use-API-Keystring
API Key authentication via header

Path Parameters

workflow_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
inputmap from strings to any or nullOptional
Input parameters for the workflow execution
executionMetadatamap from strings to any or nullOptional
Optional metadata for this execution

Response

Successful Response
idstringformat: "uuid"
Unique identifier for the execution
workflowIdstringformat: "uuid"
ID of the workflow being executed
statusenum
Current status of the execution
Allowed values:

Errors