NUnullplatform
Workflow executions

Execute a workflow

Changed on

Starts an execution of the revision resolved by alias (default latest) or revision. With an idempotencyKey, retries return the original execution with 200 and deduplicated: true.

post/workflows/definitions/{id}/execute

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/workflows/definitions/{id}/execute
  • Auth
    HTTP bearer

Path parameters

idstring required

Workflow reference: a server-minted id (wf_...) or the workflow's client-chosen key (lowercase slug, unique per organization).

Query parameters

aliasstring

Run the revision this alias points at. Defaults to latest.

revisioninteger

Run this revision number instead of an alias.

Request body

inputsobject

Run inputs, matching the workflow's declared inputs.

correlationKeystring

Key for targeting this execution with signals later.

idempotencyKeystring

Unique per workflow. Retries with the same key return the original execution.

Example request

{
  "inputs": {
    "due_days": 14
  }
}

Response

An execution with this idempotencyKey already exists.

deduplicatedtrue

Example response

{
  "execution": {
    "id": "exec_8f3a1b2c4d5e",
    "workflowId": "wf_ifWBbWfpug0n",
    "revision": 3,
    "aliasName": "live",
    "error": {
      "code": "HTTP_500"
    }
  }
}

Changes