Execute workflow

Manually trigger workflow execution. Execution is asynchronous (tree-based execution publishes starting-action commands and returns) — the verdict is not in this response; poll GET /workflows/{workflow_id}/executions/{execution_id}.

Path Parameters

• workflow_id string required

  Workflow identifier

Header Parameters

• SlashID-OrgID string required

  The organization ID

  Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1

application/json

Request Body

Optional. Existing callers that send no body keep working, defaulting to a live run with no subject identity. A caller that DOES send a body must include mode, so the request states explicitly whether it starts a live run or a dry run.

• identity_id string

  Neo4j entity_id of the subject identity. Required for a JML workflow; ignored for a raw workflow whose data input selects its own items.

• mode string required

  Possible values: [live, dry_run]

  Controls whether an execution publishes outbound provider events. dry_run resolves and records every step identically to a live run but suppresses outbound publication at the publish boundary. Empty (on an existing execution) means live.

Responses

• 202
• 400
• 404

---

Workflow execution accepted

application/json

• Schema
• Example (from schema)

---

Schema

• execution_id string

{
  "execution_id": "string"
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  pagination object

  limit integer

  offset integer

  total_count int64

  cursor_pagination object

  Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  limit integer

  next_cursor string

  Opaque token addressing the next page. Absent on the last page.

  prev_cursor string

  Opaque token addressing the previous page. Absent on the first page.

  last_cursor string

  Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  total_count int64

  Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.

• errors object[]

  httpcode integer

  message string

  code string

  Machine-readable reason, present only for errors that define one. Values today: unserved_org_region (the organization is homed in a region this deployment does not serve), wrong_region (the request must be sent to the organization's home region), region_route_missing (this instance has no route to the organization's home region).

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    },
    "cursor_pagination": {
      "limit": 0,
      "next_cursor": "string",
      "prev_cursor": "string",
      "last_cursor": "string",
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string",
      "code": "string"
    }
  ]
}

Not Found

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  pagination object

  limit integer

  offset integer

  total_count int64

  cursor_pagination object

  Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  limit integer

  next_cursor string

  Opaque token addressing the next page. Absent on the last page.

  prev_cursor string

  Opaque token addressing the previous page. Absent on the first page.

  last_cursor string

  Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  total_count int64

  Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.

• errors object[]

  httpcode integer

  message string

  code string

  Machine-readable reason, present only for errors that define one. Values today: unserved_org_region (the organization is homed in a region this deployment does not serve), wrong_region (the request must be sent to the organization's home region), region_route_missing (this instance has no route to the organization's home region).

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    },
    "cursor_pagination": {
      "limit": 0,
      "next_cursor": "string",
      "prev_cursor": "string",
      "last_cursor": "string",
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string",
      "code": "string"
    }
  ]
}