import { CodeGroup } from '../code.tsx' import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'

高度なチャットアプリ API

チャットアプリケーションはセッションの持続性をサポートしており、以前のチャット履歴を応答のコンテキストとして使用できます。これは、チャットボットやカスタマーサービス AI などに適用できます。

認証

サービス API は API-Key 認証を使用します。 <i>API キーはサーバー側に保存し、クライアント側で共有または保存しないことを強くお勧めします。API キーの漏洩は深刻な結果を招く可能性があります。</i>

すべての API リクエストには、以下のように AuthorizationHTTP ヘッダーに API キーを含めてください：

<Col> チャットアプリケーションにリクエストを送信します。

### リクエストボディ

<Properties>
  <Property name='query' type='string' key='query'>
    ユーザー入力/質問内容
  </Property>
  <Property name='inputs' type='object' key='inputs'>
      アプリによって定義されたさまざまな変数値の入力を許可します。
      `inputs`パラメータには複数のキー/値ペアが含まれ、各キーは特定の変数に対応し、各値はその変数の特定の値です。
      変数がファイルタイプの場合、以下の`files`で説明されているキーを持つオブジェクトを指定します。
      デフォルト`{}`
  </Property>
  <Property name='response_mode' type='string' key='response_mode'>
    応答の返却モードを指定します。サポートされているモード：
    - `streaming` ストリーミングモード（推奨）、SSE（[サーバー送信イベント](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events)）を通じてタイプライターのような出力を実装します。
    - `blocking` ブロッキングモード、実行完了後に結果を返します。（プロセスが長い場合、リクエストが中断される可能性があります）
    Cloudflareの制限により、リクエストは100秒後に返答なしで中断されます。
  </Property>
  <Property name='user' type='string' key='user'>
      ユーザー識別子、エンドユーザーの身元を定義するために使用され、統計のために使用されます。
      アプリケーション内で開発者によって一意に定義されるべきです。サービス API は WebApp によって作成された会話を共有しません。
  </Property>
  <Property name='conversation_id' type='string' key='conversation_id'>
  会話ID、以前のチャット記録に基づいて会話を続けるには、以前のメッセージのconversation_idを渡す必要があります。
  </Property>
  <Property name='files' type='array[object]' key='files'>
      ファイルリスト、モデルが Vision/Video 機能をサポートしている場合に限り、ファイルをテキスト理解および質問応答に組み合わせて入力するのに適しています。
      - `type` (string) サポートされるタイプ：
        - `document` サポートされるタイプには以下が含まれます：'TXT', 'MD', 'MARKDOWN', 'MDX', 'PDF', 'HTML', 'XLSX', 'XLS', 'VTT', 'PROPERTIES', 'DOC', 'DOCX', 'CSV', 'EML', 'MSG', 'PPTX', 'PPT', 'XML', 'EPUB'
        - `image` サポートされるタイプには以下が含まれます：'JPG', 'JPEG', 'PNG', 'GIF', 'WEBP', 'SVG'
        - `audio` サポートされるタイプには以下が含まれます：'MP3', 'M4A', 'WAV', 'WEBM', 'MPGA'
        - `video` サポートされるタイプには以下が含まれます：'MP4', 'MOV', 'MPEG', 'WEBM'
        - `custom` サポートされるタイプには以下が含まれます：その他のファイルタイプ
      - `transfer_method` (string) 転送方法:
        - `remote_url`: ファイルのURL。
        - `local_file`: ファイルをアップロード。
      - `url` ファイルのURL。（転送方法が `remote_url` の場合のみ）。
      - `upload_file_id` アップロードされたファイルID。（転送方法が `local_file` の場合のみ）。
  </Property>
  <Property name='auto_generate_name' type='bool' key='auto_generate_name'>
  タイトルを自動生成、デフォルトは`true`。
  `false`に設定すると、会話のリネームAPIを呼び出し、`auto_generate`を`true`に設定することで非同期タイトル生成を実現できます。
  </Property>
  <Property name='workflow_id' type='string' key='workflow_id'>
  （オプション）ワークフローID、特定のバージョンを指定するために使用、提供されない場合はデフォルトの公開バージョンを使用。
  </Property>
  <Property name='trace_id' type='string' key='trace_id'>
    （オプション）トレースID。既存の業務システムのトレースコンポーネントと連携し、エンドツーエンドの分散トレーシングを実現するために使用します。指定がない場合、システムが自動的に trace_id を生成します。以下の3つの方法で渡すことができ、優先順位は次のとおりです：

    - Header：HTTPヘッダー <code>X-Trace-Id</code> で渡す（最優先）。

    - クエリパラメータ：URLクエリパラメータ <code>trace_id</code> で渡す。

    - リクエストボディ：リクエストボディの <code>trace_id</code> フィールドで渡す（本フィールド）。

  </Property>
</Properties>

### 応答
response_modeがブロッキングの場合、CompletionResponseオブジェクトを返します。
response_modeがストリーミングの場合、ChunkCompletionResponseストリームを返します。

