Flow

Respond to a pending HITL prompt

POST
/flows/{flow}/executions/{execution}:respond

Delivers a user response to a running execution that is currently blocked on a wait widget.

For widgets that capture files, upload each file via POST /flows/{flow}/executions/{execution}:upload first, then embed the returned in-container path(s) into data.<widget-name> (as a string[]).

Returns 409 if the execution is in a terminal state or is not currently awaiting input. Returns 413 if the body exceeds the configured caps.

BearerAuth
headerAuthorizationBearer <JWT>

Admin token, API token issued via /api-tokens, or an OIDC JWT access token issued by the configured OIDC provider.

flow*string
Formatuuid
execution*string
Formatuuid
application/json
  1. body

A user response to a wait widget. event is the name of the button that submitted the form (e.g. submit or cancel); data holds widget values keyed by Widget.name.

event*string

The submitting button's name (e.g. submit, cancel).

data*

Widget values keyed by widget name. Value types follow each widget's contract (string, number, boolean, string[]).

Response Body

The persisted input row's sequence number.

application/json
  1. response
seq*integer

Sequence number of the persisted input row. Use as the Last-Event-ID header value when reconnecting to the SSE stream after submitting.

Example Request
curl -X POST 'https://example.com/api/hub/flows/497f6eca-6276-4993-bfeb-53cbbbba6f08/executions/497f6eca-6276-4993-bfeb-53cbbbba6f08:respond' \  -H 'Content-Type: application/json' \  -d '{  "event": "string",  "data": {}}'
Example Response
{  "seq": 0}