Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Executions API

Execute a Workflow

Use this endpoint to start a new workflow execution. The request returns immediately with a pending status. Use the Idempotency-Key header to ensure safe retries.

post/v1/workflows/{workflowId}/executions

Path parameters

workflowIdstring uuid required

Unique identifier of the workflow.

Headers

Idempotency-Keystring required

Unique idempotency key to ensure safe retries of the same request.

Request body

inputDataobject required

Input data passed to the workflow. Available to all nodes during execution. Maximum payload size is 1 MB.

Example request

{
  "inputData": {
    "transactionId": "txn-98765",
    "amount": 1500,
    "currency": "BRL",
    "customerId": "cust-12345",
    "message": "Payment received"
  }
}

Response

Indicates that an identical request was already processed. Returns the original execution.

executionIdstring uuid

Unique identifier of the execution.

startedAtstring date-time

Timestamp when the execution started.

statusstring

Initial status of the execution (always pending).

workflowIdstring uuid

ID of the workflow being executed.

Example response

{
  "executionId": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
  "startedAt": "2026-03-17T14:35:00Z",
  "status": "running",
  "workflowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}