Get Human Input Form

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/form/human_input/{form_token}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/form/human_input/{form_token}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/form/human_input/{form_token}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/form/human_input/{form_token}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
}

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>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/form/human_input/{form_token}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/form/human_input/{form_token}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/form/human_input/{form_token}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/form/human_input/{form_token}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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

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.

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

expiration_time

integer<int64> | null

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

Guides

App APIs

Knowledge APIs

Get Human Input Form

Authorizations

Path Parameters

Response