GET/form/human_input/{form_token}

Get Human Input Form

Available for: Chatflow, Workflow apps.

Returns the contents of a paused Human Input form. Requires web app delivery.

For the full sequence of Human Input calls, see Human Input Flow.

1 parameter
form_tokenstringrequired
Access token for the paused form, returned in the `human_input_required` event from the Run Workflow or Send Chat Message endpoint in streaming mode.

3 status codes
200Form contents retrieved successfully.
expiration_timeintegeroptional
Unix timestamp (seconds) after which this form can no longer be submitted.
form_contentstringoptional
Pre-rendered form body with workflow variables substituted.
inputsarray<object>optional
Form input field definitions.
resolved_default_valuesobjectoptional
Pre-rendered values to display in the form. Keyed by input `output_variable_name`. Populated for `paragraph` inputs whose default resolves from a workflow variable; empty for inputs with no resolvable default. Display these values; do not re-resolve `default` on the client. All values are stringified.
user_actionsarray<object>optional
Available submission actions.
404`not_found` : Form not found.

One documented failure

  • not_found

    Form not found

    not_found

412- `human_input_form_submitted` : Form already submitted. Forms are one-shot; the first response wins regardless of which user submits it. - `human_input_form_expired` : The form's expiration time passed before submission arrived.

2 documented failures

  • human_input_form_expired

    This form has expired, form_id=a1b2c3d4-e5f6-7890-abcd-ef1234567890

    human_input_form_expired

  • human_input_form_submitted

    This form has already been submitted by another user, form_id=a1b2c3d4-e5f6-7890-abcd-ef1234567890

    human_input_form_submitted

Error handling

A 404 is returned: not_found : Form not found. A 412 is returned: - human_input_form_submitted : Form already submitted. Forms are one-shot; the first response wins regardless of which user submits it.

  • human_input_form_expired : The form's expiration time passed before submission arrived.