Skip to main content
POST
/
v1
/
workflows
/
{workflowId}
/
executions
Execute a Workflow
curl --request POST \
  --url https://flowker.sandbox.lerian.net/v1/workflows/{workflowId}/executions \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "inputData": {
    "transactionId": "txn-98765",
    "amount": 1500,
    "currency": "BRL",
    "customerId": "cust-12345",
    "message": "Payment received"
  }
}
'
{
  "executionId": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
  "startedAt": "2026-03-17T14:35:00Z",
  "status": "running",
  "workflowId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Authorizations

​
X-API-Key
string
header
required

API key for authenticating requests to the Flowker API. Provisioned via the API_KEY environment variable during deployment.

Headers

​
Idempotency-Key
string
required

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

Path Parameters

​
workflowId
string<uuid>
required

Unique identifier of the workflow.

Body

application/json

Request body containing the execution input data.

​
inputData
object
required

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

Example:
{
  "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.

​
executionId
string<uuid>

Unique identifier of the execution.

Example:

"f7e6d5c4-b3a2-1098-7654-321fedcba098"

​
startedAt
string<date-time>

Timestamp when the execution started.

Example:

"2026-03-17T14:35:00Z"

​
status
string

Initial status of the execution (always pending).

Example:

"running"

​
workflowId
string<uuid>

ID of the workflow being executed.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"