Get Human Input Form

Retrieve a paused Human Input form’s contents using the form_token from a human_input_required event. Requires WebApp delivery.

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

{
  "form_content": "Please review the draft and confirm or request changes.",
  "inputs": [
    {
      "type": "text_input",
      "output_variable_name": "comment",
      "default": {
        "type": "constant",
        "selector": [],
        "value": ""
      }
    }
  ],
  "resolved_default_values": {
    "comment": ""
  },
  "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 Run Workflow 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-filled default values, keyed by input output_variable_name. 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.