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.

GET /form/human_input/{form_token}

Get Human Input Form

cURL

curl --request GET \
  --url https://{api_base_url}/form/human_input/{form_token} \
  --header 'Authorization: Bearer <token>'

200

success

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

Authorizations

Authorization · string · header · required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

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.

expiration_time · integer<int64> | null

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

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