Get Human Input Form

Retrieve a paused Human Input form’s contents. Requires WebApp delivery.

See the API Integration Flow for the end-to-end sequence of calling Human Input endpoints.

GET /form/human_input/{form_token}

Error

A valid request URL is required to generate request examples

200

success

{ "form_content": "Please review the draft and confirm or request changes.", "inputs": [ { "type": "paragraph", "output_variable_name": "feedback", "default": { "type": "constant", "selector": [], "value": "" } }, { "type": "file-list", "output_variable_name": "attachments", "default": null, "allowed_file_types": [ "document", "image" ], "allowed_file_extensions": [], "allowed_file_upload_methods": [ "local_file", "remote_url" ], "number_limits": 5 } ], "resolved_default_values": { "feedback": "" }, "user_actions": [ { "id": "approve", "title": "Approve", "button_style": "primary" }, { "id": "reject", "title": "Request changes", "button_style": "default" } ], "expiration_time": 1745510400 }

Authorizations

Authorization · string · header · required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with Bearer . Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Path Parameters

form_token · string · required

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.

Response

200

application/json

Form contents retrieved successfully.

form_content · string

Pre-rendered form body with workflow variables substituted.

inputs · object[]

Form input field definitions.

Show child attributes

resolved_default_values · object

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.

Show child attributes

user_actions · object[]

Available submission actions.

Show child attributes

expiration_time · integer<int64>

Unix timestamp (seconds) after which this form can no longer be submitted.