人間の入力フォームを取得

対象アプリ：Chatflow、Workflow。

一時停止中の人間の入力フォームの内容を取得します。 WebApp 配信が必要です。

人間の入力エンドポイントを呼び出す一連の流れについては、API 連携フロー を参照してください。

GET /form/human_input/{form_token}

人間の入力フォームを取得

cURL

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

200

success

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

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。API Key が欠落または無効な場合、HTTP 401 とエラーコード unauthorized が返されます。

Path Parameters

form_token · string · required

一時停止中のフォームへのアクセストークン。ストリーミングモードのワークフローを実行エンドポイントまたはチャットメッセージを送信エンドポイントが返す human_input_required イベントから取得します。

Response

200

application/json

フォーム内容の取得に成功しました。

form_content · string

ワークフロー変数を埋め込んだ、事前レンダリング済みのフォーム本文。

inputs · object[]

フォーム入力フィールドの定義。

Show child attributes

resolved_default_values · object

フォームに表示するための事前計算済みデフォルト値。入力の output_variable_name をキーとします。デフォルト値がワークフロー変数から解決可能な paragraph 入力にのみ設定されます。解決可能なデフォルトがない入力では空になります。クライアントはこれらの値をそのまま表示してください。 default をクライアント側で再解決する必要はありません。すべての値は文字列化されています。

Show child attributes

user_actions · object[]

利用可能な送信アクション。

Show child attributes

expiration_time · integer<int64> | null

Unix タイムスタンプ（秒）。この時刻以降、フォームは送信できなくなります。