Get Human Input Form

get/form/human_input/{form_token}

Request example

curl --request GET \
  --url https://api.dify.ai/v1/form/human_input/{form_token} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dify.ai/v1/form/human_input/{form_token}"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/form/human_input/{form_token}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/form/human_input/{form_token}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

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

func main() {
	url := "https://api.dify.ai/v1/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))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/form/human_input/{form_token}"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://api.dify.ai/v1/form/human_input/{form_token}')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

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

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

Response

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

{
  "code": "not_found",
  "message": "Form not found",
  "status": 404
}

{
  "code": "human_input_form_expired",
  "message": "This form has expired, form_id=a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": 412
}

{
  "code": "human_input_form_submitted",
  "message": "This form has already been submitted by another user, form_id=a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": 412
}

get/form/human_input/{form_token}

Authorization

Authorizationstringheaderrequired#

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_tokenstringrequired#

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.

Responses

application/json

Form contents retrieved successfully.

expiration_timeinteger#

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

form_contentstring#

Pre-rendered form body with workflow variables substituted.

inputsobject[]#

Form input field definitions.

Show child attributes

allowed_file_extensionsstring[]#

Allowed file extensions when allowed_file_types includes custom. Include the leading . in each extension, for example .md. Present for file and file-list inputs.

allowed_file_typesenum<string>[]#

File categories the recipient may upload. Present for file and file-list inputs. Values: image, document, audio, video, custom.

allowed_file_upload_methodsenum<string>[]#

Upload methods the recipient may use. Values: local_file, remote_url. Present for file and file-list inputs.

defaultobject#

Raw default-value configuration for paragraph inputs. The client should not resolve this directly; use resolved_default_values to display defaults. absent for other input types or when no default is configured.

Show child attributes

selectorstring[]#

Variable reference path (for example, ["node_id", "var_name"]) when type is variable. Must contain at least two elements.

typestring#

Source of the default. constant means value is used as a literal string; variable means selector points to a workflow variable.

valuestring#

Literal default value when type is constant. Always a string.

number_limitsinteger#

Maximum number of files the recipient may upload. Present only for file-list inputs.

option_sourceobject#

Source of options for select inputs. Present only when type is select.

Show child attributes

selectorstring[]#

Variable reference path when type is variable.

typeenum<string>#

Origin of the options. constant means value lists the options literally; variable means selector points to an array[string] workflow variable that provides them.

Options:variableconstant

valuestring[]#

Literal option list when type is constant.

output_variable_namestring#

Variable name used to reference this input's submitted value inside the workflow. Corresponds to the key in the submission inputs object.

typestring#

Form input control type. Available values: paragraph (multi-line text input), select (single-choice from a list), file (single file upload), and file-list (multiple file uploads).

resolved_default_valuesobject#

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

{key}string#

user_actionsobject[]#

Available submission actions.

Show child attributes

button_stylestring#

Visual style of the button. Available values: primary, default, accent, ghost.

idstring#

Identifier of the action button. Pass as action on Submit Human Input Form when the recipient selects this button.

Length: max 20Pattern: ^[A-Za-z_][A-Za-z0-9_]*$

titlestring#

Button label shown to the recipient.

Length: max 100

Get End User Info Submit Human Input Form