Submit Human Input Form

curl --request POST \ --url https://{api_base_url}/form/human_input/{form_token} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "inputs": { "feedback": "Looks good to ship", "priority": "high", "attachment": { "transfer_method": "local_file", "upload_file_id": "3c8fa1b2-7d4e-4f9a-b0c1-d2e3f4a5b6c7", "type": "image" }, "attachments": [ { "transfer_method": "local_file", "upload_file_id": "1a77f0df-c0e6-461c-987c-e72526f341ee", "type": "document" }, { "transfer_method": "remote_url", "url": "https://example.com/report.pdf", "type": "document" } ] }, "action": "approve", "user": "abc-123" } '

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.

Body

application/json

inputs

object

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 (image, document, audio, video, custom). For local_file, upload_file_id is the id from Upload File. Use a consistent user across the run, upload, and submit.

action

string

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

user

string

required

Identifier for the end user, defined by your application's rules and unique within the app. Service API and WebApp user IDs are separate, even when identical.

Response

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

The response is of type object.