### ChatCompletionResponse
完全なアプリ結果を返します。`Content-Type`は`application/json`です。
- `event` (string) イベントタイプ、固定で `message`
- `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用
- `id` (string) ユニークID
- `message_id` (string) 一意のメッセージID
- `conversation_id` (string) 会話ID
- `mode` (string) アプリモード、`chat`として固定
- `answer` (string) 完全な応答内容
- `metadata` (object) メタデータ
  - `usage` (Usage) モデル使用情報
  - `retriever_resources` (array[RetrieverResource]) 引用と帰属リスト
- `created_at` (int) メッセージ作成タイムスタンプ、例：1705395332

### ChunkChatCompletionResponse
アプリによって出力されたストリームチャンクを返します。`Content-Type`は`text/event-stream`です。
各ストリーミングチャンクは`data:`で始まり、2つの改行文字`\n\n`で区切られます。以下のように表示されます：
<CodeGroup>
```streaming {{ title: '応答' }}
data: {"event": "message", "task_id": "900bbd43-dc0b-4383-a372-aa6e6c414227", "id": "663c5084-a254-4040-8ad3-51f2a3c1a77c", "answer": "Hi", "created_at": 1705398420}\n\n
```
</CodeGroup>
ストリーミングチャンクの構造は`event`に応じて異なります：
- `event: message` LLMがテキストチャンクイベントを返します。つまり、完全なテキストがチャンク形式で出力されます。
  - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用
  - `message_id` (string) 一意のメッセージID
  - `conversation_id` (string) 会話ID
  - `answer` (string) LLMが返したテキストチャンク内容
  - `created_at` (int) 作成タイムスタンプ、例：1705395332
- `event: message_file` メッセージファイルイベント、ツールによって新しいファイルが作成されました
  - `id` (string) ファイル一意ID
  - `type` (string) ファイルタイプ、現在は"image"のみ許可
  - `belongs_to` (string) 所属、ここでは'assistant'のみ
  - `url` (string) ファイルのリモートURL
  - `conversation_id`  (string) 会話ID
- `event: message_end` メッセージ終了イベント、このイベントを受信するとストリーミングが終了したことを意味します。
  - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用
  - `message_id` (string) 一意のメッセージID
  - `conversation_id` (string) 会話ID
  - `metadata` (object) メタデータ
    - `usage` (Usage) モデル使用情報
    - `retriever_resources` (array[RetrieverResource]) 引用と帰属リスト
- `event: tts_message` TTSオーディオストリームイベント、つまり音声合成出力。内容はMp3形式のオーディオブロックで、base64文字列としてエンコードされています。再生時には、base64をデコードしてプレーヤーに入力するだけです。（このメッセージは自動再生が有効な場合にのみ利用可能）
  - `task_id` (string) タスクID、リクエスト追跡と以下のストップ応答インターフェースに使用
  - `message_id` (string) 一意のメッセージID
  - `audio` (string) 音声合成後のオーディオ、base64テキストコンテンツとしてエンコードされており、再生時にはbase64をデコードしてプレーヤーに入力するだけです
  - `created_at` (int) 作成タイムスタンプ、例：1705395332
- `event: tts_message_end` TTSオーディオストリーム終了イベント、このイベントを受信するとオーディオストリームが終了したことを示します。
  - `task_id` (string) タスクID、リクエスト追跡と以下のストップ応答インターフェースに使用
  - `message_id` (string) 一意のメッセージID
  - `audio` (string) 終了イベントにはオーディオがないため、これは空の文字列です
  - `created_at` (int) 作成タイムスタンプ、例：1705395332
- `event: message_replace` メッセージ内容置換イベント。
  出力内容のモデレーションが有効な場合、内容がフラグ付けされると、このイベントを通じてメッセージ内容がプリセットの返信に置き換えられます。
  - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用
  - `message_id` (string) 一意のメッセージID
  - `conversation_id` (string) 会話ID
  - `answer` (string) 置換内容（すべてのLLM返信テキストを直接置き換えます）
  - `created_at` (int) 作成タイムスタンプ、例：1705395332
- `event: workflow_started` ワークフローが実行を開始
  - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用
  - `workflow_run_id` (string) ワークフロー実行の一意ID
  - `event` (string) `workflow_started`に固定
  - `data` (object) 詳細
    - `id` (string) ワークフロー実行の一意ID
    - `workflow_id` (string) 関連ワークフローのID
    - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332
- `event: node_started` ノード実行が開始
  - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用
  - `workflow_run_id` (string) ワークフロー実行の一意ID
  - `event` (string) `node_started`に固定
  - `data` (object) 詳細
    - `id` (string) ワークフロー実行の一意ID
    - `node_id` (string) ノードのID
    - `node_type` (string) ノードのタイプ
    - `title` (string) ノードの名前
    - `index` (int) 実行シーケンス番号、トレースノードシーケンスを表示するために使用
    - `predecessor_node_id` (string) オプションのプレフィックスノードID、キャンバス表示実行パスに使用
    - `inputs` (object) ノードで使用されるすべての前のノード変数の内容
    - `created_at` (timestamp) 開始のタイムスタンプ、例：1705395332
- `event: node_finished` ノード実行が終了、成功または失敗は同じイベント内で異なる状態で示されます
  - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用
  - `workflow_run_id` (string) ワークフロー実行の一意ID
  - `event` (string) `node_finished`に固定
  - `data` (object) 詳細
    - `id` (string) ワークフロー実行の一意ID
    - `node_id` (string) ノードのID
    - `node_type` (string) ノードのタイプ
    - `title` (string) ノードの名前
    - `index` (int) 実行シーケンス番号、トレースノードシーケンスを表示するために使用
    - `predecessor_node_id` (string) オプションのプレフィックスノードID、キャンバス表示実行パスに使用
    - `inputs` (object) ノードで使用されるすべての前のノード変数の内容
    - `process_data` (json) オプションのノードプロセスデータ
    - `outputs` (json) オプションの出力内容
    - `status` (string) 実行の状態、`running` / `succeeded` / `failed` / `stopped`
    - `error` (string) オプションのエラー理由
    - `elapsed_time` (float) オプションの使用される合計秒数
    - `execution_metadata` (json) メタデータ
      - `total_tokens` (int) オプションの使用されるトークン数
      - `total_price` (decimal) オプションの合計コスト
      - `currency` (string) オプション、例：`USD` / `RMB`
    - `created_at` (timestamp) 開始のタイムスタンプ、例：1705395332
- `event: human_input_required` ワークフローが一時停止し、Human-in-the-Loop 入力が必要
  - `task_id` (string) タスク ID、リクエスト追跡に使用
  - `workflow_run_id` (string) ワークフロー実行の一意 ID
  - `event` (string) `human_input_required`に固定
  - `data` (object) 詳細
    - `form_id` (string) ヒューマン入力フォーム ID
    - `node_id` (string) Human Input ノード ID
    - `node_title` (string) Human Input ノードタイトル
    - `form_content` (string) レンダリング済みフォーム内容
    - `inputs` (array[object]) フォーム入力項目の定義
    - `actions` (array[object]) ユーザーが選択できるアクションボタン
      - `id` (string) アクション ID
      - `title` (string) ボタンラベル
      - `button_style` (string) ボタンスタイル
    - `display_in_ui` (bool) UI にこのフォームを表示するかどうか
    - `form_token` (string) `/form/human_input/:form_token` API で使用するトークン
    - `resolved_default_values` (object) 実行時に解決されたデフォルト値
    - `expiration_time` (timestamp) フォームの有効期限（Unix 秒）
- `event: workflow_finished` ワークフロー実行が終了、成功または失敗は同じイベント内で異なる状態で示されます
  - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用
  - `workflow_run_id` (string) ワークフロー実行の一意ID
  - `event` (string) `workflow_finished`に固定
  - `data` (object) 詳細
    - `id` (string) ワークフロー実行のID
    - `workflow_id` (string) 関連ワークフローのID
    - `status` (string) 実行の状態、`running` / `succeeded` / `failed` / `stopped`
    - `outputs` (json) オプションの出力内容
    - `error` (string) オプションのエラー理由
    - `elapsed_time` (float) オプションの使用される合計秒数
    - `total_tokens` (int) オプションの使用されるトークン数
    - `total_steps` (int) デフォルト0
    - `created_at` (timestamp) 開始時間
    - `finished_at` (timestamp) 終了時間
- `event: error`
  ストリーミングプロセス中に発生する例外はストリームイベントの形式で出力され、エラーイベントを受信するとストリームが終了します。
  - `task_id` (string) タスクID、リクエスト追跡と以下のStop Generate APIに使用
  - `message_id` (string) 一意のメッセージID
  - `status` (int) HTTPステータスコード
  - `code` (string) エラーコード
  - `message` (string) エラーメッセージ
- `event: ping` 接続を維持するために10秒ごとにpingイベントが発生します。

### エラー
- 404, 会話が存在しません
- 400, `invalid_param`, 異常なパラメータ入力
- 400, `app_unavailable`, アプリ構成が利用できません
- 400, `provider_not_initialize`, 利用可能なモデル資格情報構成がありません
- 400, `provider_quota_exceeded`, モデル呼び出しクォータが不足しています
- 400, `model_currently_not_support`, 現在のモデルが利用できません
- 400, `workflow_not_found`, 指定されたワークフローバージョンが見つかりません
- 400, `draft_workflow_error`, ドラフトワークフローバージョンは使用できません
- 400, `workflow_id_format_error`, ワークフローID形式エラー、UUID形式が必要です
- 400, `completion_request_error`, テキスト生成に失敗しました
- 500, 内部サーバーエラー

</Col> <Col sticky>

<CodeGroup
  title="リクエスト"
  tag="POST"
  label="/chat-messages"
  targetCode={`curl -X POST '${props.appDetail.api_base_url}/chat-messages' \\

