Workflows

Trigger a workflow run

Manually triggers a workflow run. Returns 200 when the run completes synchronously, or 202 when it is queued.

post/workflows/{id}/run

Request

  • Base URL
    https://workflow.loopfour.ai/api/v1
  • URL
    https://workflow.loopfour.ai/api/v1/workflows/{id}/run
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Request body

inputobject

Input data for the workflow.

idempotencyKeystring

Prevent duplicate runs (24h TTL).

mode'async' | 'sync'

async (default) or sync.

maxExecutionTimeMsnumber

Max wait time for sync mode (1000-300000ms).

onTimeout'return_run_id' | 'throw_error'

Sync timeout behavior.

onFailure'throw_error' | 'switch_to_async'

Sync failure behavior.

Response

Run completed synchronously or idempotency key matched

successunknown

Example response

{
  "data": {
    "run_id": "run_550e8400-e29b-41d4-a716-446655440000",
    "status": "completed",
    "workflow_id": "wf_abc123"
  }
}

Changes

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