Submit Human Input Form

post/form/human_input/{form_token}

Request example

curl --request POST \
  --url https://api.dify.ai/v1/form/human_input/{form_token} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "approve",
  "inputs": {
    "attachment": {
      "transfer_method": "local_file",
      "type": "image",
      "upload_file_id": "3c8fa1b2-7d4e-4f9a-b0c1-d2e3f4a5b6c7"
    },
    "attachments": [
      {
        "transfer_method": "local_file",
        "type": "document",
        "upload_file_id": "1a77f0df-c0e6-461c-987c-e72526f341ee"
      },
      {
        "transfer_method": "remote_url",
        "type": "document",
        "url": "https://example.com/report.pdf"
      }
    ],
    "feedback": "Looks good to ship",
    "priority": "high"
  },
  "user": "abc-123"
}'

import requests

url = "https://api.dify.ai/v1/form/human_input/{form_token}"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
}
payload = {
    "action": "approve",
    "inputs": {
        "attachment": {
            "transfer_method": "local_file",
            "type": "image",
            "upload_file_id": "3c8fa1b2-7d4e-4f9a-b0c1-d2e3f4a5b6c7"
        },
        "attachments": [
            {
                "transfer_method": "local_file",
                "type": "document",
                "upload_file_id": "1a77f0df-c0e6-461c-987c-e72526f341ee"
            },
            {
                "transfer_method": "remote_url",
                "type": "document",
                "url": "https://example.com/report.pdf"
            }
        ],
        "feedback": "Looks good to ship",
        "priority": "high"
    },
    "user": "abc-123"
}

response = requests.request("POST", url, headers=headers, json=payload)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/form/human_input/{form_token}', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "action": "approve",
    "inputs": {
      "attachment": {
        "transfer_method": "local_file",
        "type": "image",
        "upload_file_id": "3c8fa1b2-7d4e-4f9a-b0c1-d2e3f4a5b6c7"
      },
      "attachments": [
        {
          "transfer_method": "local_file",
          "type": "document",
          "upload_file_id": "1a77f0df-c0e6-461c-987c-e72526f341ee"
        },
        {
          "transfer_method": "remote_url",
          "type": "document",
          "url": "https://example.com/report.pdf"
        }
      ],
      "feedback": "Looks good to ship",
      "priority": "high"
    },
    "user": "abc-123"
  })
});

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 => 'POST',
  CURLOPT_POSTFIELDS => '{
  "action": "approve",
  "inputs": {
    "attachment": {
      "transfer_method": "local_file",
      "type": "image",
      "upload_file_id": "3c8fa1b2-7d4e-4f9a-b0c1-d2e3f4a5b6c7"
    },
    "attachments": [
      {
        "transfer_method": "local_file",
        "type": "document",
        "upload_file_id": "1a77f0df-c0e6-461c-987c-e72526f341ee"
      },
      {
        "transfer_method": "remote_url",
        "type": "document",
        "url": "https://example.com/report.pdf"
      }
    ],
    "feedback": "Looks good to ship",
    "priority": "high"
  },
  "user": "abc-123"
}',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
    'Content-Type: application/json',
  ],
]);

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

echo $response;

package main

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

func main() {
	url := "https://api.dify.ai/v1/form/human_input/{form_token}"
	payload := strings.NewReader("{\n  \"action\": \"approve\",\n  \"inputs\": {\n    \"attachment\": {\n      \"transfer_method\": \"local_file\",\n      \"type\": \"image\",\n      \"upload_file_id\": \"3c8fa1b2-7d4e-4f9a-b0c1-d2e3f4a5b6c7\"\n    },\n    \"attachments\": [\n      {\n        \"transfer_method\": \"local_file\",\n        \"type\": \"document\",\n        \"upload_file_id\": \"1a77f0df-c0e6-461c-987c-e72526f341ee\"\n      },\n      {\n        \"transfer_method\": \"remote_url\",\n        \"type\": \"document\",\n        \"url\": \"https://example.com/report.pdf\"\n      }\n    ],\n    \"feedback\": \"Looks good to ship\",\n    \"priority\": \"high\"\n  },\n  \"user\": \"abc-123\"\n}")

	req, _ := http.NewRequest("POST", url, payload)
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\n  \"action\": \"approve\",\n  \"inputs\": {\n    \"attachment\": {\n      \"transfer_method\": \"local_file\",\n      \"type\": \"image\",\n      \"upload_file_id\": \"3c8fa1b2-7d4e-4f9a-b0c1-d2e3f4a5b6c7\"\n    },\n    \"attachments\": [\n      {\n        \"transfer_method\": \"local_file\",\n        \"type\": \"document\",\n        \"upload_file_id\": \"1a77f0df-c0e6-461c-987c-e72526f341ee\"\n      },\n      {\n        \"transfer_method\": \"remote_url\",\n        \"type\": \"document\",\n        \"url\": \"https://example.com/report.pdf\"\n      }\n    ],\n    \"feedback\": \"Looks good to ship\",\n    \"priority\": \"high\"\n  },\n  \"user\": \"abc-123\"\n}"))
    .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::Post.new(url)
request['Authorization'] = 'Bearer <token>'
request['Content-Type'] = 'application/json'
request.body = '{
  "action": "approve",
  "inputs": {
    "attachment": {
      "transfer_method": "local_file",
      "type": "image",
      "upload_file_id": "3c8fa1b2-7d4e-4f9a-b0c1-d2e3f4a5b6c7"
    },
    "attachments": [
      {
        "transfer_method": "local_file",
        "type": "document",
        "upload_file_id": "1a77f0df-c0e6-461c-987c-e72526f341ee"
      },
      {
        "transfer_method": "remote_url",
        "type": "document",
        "url": "https://example.com/report.pdf"
      }
    ],
    "feedback": "Looks good to ship",
    "priority": "high"
  },
  "user": "abc-123"
}'

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

Response

{}

{
  "code": "bad_request",
  "message": "Form recipient type is invalid",
  "status": 400
}

{
  "code": "invalid_form_data",
  "message": "Missing required inputs: feedback",
  "status": 400
}

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

post/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.

Body

application/json

actionstringrequired#

ID of the action button the recipient selected. Must match one of the id values from the form's user_actions list (returned by Get Human Input Form).

inputsobjectrequired#

Submitted values keyed by each input's output_variable_name. Paragraph and select inputs take a string; a file input takes one file mapping; a file-list input takes an array of file mappings.

A file mapping is {transfer_method: local_file, upload_file_id, type} or {transfer_method: remote_url, url, type}, where type is one of the field's allowed_file_types. For local_file, upload_file_id is the id from Upload File.

Use a consistent user across the run, upload, and submit.

userstringrequired#

End-user identifier, defined by your app and unique within it. Service API and web app user IDs are separate, even when identical. See End User Identity.

Responses

application/json

Form submitted successfully. The response body is an empty object.

Get Human Input Form Create an Empty Knowledge Base