Skip to main content
GET
Get Human Input Form

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

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.