--header 'Authorization: Bearer {api_key}' \ --header 'Content-Type: application/json' \ --data-raw '{ "inputs": ${JSON.stringify(props.inputs)}, "query": "What are the specs of the iPhone 13 Pro Max?", "response_mode": "streaming", "conversation_id": "", "user": "abc-123", "files": [ { "type": "image", "transfer_method": "remote_url", "url": "https://cloud.dify.ai/logo/logo-site.png" } ] }'`} /> ### ブロッキングモードブロッキングモードでは、通常のチャット応答、または一時停止したワークフロー応答のいずれかが返されます。

Advanced Chat が Human-in-the-Loop で一時停止すると、`event` は `workflow_paused` になります。
それでもペイロードには `message_id`、`conversation_id`、`answer`、`workflow_run_id` が含まれ、`data` には `paused_nodes` と `reasons` が追加されます。
`human_input_required` の各 reason には `form_id` と `expiration_time` が含まれます。

<CodeGroup title="応答">
```json {{ title: '応答' }}
{
    "event": "message",
    "task_id": "c3800678-a077-43df-a102-53f23ed20b88",
    "id": "9da23599-e713-473b-982c-4328d4f5c78a",
    "message_id": "9da23599-e713-473b-982c-4328d4f5c78a",
    "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2",
    "mode": "chat",
    "answer": "iPhone 13 Pro Maxの仕様は次のとおりです:...",
    "metadata": {
        "usage": {
            "prompt_tokens": 1033,
            "prompt_unit_price": "0.001",
            "prompt_price_unit": "0.001",
            "prompt_price": "0.0010330",
            "completion_tokens": 128,
            "completion_unit_price": "0.002",
            "completion_price_unit": "0.001",
            "completion_price": "0.0002560",
            "total_tokens": 1161,
            "total_price": "0.0012890",
            "currency": "USD",
            "latency": 0.7682376249867957
        },
        "retriever_resources": [
            {
                "position": 1,
                "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb",
                "dataset_name": "iPhone",
                "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00",
                "document_name": "iPhone List",
                "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a",
                "score": 0.98457545,
                "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"iPhone 13 Pro Max\",\"September 24, 2021\",\"6.7 inch\",\"1284 x 2778\",\"Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)\",\"6 GB\",\"128, 256, 512 GB, 1TB\",\"12 MP\",\"4352 mAh\",\"iOS 15\""
            }
        ]
    },
    "created_at": 1705407629
}
```
</CodeGroup>
<CodeGroup title="一時停止レスポンス例">
```json {{ title: '一時停止レスポンス例' }}
{
    "event": "workflow_paused",
    "task_id": "8a9cbfcf-e7e0-4b17-aeef-24de57a2659a",
    "id": "31714374-88cb-485f-9fa4-e3ab2a9ed95e",
    "message_id": "31714374-88cb-485f-9fa4-e3ab2a9ed95e",
    "conversation_id": "098e19be-356a-435d-9ec3-a406f4f1a97a",
    "mode": "advanced-chat",
    "answer": "",
    "metadata": {
        "annotation_reply": null,
        "retriever_resources": [],
        "usage": null
    },
    "created_at": 1776074715,
    "workflow_run_id": "7a4d6509-8a65-4c7d-a4fd-cf081dcf169f",
    "data": {
        "id": "31714374-88cb-485f-9fa4-e3ab2a9ed95e",
        "mode": "advanced-chat",
        "conversation_id": "098e19be-356a-435d-9ec3-a406f4f1a97a",
        "message_id": "31714374-88cb-485f-9fa4-e3ab2a9ed95e",
        "workflow_run_id": "7a4d6509-8a65-4c7d-a4fd-cf081dcf169f",
        "answer": "",
        "metadata": {
            "annotation_reply": null,
            "retriever_resources": [],
            "usage": null
        },
        "created_at": 1776074715,
        "paused_nodes": [
            "1775724080699"
        ],
        "reasons": [
            {
                "form_id": "019d864d-6f55-752c-9f4c-feee67508d5b",
                "form_content": "this is form 2:\n\n{{#$output.some_field_2#}}\n",
                "inputs": [
                    {
                        "type": "paragraph",
                        "output_variable_name": "some_field_2",
                        "default": {
                            "type": "constant",
                            "selector": [],
                            "value": ""
                        }
                    }
                ],
                "actions": [
                    {
                        "id": "approve",
                        "title": "yes",
                        "button_style": "default"
                    },
                    {
                        "id": "reject",
                        "title": "no",
                        "button_style": "default"
                    }
                ],
                "display_in_ui": true,
                "node_id": "1775724080699",
                "node_title": "Human Input 2",
                "resolved_default_values": {},
                "form_token": "0dvwTdpTFXgCZmAo2FoiJ5",
                "type": "human_input_required",
                "expiration_time": 1776333914
            }
        ],
        "status": "paused",
        "elapsed_time": 0.034081,
        "total_tokens": 0,
        "total_steps": 2
    }
}
```
</CodeGroup>
### ストリーミングモード
<CodeGroup title="応答">
```streaming {{ title: '応答' }}
  data: {"event": "workflow_started", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "workflow_id": "dfjasklfjdslag", "created_at": 1679586595}}
  data: {"event": "node_started", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "node_id": "dfjasklfjdslag", "node_type": "start", "title": "Start", "index": 0, "predecessor_node_id": "fdljewklfklgejlglsd", "inputs": {}, "created_at": 1679586595}}
  data: {"event": "node_finished", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "node_id": "dfjasklfjdslag", "node_type": "start", "title": "Start", "index": 0, "predecessor_node_id": "fdljewklfklgejlglsd", "inputs": {}, "outputs": {}, "status": "succeeded", "elapsed_time": 0.324, "execution_metadata": {"total_tokens": 63127864, "total_price": 2.378, "currency": "USD"},  "created_at": 1679586595}}
  data: {"event": "workflow_finished", "task_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "workflow_run_id": "5ad498-f0c7-4085-b384-88cbe6290", "data": {"id": "5ad498-f0c7-4085-b384-88cbe6290", "workflow_id": "dfjasklfjdslag", "outputs": {}, "status": "succeeded", "elapsed_time": 0.324, "total_tokens": 63127864, "total_steps": "1", "created_at": 1679586595, "finished_at": 1679976595}}
  data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " I", "created_at": 1679586595}
  data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": "'m", "created_at": 1679586595}
  data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " glad", "created_at": 1679586595}
  data: {"event": "message", "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " to", "created_at": 1679586595}
  data: {"event": "message", "message_id" : "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " meet", "created_at": 1679586595}
  data: {"event": "message", "message_id" : "5ad4cb98-f0c7-4085-b384-88c403be6290", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "answer": " you", "created_at": 1679586595}
  data: {"event": "message_end", "id": "5e52ce04-874b-4d27-9045-b3bc80def685", "conversation_id": "45701982-8118-4bc5-8e9b-64562b4555f2", "metadata": {"usage": {"prompt_tokens": 1033, "prompt_unit_price": "0.001", "prompt_price_unit": "0.001", "prompt_price": "0.0010330", "completion_tokens": 135, "completion_unit_price": "0.002", "completion_price_unit": "0.001", "completion_price": "0.0002700", "total_tokens": 1168, "total_price": "0.0013030", "currency": "USD", "latency": 1.381760165997548}, "retriever_resources": [{"position": 1, "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb", "dataset_name": "iPhone", "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00", "document_name": "iPhone List", "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a", "score": 0.98457545, "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"iPhone 13 Pro Max\",\"September 24, 2021\",\"6.7 inch\",\"1284 x 2778\",\"Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)\",\"6 GB\",\"128, 256, 512 GB, 1TB\",\"12 MP\",\"4352 mAh\",\"iOS 15\""}]}}
  data: {"event": "tts_message", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": "qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq"}
  data: {"event": "tts_message_end", "conversation_id": "23dd85f3-1a41-4ea0-b7a9-062734ccfaf9", "message_id": "a8bdc41c-13b2-4c18-bfd9-054b9803038c", "created_at": 1721205487, "task_id": "3bf8a0bb-e73b-4690-9e66-4e429bad8ee7", "audio": ""}
```
</CodeGroup>
ストリーミングモードでも Human-in-the-Loop により一時停止する場合があります。その場合、SSE ストリームではまず `human_input_required` が送られ、その後に `workflow_paused` が送られます。

<CodeGroup title="一時停止ストリーミングレスポンス例">
```streaming {{ title: '一時停止ストリーミングレスポンス例' }}
event: ping

data: {
  "event": "workflow_started",
  "workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
  "task_id": "0399c5c2-181b-4493-a78e-1421914e8a25",
  "data": {
    "id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
    "workflow_id": "e46514f1-c008-41ff-94b0-4f33d4b97d36",
    "inputs": {
      "sys.files": [],
      "sys.user_id": "abc-123",
      "sys.app_id": "d1074979-f67e-4114-8691-e35878df9a89",
      "sys.workflow_id": "e46514f1-c008-41ff-94b0-4f33d4b97d36",
      "sys.workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345"
    },
    "created_at": 1776129228,
    "reason": "initial"
  }
}

data: {
  "event": "node_started",
  "workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
  "task_id": "0399c5c2-181b-4493-a78e-1421914e8a25",
  "data": {
    "id": "7d9bb041-5ecb-497f-a674-d8706eed0ab1",
    "node_id": "1775717266623",
    "node_type": "start",
    "title": "User Input",
    "index": 1,
    "predecessor_node_id": null,
    "inputs": null,
    "inputs_truncated": false,
    "created_at": 1776129228,
    "extras": {},
    "iteration_id": null,
    "loop_id": null,
    "agent_strategy": null
  }
}

data: {
  "event": "node_finished",
  "workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
  "task_id": "0399c5c2-181b-4493-a78e-1421914e8a25",
  "data": {
    "id": "7d9bb041-5ecb-497f-a674-d8706eed0ab1",
    "node_id": "1775717266623",
    "node_type": "start",
    "title": "User Input",
    "index": 1,
    "predecessor_node_id": null,
    "inputs": {
      "sys.files": [],
      "sys.user_id": "abc-123",
      "sys.app_id": "d1074979-f67e-4114-8691-e35878df9a89",
      "sys.workflow_id": "e46514f1-c008-41ff-94b0-4f33d4b97d36",
      "sys.workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
      "sys.timestamp": 1776129228
    },
    "inputs_truncated": false,
    "process_data": {},
    "process_data_truncated": false,
    "outputs": {
      "sys.files": [],
      "sys.user_id": "abc-123",
      "sys.app_id": "d1074979-f67e-4114-8691-e35878df9a89",
      "sys.workflow_id": "e46514f1-c008-41ff-94b0-4f33d4b97d36",
      "sys.workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
      "sys.timestamp": 1776129228
    },
    "outputs_truncated": false,
    "status": "succeeded",
    "error": null,
    "elapsed_time": 0.000097,
    "execution_metadata": null,
    "created_at": 1776129228,
    "finished_at": 1776129228,
    "files": [],
    "iteration_id": null,
    "loop_id": null
  }
}

data: {
  "event": "node_started",
  "workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
  "task_id": "0399c5c2-181b-4493-a78e-1421914e8a25",
  "data": {
    "id": "c09ff568-1d55-4f0d-9a07-512bcbfeb289",
    "node_id": "1775717346519",
    "node_type": "human-input",
    "title": "Human Input",
    "index": 1,
    "predecessor_node_id": null,
    "inputs": null,
    "inputs_truncated": false,
    "created_at": 1776129228,
    "extras": {},
    "iteration_id": null,
    "loop_id": null,
    "agent_strategy": null
  }
}

data: {
  "event": "human_input_required",
  "workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
  "task_id": "0399c5c2-181b-4493-a78e-1421914e8a25",
  "data": {
    "form_id": "019d898d-3d80-7105-b920-9899ead4ff3e",
    "node_id": "1775717346519",
    "node_title": "Human Input",
    "form_content": "this is form 1:\n{{#$output.some_field#}}\n",
    "inputs": [
      {
        "type": "paragraph",
        "output_variable_name": "some_field",
        "default": {
          "type": "variable",
          "selector": [
            "sys",
            "workflow_run_id"
          ],
          "value": ""
        }
      }
    ],
    "actions": [
      {
        "id": "approve",
        "title": "YES",
        "button_style": "default"
      },
      {
        "id": "reject",
        "title": "NO",
        "button_style": "default"
      }
    ],
    "display_in_ui": true,
    "form_token": "0Tb1nXYe4hzQUD706nHB4y",
    "resolved_default_values": {
      "some_field": "a4959eb4-c852-4e0c-ac7a-348233f7f345"
    },
    "expiration_time": 1776388428
  }
}

data: {
  "event": "workflow_paused",
  "workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
  "task_id": "0399c5c2-181b-4493-a78e-1421914e8a25",
  "data": {
    "workflow_run_id": "a4959eb4-c852-4e0c-ac7a-348233f7f345",
    "paused_nodes": [
      "1775717346519"
    ],
    "outputs": {},
    "reasons": [
      {
        "form_id": "019d898d-3d80-7105-b920-9899ead4ff3e",
        "form_content": "this is form 1:\n{{#$output.some_field#}}\n",
        "inputs": [
          {
            "type": "paragraph",
            "output_variable_name": "some_field",
            "default": {
              "type": "variable",
              "selector": [
                "sys",
                "workflow_run_id"
              ],
              "value": ""
            }
          }
        ],
        "actions": [
          {
            "id": "approve",
            "title": "YES",
            "button_style": "default"
          },
          {
            "id": "reject",
            "title": "NO",
            "button_style": "default"
          }
        ],
        "display_in_ui": true,
        "node_id": "1775717346519",
        "node_title": "Human Input",
        "resolved_default_values": {
          "some_field": "a4959eb4-c852-4e0c-ac7a-348233f7f345"
        },
        "form_token": "0Tb1nXYe4hzQUD706nHB4y",
        "type": "human_input_required",
        "expiration_time": 1776388428
      }
    ],
    "status": "paused",
    "created_at": 1776129228,
    "elapsed_time": 0.070478,
    "total_tokens": 0,
    "total_steps": 2
  }
}
```
</CodeGroup>

</Col> </Row>

<Col> メッセージ送信時に使用するファイルをアップロードし、画像とテキストのマルチモーダル理解を可能にします。アプリケーションでサポートされている形式をサポートします。アップロードされたファイルは現在のエンドユーザーのみが使用できます。

リクエストボディ

このインターフェースはmultipart/form-dataリクエストを必要とします。

file (File) 必須アップロードするファイル。
user (string) 必須ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。サービス API は WebApp によって作成された会話を共有しません。

応答

アップロードが成功すると、サーバーはファイルの ID と関連情報を返します。

id (uuid) ID
name (string) ファイル名
size (int) ファイルサイズ（バイト）
extension (string) ファイル拡張子
mime_type (string) ファイルの MIME タイプ
created_by (uuid) エンドユーザーID
created_at (timestamp) 作成タイムスタンプ、例：1705395332

エラー

400, no_file_uploaded, ファイルが提供されなければなりません
400, too_many_files, 現在は 1 つのファイルのみ受け付けます
400, unsupported_preview, ファイルはプレビューをサポートしていません
400, unsupported_estimate, ファイルは推定をサポートしていません
413, file_too_large, ファイルが大きすぎます
415, unsupported_file_type, サポートされていない拡張子、現在はドキュメントファイルのみ受け付けます
503, s3_connection_failed, S3 サービスに接続できません
503, s3_permission_denied, S3 にファイルをアップロードする権限がありません
503, s3_file_too_large, ファイルが S3 のサイズ制限を超えています
500, 内部サーバーエラー

</Col> <Col sticky> ### リクエスト例

応答例

<CodeGroup title="応答"> ```json {{ title: '応答' }} { "id": "72fa9618-8f89-4a37-9b33-7e1178a24a67", "name": "example.png", "size": 1024, "extension": "png", "mime_type": "image/png", "created_by": "6ad1ab0a-73ff-4ac1-b9e4-cdb312f71f13", "created_at": 1577836800, } ``` </CodeGroup> </Col> </Row> ---

<Col> エンドユーザー ID からエンドユーザー情報を取得します。

他の API がエンドユーザー ID（例：ファイルアップロードの `created_by`）を返す場合に利用できます。

### パスパラメータ
- `end_user_id` (uuid) 必須
  エンドユーザー ID。

### レスポンス
EndUser オブジェクトを返します。
- `id` (uuid) ID
- `tenant_id` (uuid) テナント ID
- `app_id` (uuid) アプリ ID
- `type` (string) エンドユーザー種別
- `external_user_id` (string) 外部ユーザー ID
- `name` (string) 名前
- `is_anonymous` (boolean) 匿名ユーザーかどうか
- `session_id` (string) セッション ID
- `created_at` (string) ISO 8601 日時
- `updated_at` (string) ISO 8601 日時

### エラー
- 404, `end_user_not_found`, エンドユーザーが見つかりません
- 500, 内部サーバーエラー

</Col> <Col sticky> ### リクエスト例 <CodeGroup title="Request" tag="GET" label="/end-users/:end_user_id" targetCode={`curl -X GET '${props.appDetail.api_base_url}/end-users/6ad1ab0a-73ff-4ac1-b9e4-cdb312f71f13' \\ --header 'Authorization: Bearer {api_key}'`} />

### レスポンス例
<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "id": "6ad1ab0a-73ff-4ac1-b9e4-cdb312f71f13",
  "tenant_id": "8c0f3f3a-66b0-4b55-a0bf-8b8e0d6aee7d",
  "app_id": "6c8c3f41-2c6f-4e1b-8f4f-7f11c8f2ad2a",
  "type": "service_api",
  "external_user_id": "abc-123",
  "name": "Alice",
  "is_anonymous": false,
  "session_id": "abc-123",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}
```
</CodeGroup>

</Col> </Row> ---

<Col> アップロードされたファイルをプレビューまたはダウンロードします。このエンドポイントを使用すると、以前にファイルアップロード API でアップロードされたファイルにアクセスできます。

<i>ファイルは、リクエストしているアプリケーションのメッセージ範囲内にある場合のみアクセス可能です。</i>

### パスパラメータ
- `file_id` (string) 必須
  プレビューするファイルの一意識別子。ファイルアップロード API レスポンスから取得します。

### クエリパラメータ
- `as_attachment` (boolean) オプション
  ファイルを添付ファイルとして強制ダウンロードするかどうか。デフォルトは `false`（ブラウザでプレビュー）。

### レスポンス
ブラウザ表示またはダウンロード用の適切なヘッダー付きでファイル内容を返します。
- `Content-Type` ファイル MIME タイプに基づいて設定
- `Content-Length` ファイルサイズ（バイト、利用可能な場合）
- `Content-Disposition` `as_attachment=true` の場合は "attachment" に設定
- `Cache-Control` パフォーマンス向上のためのキャッシュヘッダー
- `Accept-Ranges` 音声/動画ファイルの場合は "bytes" に設定

### エラー
- 400, `invalid_param`, パラメータ入力異常
- 403, `file_access_denied`, ファイルアクセス拒否またはファイルが現在のアプリケーションに属していません
- 404, `file_not_found`, ファイルが見つからないか削除されています
- 500, サーバー内部エラー

</Col> <Col sticky> ### リクエスト例 <CodeGroup title="リクエスト" tag="GET" label="/files/:file_id/preview" targetCode={`curl -X GET '${props.appDetail.api_base_url}/files/72fa9618-8f89-4a37-9b33-7e1178a24a67/preview' \\ --header 'Authorization: Bearer {api_key}'`} />

### 添付ファイルとしてダウンロード
<CodeGroup
  title="ダウンロードリクエスト"
  tag="GET"
  label="/files/:file_id/preview?as_attachment=true"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/files/72fa9618-8f89-4a37-9b33-7e1178a24a67/preview?as_attachment=true' \\

--header 'Authorization: Bearer {api_key}' \ --output downloaded_file.png`} />

### レスポンスヘッダー例
<CodeGroup title="Response Headers">
```http {{ title: 'ヘッダー - 画像プレビュー' }}
Content-Type: image/png
Content-Length: 1024
Cache-Control: public, max-age=3600
```
</CodeGroup>

### ダウンロードレスポンスヘッダー
<CodeGroup title="Download Response Headers">
```http {{ title: 'ヘッダー - ファイルダウンロード' }}
Content-Type: image/png
Content-Length: 1024
Content-Disposition: attachment; filename*=UTF-8''example.png
Cache-Control: public, max-age=3600
```
</CodeGroup>

</Col> </Row>

<Col> ストリーミングモードでのみサポートされています。 ### パス - `task_id` (string) タスク ID、ストリーミングチャンクの返り値から取得できます ### リクエストボディ - `user` (string) 必須ユーザー識別子、エンドユーザーの身元を定義するために使用され、送信メッセージインターフェースで渡されたユーザーと一致している必要があります。サービス API は WebApp によって作成された会話を共有しません。 ### 応答 - `result` (string) 常に"success"を返します </Col> <Col sticky> ### リクエスト例 <CodeGroup title="リクエスト" tag="POST" label="/chat-messages/:task_id/stop" targetCode={`curl -X POST '${props.appDetail.api_base_url}/chat-messages/:task_id/stop' \\ -H 'Authorization: Bearer {api_key}' \\ -H 'Content-Type: application/json' \\ --data-raw '{ "user": "abc-123" }'`} /> ### 応答例 <CodeGroup title="応答"> ```json {{ title: '応答' }} { "result": "success" } ``` </CodeGroup> </Col> </Row>

<Col> `form_token` から保留中の Human-in-the-Loop フォームを取得します。

ストリーミングイベントで `human_input_required`（`form_token` を含む）が返された際に使用します。

### パス
- `form_token` (string) 必須、一時停止イベントで返されたフォームトークン

### 応答
- `form_content` (string) レンダリング済みフォーム内容（markdown/plain text）
- `inputs` (array[object]) 入力項目定義
- `resolved_default_values` (object) 解決済みデフォルト値（文字列）
- `user_actions` (array[object]) アクションボタン一覧
- `expiration_time` (timestamp) フォーム有効期限（Unix 秒）

### エラー
- 404, フォームが存在しない、または現在のアプリに属していない
- 412, `human_input_form_submitted`, 既に送信済み
- 412, `human_input_form_expired`, 期限切れ

</Col> <Col sticky> <CodeGroup title="リクエスト" tag="GET" label="/form/human_input/:form_token" targetCode={`curl -X GET '${props.appDetail.api_base_url}/form/human_input/{form_token}' \\ --header 'Authorization: Bearer {api_key}'`} />

<CodeGroup title="応答">
```json {{ title: '応答' }}
{
  "form_content": "最終回答を確認してください: {{#$output.answer#}}",
  "inputs": [
    {
      "label": "回答",
      "type": "text-input",
      "required": true,
      "output_variable_name": "answer"
    }
  ],
  "resolved_default_values": {
    "answer": "初期値"
  },
  "user_actions": [
    { "id": "approve", "title": "承認", "button_style": "primary" },
    { "id": "reject", "title": "却下", "button_style": "warning" }
  ],
  "expiration_time": 1735689600
}
```
</CodeGroup>

</Col> </Row>

<Col> 保留中の Human-in-the-Loop フォームを送信します。

### パス
- `form_token` (string) 必須、一時停止イベントで返されたフォームトークン

### リクエストボディ
- `inputs` (object) 必須、フォーム項目の key/value
- `action` (string) 必須、`user_actions` から選択したアクション ID
- `user` (string) 必須、エンドユーザー識別子

### 応答
成功時は空オブジェクトを返します。

### エラー
- 400, `invalid_form_data`, 送信データがフォームスキーマに一致しない
- 404, フォームが存在しない、または現在のアプリに属していない
- 412, `human_input_form_submitted`, 既に送信済み
- 412, `human_input_form_expired`, 期限切れ

</Col> <Col sticky> <CodeGroup title="リクエスト" tag="POST" label="/form/human_input/:form_token" targetCode={`curl -X POST '${props.appDetail.api_base_url}/form/human_input/{form_token}' \\ --header 'Authorization: Bearer {api_key}' \\ --header 'Content-Type: application/json' \\ --data-raw '{ "inputs": {"answer": "承認済み回答"}, "action": "approve", "user": "abc-123" }'`} />

<CodeGroup title="応答">
```json {{ title: '応答' }}
{}
```
</CodeGroup>

</Col> </Row>

<Col> Human Input フォーム送信後に、ワークフロー再開後のイベントを継続受信します。

このエンドポイントは `text/event-stream` を返し、完了までイベントを購読できます。

### パス
- `task_id` (string) 必須、workflow 実行 ID（`workflow_run_id`）

### クエリ
- `user` (string) 必須、エンドユーザー識別子
- `include_state_snapshot` (bool) 任意、`true` の場合は永続化済み状態スナップショットを先に再生してからリアルタイムイベントへ移行
- `continue_on_pause` (bool) 任意、`true` にすると `workflow_paused` イベントをまたいでもストリームを維持し、`workflow_finished` で終了します

### 応答
Server-Sent Events ストリーム（`text/event-stream`）。
主なイベントは `workflow_paused`、`node_started`、`node_finished`、`human_input_form_filled`、`human_input_form_timeout`、`workflow_finished` です。
呼び出し時点でワークフローがすでに完了している場合、このエンドポイントは完了イベントを 1 件だけ即座に返します。

</Col> <Col sticky> <CodeGroup title="リクエスト" tag="GET" label="/workflow/:task_id/events" targetCode={`curl -N -X GET '${props.appDetail.api_base_url}/workflow/{workflow_run_id}/events?user=abc-123&continue_on_pause=true' \\ --header 'Authorization: Bearer {api_key}'`} />

<CodeGroup title="応答">
```streaming {{ title: '応答' }}
event: ping

data: {"event":"workflow_started","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","data":{"id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","workflow_id":"e46514f1-c008-41ff-94b0-4f33d4b97d36","inputs":{"sys.files":[],"sys.user_id":"abc-123","sys.app_id":"d1074979-f67e-4114-8691-e35878df9a89","sys.workflow_id":"e46514f1-c008-41ff-94b0-4f33d4b97d36","sys.workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","sys.timestamp":1776087863},"created_at":1776087863,"reason":"initial"}}

data: {"event":"node_started","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","data":{"id":"b552d685-1119-4e6a-9a81-e91a23e5324b","node_id":"1775717266623","node_type":"start","title":"User Input","index":1,"predecessor_node_id":null,"inputs":null,"created_at":1776087863,"extras":{},"iteration_id":null,"loop_id":null}}

data: {"event":"node_finished","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","data":{"id":"b552d685-1119-4e6a-9a81-e91a23e5324b","node_id":"1775717266623","node_type":"start","title":"User Input","index":1,"predecessor_node_id":null,"inputs":null,"process_data":null,"outputs":null,"status":"succeeded","error":null,"elapsed_time":0.00032,"execution_metadata":null,"created_at":1776087863,"finished_at":1776087863,"files":[],"iteration_id":null,"loop_id":null}}

data: {"event":"node_started","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","data":{"id":"8d7e8e01-5159-4089-a4b6-3aa394992cc2","node_id":"1775717346519","node_type":"human-input","title":"Human Input","index":2,"predecessor_node_id":null,"inputs":null,"created_at":1776087863,"extras":{},"iteration_id":null,"loop_id":null}}

data: {"event":"node_finished","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","data":{"id":"8d7e8e01-5159-4089-a4b6-3aa394992cc2","node_id":"1775717346519","node_type":"human-input","title":"Human Input","index":2,"predecessor_node_id":null,"inputs":null,"process_data":null,"outputs":null,"status":"paused","error":null,"elapsed_time":0.007381,"execution_metadata":null,"created_at":1776087863,"finished_at":1776087863,"files":[],"iteration_id":null,"loop_id":null}}

data: {"event":"workflow_paused","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","data":{"workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","paused_nodes":["1775717346519"],"outputs":{},"reasons":[{"form_id":"019d8716-0fde-75da-8207-1458ccde76e5","form_content":"this is form 1:\n{{#$output.some_field#}}\n","inputs":[{"type":"paragraph","output_variable_name":"some_field","default":{"type":"variable","selector":["sys","workflow_run_id"],"value":""}}],"actions":[{"id":"approve","title":"YES","button_style":"default"},{"id":"reject","title":"NO","button_style":"default"}],"display_in_ui":true,"node_id":"1775717346519","node_title":"Human Input","resolved_default_values":{"some_field":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c"},"form_token":"n7hFG4ZDYdGcgZ5VDc7EGM","type":"human_input_required"}],"status":"paused","created_at":1776087863,"elapsed_time":0.0,"total_tokens":0,"total_steps":2}}

data: {"event":"workflow_started","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","workflow_id":"e46514f1-c008-41ff-94b0-4f33d4b97d36","inputs":{"sys.files":[],"sys.user_id":"abc-123","sys.app_id":"d1074979-f67e-4114-8691-e35878df9a89","sys.workflow_id":"e46514f1-c008-41ff-94b0-4f33d4b97d36","sys.workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c"},"created_at":1776087877,"reason":"resumption"}}

data: {"event":"node_started","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"8d7e8e01-5159-4089-a4b6-3aa394992cc2","node_id":"1775717346519","node_type":"human-input","title":"Human Input","index":1,"predecessor_node_id":null,"inputs":null,"inputs_truncated":false,"created_at":1776087877,"extras":{},"iteration_id":null,"loop_id":null,"agent_strategy":null}}

data: {"event":"human_input_form_filled","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"node_id":"1775717346519","node_title":"Human Input","rendered_content":"this is form 1:\nfield 1 filled!\n","action_id":"approve","action_text":"YES"}}

data: {"event":"node_finished","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"8d7e8e01-5159-4089-a4b6-3aa394992cc2","node_id":"1775717346519","node_type":"human-input","title":"Human Input","index":1,"predecessor_node_id":null,"inputs":{},"inputs_truncated":false,"process_data":{},"process_data_truncated":false,"outputs":{"some_field":"field 1 filled!","some_field_2":"from bruno with love","__action_id":"approve","__rendered_content":"this is form 1:\nfield 1 filled!\n"},"outputs_truncated":false,"status":"succeeded","error":null,"elapsed_time":0.004431,"execution_metadata":null,"created_at":1776087877,"finished_at":1776087877,"files":[],"iteration_id":null,"loop_id":null}}

data: {"event":"node_started","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"6d8fc3cb-19f7-440b-b83e-eed4e847a332","node_id":"1775717350710","node_type":"template-transform","title":"Template","index":1,"predecessor_node_id":null,"inputs":null,"inputs_truncated":false,"created_at":1776087877,"extras":{},"iteration_id":null,"loop_id":null,"agent_strategy":null}}

data: {"event":"text_chunk","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"text":"field 1 filled!","from_variable_selector":["1775717350710","output"]}}

data: {"event":"node_finished","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"6d8fc3cb-19f7-440b-b83e-eed4e847a332","node_id":"1775717350710","node_type":"template-transform","title":"Template","index":1,"predecessor_node_id":null,"inputs":{"some_field":"field 1 filled!"},"inputs_truncated":false,"process_data":{},"process_data_truncated":false,"outputs":{"output":"field 1 filled!"},"outputs_truncated":false,"status":"succeeded","error":null,"elapsed_time":0.264614,"execution_metadata":null,"created_at":1776087877,"finished_at":1776087877,"files":[],"iteration_id":null,"loop_id":null}}

data: {"event":"node_started","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"e88dec7e-aa2c-41f7-8d73-032b749e23f5","node_id":"1775717354177","node_type":"end","title":"Output","index":1,"predecessor_node_id":null,"inputs":null,"inputs_truncated":false,"created_at":1776087877,"extras":{},"iteration_id":null,"loop_id":null,"agent_strategy":null}}

data: {"event":"node_finished","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"e88dec7e-aa2c-41f7-8d73-032b749e23f5","node_id":"1775717354177","node_type":"end","title":"Output","index":1,"predecessor_node_id":null,"inputs":{"output":"field 1 filled!"},"inputs_truncated":false,"process_data":{},"process_data_truncated":false,"outputs":{"output":"field 1 filled!"},"outputs_truncated":false,"status":"succeeded","error":null,"elapsed_time":0.00003,"execution_metadata":null,"created_at":1776087877,"finished_at":1776087877,"files":[],"iteration_id":null,"loop_id":null}}

data: {"event":"workflow_finished","workflow_run_id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","task_id":"1784c3dd-20eb-4919-bd5d-a8d800b74ada","data":{"id":"5d7ef348-e1c1-4f6d-bb9b-62cc2fb2ef3c","workflow_id":"e46514f1-c008-41ff-94b0-4f33d4b97d36","status":"succeeded","outputs":{"output":"field 1 filled!"},"error":null,"elapsed_time":0.364935,"total_tokens":0,"total_steps":5,"created_by":{"id":"7932d34c-dcf4-4fba-b770-f2a9de88c0a0","user":"abc-123"},"created_at":1776087877,"finished_at":1776087877,"exceptions_count":0,"files":[]}}
```
</CodeGroup>

</Col> </Row>

<Col> エンドユーザーはフィードバックメッセージを提供でき、アプリケーション開発者が期待される出力を最適化するのを支援します。

### パス
<Properties>
  <Property name='message_id' type='string' key='message_id'>
   メッセージID
  </Property>
</Properties>

### リクエストボディ

<Properties>
  <Property name='rating' type='string' key='rating'>
    アップボートは`like`、ダウンボートは`dislike`、アップボートの取り消しは`null`
  </Property>
  <Property name='user' type='string' key='user'>
    ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。
  </Property>
  <Property name='content' type='string' key='content'>
    メッセージのフィードバックです。
  </Property>
</Properties>

### 応答
- `result` (string) 常に"success"を返します

</Col> <Col sticky>

<CodeGroup
  title="リクエスト"
  tag="POST"
  label="/messages/:message_id/feedbacks"
  targetCode={`curl -X POST '${props.appDetail.api_base_url}/messages/:message_id/feedbacks' \\

--header 'Authorization: Bearer {api_key}' \ --header 'Content-Type: application/json' \ --data-raw '{ "rating": "like", "user": "abc-123", "content": "message feedback information" }'`} />

<CodeGroup title="応答">
```json {{ title: '応答' }}
{
  "result": "success"
}
```
</CodeGroup>

</Col> </Row>

<Col> アプリのエンドユーザーからのフィードバックや「いいね」を取得します。

### クエリ
<Properties>
  <Property name='page' type='string' key='page'>
   （任意）ページ番号。デフォルト値：1
  </Property>
</Properties>

<Properties>
  <Property name='limit' type='string' key='limit'>
   （任意）1ページあたりの件数。デフォルト値：20
  </Property>
</Properties>

### レスポンス
- `data` (リスト) このアプリの「いいね」とフィードバックの一覧を返します。

</Col> <Col sticky>

<CodeGroup
  title="リクエスト"
  tag="GET"
  label="/app/feedbacks"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/app/feedbacks?page=1&limit=20' \\

--header 'Authorization: Bearer {api_key}' \ --header 'Content-Type: application/json'`} />

<CodeGroup title="Response">
```json {{ title: 'Response' }}
    {
    "data": [
        {
            "id": "8c0fbed8-e2f9-49ff-9f0e-15a35bdd0e25",
            "app_id": "f252d396-fe48-450e-94ec-e184218e7346",
            "conversation_id": "2397604b-9deb-430e-b285-4726e51fd62d",
            "message_id": "709c0b0f-0a96-4a4e-91a4-ec0889937b11",
            "rating": "like",
            "content": "message feedback information-3",
            "from_source": "user",
            "from_end_user_id": "74286412-9a1a-42c1-929c-01edb1d381d5",
            "from_account_id": null,
            "created_at": "2025-04-24T09:24:38",
            "updated_at": "2025-04-24T09:24:38"
        }
    ]
    }
```
</CodeGroup>

</Col> </Row> ---

<Col> 現在のメッセージに対する次の質問の提案を取得します

### パスパラメータ

<Properties>
  <Property name='message_id' type='string' key='message_id'>
    メッセージID
  </Property>
</Properties>

### クエリ
<Properties>
  <Property name='user' type='string' key='user'>
    ユーザー識別子、エンドユーザーの身元を定義するために使用され、統計のために使用されます。
    アプリケーション内で開発者によって一意に定義されるべきです。
  </Property>
</Properties>

</Col> <Col sticky>

<CodeGroup
  title="リクエスト"
  tag="GET"
  label="/messages/{message_id}/suggested"
  targetCode={`curl --location --request GET '${props.appDetail.api_base_url}/messages/{message_id}/suggested?user=abc-123' \\

--header 'Authorization: Bearer ENTER-YOUR-SECRET-KEY' \ --header 'Content-Type: application/json'`} />

<CodeGroup title="応答">
```json {{ title: '応答' }}
{
  "result": "success",
  "data": [
        "a",
        "b",
        "c"
    ]
}
```
</CodeGroup>

</Col> </Row>

<Col> スクロールロード形式で履歴チャット記録を返し、最初のページは最新の`{limit}`メッセージを返します。つまり、逆順です。

### クエリ

<Properties>
  <Property name='conversation_id' type='string' key='conversation_id'>
    会話ID
  </Property>
  <Property name='user' type='string' key='user'>
    ユーザー識別子、エンドユーザーの身元を定義するために使用され、統計のために使用されます。
    アプリケーション内で開発者によって一意に定義されるべきです。
  </Property>
  <Property name='first_id' type='string' key='first_id'>
      現在のページの最初のチャット記録のID、デフォルトはnullです。
  </Property>
  <Property name='limit' type='int' key='limit'>
      1回のリクエストで返すチャット履歴メッセージの数、デフォルトは20です。
  </Property>
</Properties>

### 応答
- `data` (array[object]) メッセージリスト
  - `id` (string) メッセージID
  - `conversation_id` (string) 会話ID
  - `inputs` (object) ユーザー入力パラメータ。
  - `query` (string) ユーザー入力/質問内容。
  - `message_files` (array[object]) メッセージファイル
    - `id` (string) ID
    - `type` (string) ファイルタイプ、画像の場合はimage
    - `url` (string) ファイルプレビューURL、ファイルアクセスにはファイルプレビューAPI（`/files/{file_id}/preview`）を使用して���ださい
    - `belongs_to` (string) 所属、userまたはassistant
  - `answer` (string) 応答メッセージ内容
  - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332
  - `feedback` (object) フィードバック情報
    - `rating` (string) アップボートは`like` / ダウンボートは`dislike`
  - `retriever_resources` (array[RetrieverResource]) 引用と帰属リスト
- `has_more` (bool) 次のページがあるかどうか
- `limit` (int) 返された項目数、入力がシステム制限を超える場合、システム制限数を返します

</Col> <Col sticky>

<CodeGroup
  title="リクエスト"
  tag="GET"
  label="/messages"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/messages?user=abc-123&conversation_id={conversation_id}'

--header 'Authorization: Bearer {api_key}'`} /> ### 応答例 <CodeGroup title="応答"> json {{ title: '応答' }} { "limit": 20, "has_more": false, "data": [ { "id": "a076a87f-31e5-48dc-b452-0061adbbc922", "conversation_id": "cd78daf6-f9e4-4463-9ff2-54257230a0ce", "inputs": { "name": "dify" }, "query": "iphone 13 pro", "answer": "iPhone 13 Proは2021年9月24日に発売され、6.1インチのディスプレイと1170 x 2532の解像度を備えています。Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)プロセッサ、6 GBのRAMを搭載し、128 GB、256 GB、512 GB、1 TBのストレージオプションを提供します。カメラは12 MP、バッテリー容量は3095 mAhで、iOS 15を搭載しています。", "message_files": [], "feedback": null, "retriever_resources": [ { "position": 1, "dataset_id": "101b4c97-fc2e-463c-90b1-5261a4cdcafb", "dataset_name": "iPhone", "document_id": "8dd1ad74-0b5f-4175-b735-7d98bbbb4e00", "document_name": "iPhone List", "segment_id": "ed599c7f-2766-4294-9d1d-e5235a61270a", "score": 0.98457545, "content": "\"Model\",\"Release Date\",\"Display Size\",\"Resolution\",\"Processor\",\"RAM\",\"Storage\",\"Camera\",\"Battery\",\"Operating System\"\n\"iPhone 13 Pro Max\",\"September 24, 2021\",\"6.7 inch\",\"1284 x 2778\",\"Hexa-core (2x3.23 GHz Avalanche + 4x1.82 GHz Blizzard)\",\"6 GB\",\"128, 256, 512 GB, 1TB\",\"12 MP\",\"4352 mAh\",\"iOS 15\"" } ], "created_at": 1705569239, } ] } </CodeGroup>

</Col> </Row>

<Col> 現在のユーザーの会話リストを取得し、デフォルトで最新の 20 件を返します。

### クエリ

<Properties>
  <Property name='user' type='string' key='user'>
      ユーザー識別子、エンドユーザーの身元を定義するために使用され、統計のために使用されます。
      アプリケーション内で開発者によって一意に定義されるべきです。
  </Property>
  <Property name='last_id' type='string' key='last_id'>
      (Optional)現在のページの最後の記録のID、デフォルトはnullです。
  </Property>
  <Property name='limit' type='int' key='limit'>
      (Optional)1回のリクエストで返す記録の数、デフォルトは最新の20件です。最大100、最小1。
  </Property>
  <Property name='sort_by' type='string' key='sort_by'>
    (Optional)ソートフィールド、デフォルト：-updated_at（更新時間で降順にソート）
    - 利用可能な値：created_at, -created_at, updated_at, -updated_at
    - フィールドの前の記号は順序または逆順を表し、"-"は逆順を表します。
  </Property>
</Properties>

### 応答
- `data` (array[object]) 会話のリスト
  - `id` (string) 会話ID
  - `name` (string) 会話名、デフォルトではLLMによって生成されます。
  - `inputs` (object) ユーザー入力パラメータ。
  - `introduction` (string) 紹介
  - `created_at` (timestamp) 作成タイムスタンプ、例：1705395332
  - `updated_at` (timestamp) 更新タイムスタンプ、例：1705395332
- `has_more` (bool)
- `limit` (int) 返されたエントリ数、入力がシステム制限を超える場合、システム制限数が返されます

</Col> <Col sticky>

<CodeGroup
  title="リクエスト"
  tag="GET"
  label="/conversations"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/conversations?user=abc-123&last_id=&limit=20' \\

--header 'Authorization: Bearer {api_key}'`} />

<CodeGroup title="応答">
```json {{ title: '応答' }}
{
  "limit": 20,
  "has_more": false,
  "data": [
    {
      "id": "10799fb8-64f7-4296-bbf7-b42bfbe0ae54",
      "name": "新しいチャット",
      "inputs": {
          "book": "book",
          "myName": "Lucy"
      },
      "status": "normal",
      "created_at": 1679667915,
      "updated_at": 1679667915
    },
    {
      "id": "hSIhXBhNe8X1d8Et"
      // ...
    }
  ]
}
```
</CodeGroup>

</Col> </Row>

<Col> 会話を削除します。

### パス
- `conversation_id` (string) 会話ID

### リクエストボディ

<Properties>
  <Property name='user' type='string' key='user'>
    ユーザー識別子、開発者によって定義され、アプリケーション内で一意であることを保証しなければなりません。
  </Property>
</Properties>

### 応答
- `result` (string) 常に"success"を返します

</Col> <Col sticky>

<CodeGroup
  title="リクエスト"
  tag="DELETE"
  label="/conversations/:conversation_id"
  targetCode={`curl -X DELETE '${props.appDetail.api_base_url}/conversations/{conversation_id}' \\

--header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer {api_key}' \ --data '{ "user": "abc-123" }'`} />

<CodeGroup title="応答">
```text {{ title: '応答' }}
204 No Content
```
</CodeGroup>

</Col> </Row>

<Col> ### リクエストボディセッションの名前を変更します。セッション名は、複数のセッションをサポートするクライアントでの表示に使用されます。

### パス
- `conversation_id` (string) 会話ID

<Properties>
  <Property name='name' type='string' key='name'>
    (Optional)会話の名前。`auto_generate`が`true`に設定されている場合、このパラメータは省略できます。
  </Property>
  <Property name='auto_generate' type='bool' key='auto_generate'>
    (Optional)タイトルを自動生成、デフォルトは`false`
  </Property>
  <Property name='user' type='string' key='user'>
    ユーザー識別子、開発者によって定義され、アプリケーション内で一意であることを保証しなければなりません。
  </Property>
</Properties>

### 応答
- `id` (string) 会話ID
- `name` (string) 会話名
- `inputs` (object) ユーザー入力パラメータ
- `status` (string) 会話状態
- `introduction` (string) 紹介
- `created_at` (timestamp) 作成タイムスタンプ、例：1705395332
- `updated_at` (timestamp) 更新タイムスタンプ、例：1705395332

</Col> <Col sticky>

<CodeGroup
  title="リクエスト"
  tag="POST"
  label="/conversations/:conversation_id/name"
  targetCode={`curl -X POST '${props.appDetail.api_base_url}/conversations/{conversation_id}/name' \\

--header 'Content-Type: application/json' \ --header 'Authorization: Bearer {api_key}' \ --data-raw '{ "name": "", "auto_generate": true, "user": "abc-123" }'`} />

<CodeGroup title="応答">
```json {{ title: '応答' }}
{
    "id": "cd78daf6-f9e4-4463-9ff2-54257230a0ce",
    "name": "チャット vs AI",
    "inputs": {},
    "status": "normal",
    "introduction": "",
    "created_at": 1705569238,
    "updated_at": 1705569238
}
```
</CodeGroup>

</Col> </Row>

<Col> 特定の会話から変数を取得します。このエンドポイントは、会話中に取得された構造化データを抽出するのに役立ちます。

### パスパラメータ

<Properties>
  <Property name='conversation_id' type='string' key='conversation_id'>
    変数を取得する会話のID。
  </Property>
</Properties>

### クエリパラメータ

<Properties>
  <Property name='user' type='string' key='user'>
    ユーザー識別子。開発者によって定義されたルールに従い、アプリケーション内で一意である必要があります。
  </Property>
  <Property name='last_id' type='string' key='last_id'>
      (Optional)現在のページの最後の記録のID、デフォルトはnullです。
  </Property>
  <Property name='limit' type='int' key='limit'>
      (Optional)1回のリクエストで返す記録の数、デフォルトは最新の20件です。最大100、最小1。
  </Property>
</Properties>

### レスポンス

- `limit` (int) ページごとのアイテム数
- `has_more` (bool) さらにアイテムがあるかどうか
- `data` (array[object]) 変数のリスト
  - `id` (string) 変数 ID
  - `name` (string) 変数名
  - `value_type` (string) 変数タイプ（文字列、数値、真偽値など）
  - `value` (string) 変数値
  - `description` (string) 変数の説明
  - `created_at` (int) 作成タイムスタンプ
  - `updated_at` (int) 最終更新タイムスタンプ

### エラー
- 404, `conversation_not_exists`, 会話が見つかりません

</Col> <Col sticky>

<CodeGroup
  title="リクエスト"
  tag="GET"
  label="/conversations/:conversation_id/variables"
  debug="true"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/conversations/{conversation_id}/variables?user=abc-123' \\

--header 'Authorization: Bearer {api_key}'`} />

<CodeGroup
  title="変数名フィルター付きリクエスト"
  language="bash"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/conversations/{conversation_id}/variables?user=abc-123&variable_name=customer_name' \\

--header 'Authorization: Bearer {api_key}'`} />

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "limit": 100,
  "has_more": false,
  "data": [
    {
      "id": "variable-uuid-1",
      "name": "customer_name",
      "value_type": "string",
      "value": "John Doe",
      "description": "会話から抽出された顧客名",
      "created_at": 1650000000000,
      "updated_at": 1650000000000
    },
    {
      "id": "variable-uuid-2",
      "name": "order_details",
      "value_type": "json",
      "value": "{\"product\":\"Widget\",\"quantity\":5,\"price\":19.99}",
      "description": "顧客の注文詳細",
      "created_at": 1650000000000,
      "updated_at": 1650000000000
    }
  ]
}
```
</CodeGroup>

</Col> </Row>

<Col> 特定の会話変数の値を更新します。このエンドポイントは、名前、型、説明を保持しながら、会話中にキャプチャされた変数の値を変更することを可能にします。

### パスパラメータ

<Properties>
  <Property name='conversation_id' type='string' key='conversation_id'>
    更新する変数を含む会話のID。
  </Property>
  <Property name='variable_id' type='string' key='variable_id'>
    更新する変数のID。
  </Property>
</Properties>

### リクエストボディ

<Properties>
  <Property name='value' type='any' key='value'>
    変数の新しい値。変数の期待される型（文字列、数値、オブジェクトなど）と一致する必要があります。
  </Property>
  <Property name='user' type='string' key='user'>
    ユーザー識別子。開発者によって定義されたルールに従い、アプリケーション内で一意である必要があります。
  </Property>
</Properties>

### レスポンス

以下を含む更新された変数オブジェクトを返します：
- `id` (string) 変数ID
- `name` (string) 変数名
- `value_type` (string) 変数型（文字列、数値、オブジェクトなど）
- `value` (any) 更新された変数値
- `description` (string) 変数の説明
- `created_at` (int) 作成タイムスタンプ
- `updated_at` (int) 最終更新タイムスタンプ

### エラー
- 400, `Type mismatch: variable expects {expected_type}, but got {actual_type} type`, 値の型が変数の期待される型と一致しません
- 404, `conversation_not_exists`, 会話が見つかりません
- 404, `conversation_variable_not_exists`, 変数が見つかりません

</Col> <Col sticky>

<CodeGroup
  title="リクエスト"
  tag="PUT"
  label="/conversations/:conversation_id/variables/:variable_id"
  targetCode={`curl -X PUT '${props.appDetail.api_base_url}/conversations/{conversation_id}/variables/{variable_id}' \\

--header 'Content-Type: application/json' \ --header 'Authorization: Bearer {api_key}' \ --data-raw '{ "value": "Updated Value", "user": "abc-123" }'`} />

<CodeGroup
  title="異なる値型での更新"
  targetCode={[
    {
      title: '文字列値',
      code: `curl -X PUT '${props.appDetail.api_base_url}/conversations/{conversation_id}/variables/{variable_id}' \\

--header 'Content-Type: application/json' \ --header 'Authorization: Bearer {api_key}' \ --data-raw '{ "value": "新しい文字列値", "user": "abc-123" }', }, { title: '数値', code: curl -X PUT '${props.appDetail.api_base_url}/conversations/{conversation_id}/variables/{variable_id}' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {api_key}' \ --data-raw '{ "value": 42, "user": "abc-123" }', }, { title: 'オブジェクト値', code: curl -X PUT '${props.appDetail.api_base_url}/conversations/{conversation_id}/variables/{variable_id}' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {api_key}' \ --data-raw '{ "value": {"product": "Widget", "quantity": 10, "price": 29.99}, "user": "abc-123" }'`, }, ]} />

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "id": "variable-uuid-1",
  "name": "customer_name",
  "value_type": "string",
  "value": "Updated Value",
  "description": "会話から抽出された顧客名",
  "created_at": 1650000000000,
  "updated_at": 1650000001000
}
```
</CodeGroup>

</Col> </Row>

<Col> このエンドポイントは multipart/form-data リクエストを必要とします。

### リクエストボディ

<Properties>
  <Property name='file' type='file' key='file'>
    オーディオファイル。
    サポートされている形式：`['mp3', 'mp4', 'mpeg', 'mpga', 'm4a', 'wav', 'webm']`
    ファイルサイズ制限：15MB
  </Property>
  <Property name='user' type='string' key='user'>
  ユーザー識別子、開発者のルールによって定義され、アプリケーション内で一意でなければなりません。
  </Property>
</Properties>

### 応答
- `text` (string) 出力テキスト

</Col> <Col sticky>

<CodeGroup
  title="リクエスト"
  tag="POST"
  label="/audio-to-text"
  targetCode={`curl -X POST '${props.appDetail.api_base_url}/audio-to-text' \\

--header 'Authorization: Bearer {api_key}' \ --form 'file=@localfile;type=audio/[mp3|mp4|mpeg|mpga|m4a|wav|webm]'`} />

<CodeGroup title="応答">
```json {{ title: '応答' }}
{
  "text": ""
}
```
</CodeGroup>

</Col> </Row>

<Col> テキストを音声に変換します。

### リクエストボディ

<Properties>
  <Property name='message_id' type='str' key='message_id'>
    Difyによって生成されたテキストメッセージの場合、生成されたメッセージIDを直接渡します。バックエンドはメッセージIDを使用して対応する内容を検索し、音声情報を直接合成します。message_idとtextが同時に提供される場合、message_idが優先されます。
  </Property>
  <Property name='text' type='str' key='text'>
    音声生成コンテンツ。
  </Property>
  <Property name='user' type='string' key='user'>
    ユーザー識別子、開発者によって定義され、アプリ内で一意であることを保証しなければなりません。
  </Property>
</Properties>

</Col> <Col sticky>

<CodeGroup
  title="リクエスト"
  tag="POST"
  label="/text-to-audio"
  targetCode={`curl -o text-to-audio.mp3 -X POST '${props.appDetail.api_base_url}/text-to-audio' \\

--header 'Authorization: Bearer {api_key}' \ --header 'Content-Type: application/json' \ --data-raw '{ "message_id": "5ad4cb98-f0c7-4085-b384-88c403be6290", "text": "Hello Dify", "user": "abc-123", }'`} />

<CodeGroup title="ヘッダー">
```json {{ title: 'ヘッダー' }}
{
  "Content-Type": "audio/wav"
}
```
</CodeGroup>

</Col> </Row> ---

<Col> このアプリケーションの基本情報を取得するために使用されます

Response

name (string) アプリケーションの名前
description (string) アプリケーションの説明
tags (array[string]) アプリケーションのタグ
mode (string) アプリケーションのモード
author_name (string) 作者の名前

</Col> <Col> <CodeGroup title="リクエスト" tag="GET" label="/info" targetCode={`curl -X GET '${props.appDetail.api_base_url}/info' \\ -H 'Authorization: Bearer {api_key}'`} />

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "name": "My App",
  "description": "This is my app.",
  "tags": [
    "tag1",
    "tag2"
  ],
  "mode": "advanced-chat",
  "author_name": "Dify"
}
```
</CodeGroup>

</Col> </Row>

<Col> ページに入る際に、機能、入力パラメータ名、タイプ、デフォルト値などの情報を取得するために使用されます。

### 応答
- `opening_statement` (string) 開始の挨拶
- `suggested_questions` (array[string]) 開始時の推奨質問のリスト
- `suggested_questions_after_answer` (object) 答えを有効にした後の質問を提案します。
  - `enabled` (bool) 有効かどうか
- `speech_to_text` (object) 音声からテキストへ
  - `enabled` (bool) 有効かどうか
- `text_to_speech` (object) テキストから音声へ
  - `enabled` (bool) 有効かどうか
  - `voice` (string) 音声タイプ
  - `language` (string) 言語
  - `autoPlay` (string) 自動再生
    - `enabled`  有効
    - `disabled` 無効
- `retriever_resource` (object) 引用と帰属
  - `enabled` (bool) 有効かどうか
- `annotation_reply` (object) 注釈返信
  - `enabled` (bool) 有効かどうか
- `user_input_form` (array[object]) ユーザー入力フォームの設定
  - `text-input` (object) テキスト入力コントロール
    - `label` (string) 変数表示ラベル名
    - `variable` (string) 変数ID
    - `required` (bool) 必須かどうか
    - `default` (string) デフォルト値
  - `paragraph` (object) 段落テキスト入力コントロール
    - `label` (string) 変数表示ラベル名
    - `variable` (string) 変数ID
    - `required` (bool) 必須かどうか
    - `default` (string) デフォルト値
  - `select` (object) ドロップダウンコントロール
    - `label` (string) 変数表示ラベル名
    - `variable` (string) 変数ID
    - `required` (bool) 必須かどうか
    - `default` (string) デフォルト値
    - `options` (array[string]) オプション値
- `file_upload` (object) ファイルアップロード設定
  - `document` (object) ドキュメント設定
    現在サポートされているドキュメントタイプ：`txt`, `md`, `markdown`, `pdf`, `html`, `xlsx`, `xls`, `docx`, `csv`, `eml`, `msg`, `pptx`, `ppt`, `xml`, `epub`。
    - `enabled` (bool) 有効かどうか
    - `number_limits` (int) ドキュメント数の上限。デフォルトは 3
    - `transfer_methods` (array[string]) 転送方法リスト：`remote_url`, `local_file`。いずれかを選択する必要があります。
  - `image` (object) 画像設定
    現在サポートされている画像タイプ：`png`, `jpg`, `jpeg`, `webp`, `gif`。
    - `enabled` (bool) 有効かどうか
    - `number_limits` (int) 画像数の上限。デフォルトは 3
    - `transfer_methods` (array[string]) 転送方法リスト：`remote_url`, `local_file`。いずれかを選択する必要があります。
  - `audio` (object) オーディオ設定
    現在サポートされているオーディオタイプ：`mp3`, `m4a`, `wav`, `webm`, `amr`。
    - `enabled` (bool) 有効かどうか
    - `number_limits` (int) オーディオ数の上限。デフォルトは 3
    - `transfer_methods` (array[string]) 転送方法リスト：`remote_url`, `local_file`。いずれかを選択する必要があります。
  - `video` (object) ビデオ設定
    現在サポートされているビデオタイプ：`mp4`, `mov`, `mpeg`, `mpga`。
    - `enabled` (bool) 有効かどうか
    - `number_limits` (int) ビデオ数の上限。デフォルトは 3
    - `transfer_methods` (array[string]) 転送方法リスト：`remote_url`, `local_file`。いずれかを選択する必要があります。
  - `custom` (object) カスタム設定
    - `enabled` (bool) 有効かどうか
    - `number_limits` (int) カスタム数の上限。デフォルトは 3
    - `transfer_methods` (array[string]) 転送方法リスト：`remote_url`, `local_file`。いずれかを選択する必要があります。
- `system_parameters` (object) システムパラメータ
  - `file_size_limit` (int) ドキュメントアップロードサイズ制限（MB）
  - `image_file_size_limit` (int) 画像ファイルアップロードサイズ制限（MB）
  - `audio_file_size_limit` (int) オーディオファイルアップロードサイズ制限（MB）
  - `video_file_size_limit` (int) ビデオファイルアップロードサイズ制限（MB）

</Col> <Col sticky>

<CodeGroup
  title="リクエスト"
  tag="GET"
  label="/parameters"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/parameters'`}
/>

<CodeGroup title="応答">
```json {{ title: '応答' }}
{
  "opening_statement": "こんにちは！",
  "suggested_questions_after_answer": {
      "enabled": true
  },
  "speech_to_text": {
      "enabled": true
  },
  "text_to_speech": {
      "enabled": true,
      "voice": "sambert-zhinan-v1",
      "language": "zh-Hans",
      "autoPlay": "disabled"
  },
  "retriever_resource": {
      "enabled": true
  },
  "annotation_reply": {
      "enabled": true
  },
  "user_input_form": [
      {
          "paragraph": {
              "label": "クエリ",
              "variable": "query",
              "required": true,
              "default": ""
          }
      }
  ],
  "file_upload": {
      "image": {
          "enabled": false,
          "number_limits": 3,
          "detail": "high",
          "transfer_methods": [
              "remote_url",
              "local_file"
          ]
      }
  },
  "system_parameters": {
      "file_size_limit": 15,
      "image_file_size_limit": 10,
      "audio_file_size_limit": 50,
      "video_file_size_limit": 100
  }
}
```
</CodeGroup>

</Col> </Row> ---

<Col> このアプリケーションのツールのアイコンを取得するために使用されます

応答

tool_icons(object[string]) ツールアイコン
- tool_name (string)
  - icon (object|string)
    - (object) アイコンオブジェクト
      - background (string) 背景色（16 進数形式）
      - content(string) 絵文字
    - (string) アイコンの URL

</Col> <Col>

<CodeGroup
  title="リクエスト"
  tag="GET"
  label="/meta"
  targetCode={`curl -X GET '${props.appDetail.api_base_url}/meta' \\

-H 'Authorization: Bearer {api_key}'`} />

<CodeGroup title="応答">
```json {{ title: '応答' }}
{
  "tool_icons": {
    "dalle2": "https://cloud.dify.ai/console/api/workspaces/current/tool-provider/builtin/dalle/icon",
    "api_tool": {
      "background": "#252525",
      "content": "\ud83d\ude01"
    }
  }
}
```
</CodeGroup>

</Col> </Row>

<Col> アプリの WebApp 設定を取得するために使用します。 ### 応答 - `title` (string) WebApp 名 - `chat_color_theme` (string) チャットの色テーマ、16 進数形式 - `chat_color_theme_inverted` (bool) チャットの色テーマを反転するかどうか - `icon_type` (string) アイコンタイプ、`emoji`-絵文字、`image`-画像 - `icon` (string) アイコン。`emoji`タイプの場合は絵文字、`image`タイプの場合は画像 URL - `icon_background` (string) 16 進数形式の背景色 - `icon_url` (string) アイコンの URL - `description` (string) 説明 - `copyright` (string) 著作権情報 - `privacy_policy` (string) プライバシーポリシーのリンク - `custom_disclaimer` (string) カスタム免責事項 - `default_language` (string) デフォルト言語 - `show_workflow_steps` (bool) ワークフローの詳細を表示するかどうか - `use_icon_as_answer_icon` (bool) WebApp のアイコンをチャット内の🤖に置き換えるかどうか </Col> <Col> <CodeGroup title="リクエスト" tag="GET" label="/site" targetCode={`curl -X GET '${props.appDetail.api_base_url}/site' \\ -H 'Authorization: Bearer {api_key}'`} />

<CodeGroup title="Response">
```json {{ title: 'Response' }}
{
  "title": "My App",
  "chat_color_theme": "#ff4a4a",
  "chat_color_theme_inverted": false,
  "icon_type": "emoji",
  "icon": "😄",
  "icon_background": "#FFEAD5",
  "icon_url": null,
  "description": "This is my app.",
  "copyright": "all rights reserved",
  "privacy_policy": "",
  "custom_disclaimer": "All generated by AI",
  "default_language": "en-US",
  "show_workflow_steps": false,
  "use_icon_as_answer_icon": false,
}
```
</CodeGroup>

</Col> </Row> ___