Skip to main content
GET
/
form
/
human_input
/
{form_token}
Get Human Input Form
curl --request GET \
  --url https://{api_base_url}/form/human_input/{form_token} \
  --header 'Authorization: Bearer <token>'
{
  "form_content": "Please review the draft, set a priority, and confirm or request changes.",
  "inputs": [
    {
      "type": "paragraph",
      "output_variable_name": "feedback",
      "default": {
        "type": "constant",
        "selector": [],
        "value": ""
      }
    },
    {
      "type": "select",
      "output_variable_name": "priority",
      "option_source": {
        "type": "constant",
        "selector": [],
        "value": [
          "low",
          "medium",
          "high"
        ]
      }
    },
    {
      "type": "file",
      "output_variable_name": "attachment",
      "allowed_file_types": [
        "image",
        "document"
      ],
      "allowed_file_extensions": [],
      "allowed_file_upload_methods": [
        "local_file",
        "remote_url"
      ]
    },
    {
      "type": "file-list",
      "output_variable_name": "attachments",
      "allowed_file_types": [
        "image",
        "document"
      ],
      "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

Form contents retrieved successfully.

​
form_content
string

Pre-rendered form body with workflow variables substituted.

​
inputs
object[]

Form input field definitions.

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

​
user_actions
object[]

Available submission actions.

​
expiration_time
integer<int64> | null

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

Last modified on June 26, 2026