提交人工介入表单

适用于：Chatflow、Workflow。

向暂停中的人工介入表单提交接收人的响应。接受后工作流将恢复；可通过 流式获取工作流事件 跟踪恢复后的运行。需要 WebApp 提交方式。

POST /form/human_input/{form_token}

提交人工介入表单

cURL

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

import requests

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

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

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    inputs: {
      feedback: '可以发布',
      priority: 'high',
      attachment: {
        transfer_method: 'local_file',
        upload_file_id: '3c8fa1b2-7d4e-4f9a-b0c1-d2e3f4a5b6c7',
        type: 'image'
      },
      attachments: [
        {
          transfer_method: 'local_file',
          upload_file_id: '1a77f0df-c0e6-461c-987c-e72526f341ee',
          type: 'document'
        },
        {
          transfer_method: 'remote_url',
          url: 'https://example.com/report.pdf',
          type: 'document'
        }
      ]
    },
    action: 'approve',
    user: 'abc-123'
  })
};

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

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"inputs\": {\n    \"feedback\": \"可以发布\",\n    \"priority\": \"high\",\n    \"attachment\": {\n      \"transfer_method\": \"local_file\",\n      \"upload_file_id\": \"3c8fa1b2-7d4e-4f9a-b0c1-d2e3f4a5b6c7\",\n      \"type\": \"image\"\n    },\n    \"attachments\": [\n      {\n        \"transfer_method\": \"local_file\",\n        \"upload_file_id\": \"1a77f0df-c0e6-461c-987c-e72526f341ee\",\n        \"type\": \"document\"\n      },\n      {\n        \"transfer_method\": \"remote_url\",\n        \"url\": \"https://example.com/report.pdf\",\n        \"type\": \"document\"\n      }\n    ]\n  },\n  \"action\": \"approve\",\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))

}

HttpResponse<String> response = Unirest.post("https://{api_base_url}/form/human_input/{form_token}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"inputs\": {\n    \"feedback\": \"可以发布\",\n    \"priority\": \"high\",\n    \"attachment\": {\n      \"transfer_method\": \"local_file\",\n      \"upload_file_id\": \"3c8fa1b2-7d4e-4f9a-b0c1-d2e3f4a5b6c7\",\n      \"type\": \"image\"\n    },\n    \"attachments\": [\n      {\n        \"transfer_method\": \"local_file\",\n        \"upload_file_id\": \"1a77f0df-c0e6-461c-987c-e72526f341ee\",\n        \"type\": \"document\"\n      },\n      {\n        \"transfer_method\": \"remote_url\",\n        \"url\": \"https://example.com/report.pdf\",\n        \"type\": \"document\"\n      }\n    ]\n  },\n  \"action\": \"approve\",\n  \"user\": \"abc-123\"\n}")
  .asString();

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

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

200

success

{}

Authorizations

Authorization · string · header · required

每个请求都通过 API Key 认证：Authorization: Bearer {API_KEY}。应用接口使用应用 API Key，知识库接口使用知识库 API Key（快速开始）。

API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401（unauthorized）。

Path Parameters

form_token · string · required

暂停表单的访问令牌，由流式模式下执行工作流或发送对话消息接口返回的 human_input_required 事件提供。

Body

application/json

inputs · object · required

按各输入的 output_variable_name 作为键提交的值。段落和下拉选项输入为字符串；file 输入为单个文件映射；file-list 输入为文件映射数组。

文件映射为 {transfer_method: local_file, upload_file_id, type} 或 {transfer_method: remote_url, url, type}，其中 type 为该字段 allowed_file_types 中的一种。对于 local_file，upload_file_id 为 上传文件 返回的 id。

在执行、上传和提交各次调用中使用一致的 user。

action · string · required

接收人选择的操作按钮 ID。必须与表单的 user_actions 列表（由 获取人工介入表单 接口返回）中的某个 id 值匹配。

user · string · required

终端用户标识，由你的应用定义，需在应用内唯一。Service API 与 WebApp 的用户 ID 相互独立，即使取值相同也不指向同一用户。参见 终端用户身份。

Response

200

application/json

表单提交成功。响应体为空对象。

The response is of type object.