v6

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-0182128753.1 KB

Human Input

Submit Human Input Form

Available for: Chatflow, Workflow apps.

Submits the recipient's response to a paused Human Input form. On acceptance the workflow resumes; follow the resumed run via Stream Workflow Events. Requires web app delivery.

post/form/human_input/{form_token}

Path parameters

form_tokenstring 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.

Request body

inputsobject required

Submitted values keyed by each input's output_variable_name. Paragraph and select inputs take a string; a file input takes one file mapping; a file-list input takes an array of file mappings.

A file mapping is {transfer_method: local_file, upload_file_id, type} or {transfer_method: remote_url, url, type}, where type is one of the field's allowed_file_types. For local_file, upload_file_id is the id from Upload File.

Use a consistent user across the run, upload, and submit.

actionstring required

ID of the action button the recipient selected. Must match one of the id values from the form's user_actions list (returned by Get Human Input Form).

userstring required

End-user identifier, defined by your app and unique within it. Service API and web app user IDs are separate, even when identical. See End User Identity.

Response

Form submitted successfully. The response body is an empty object.

object required