> ## Documentation Index
> Fetch the complete documentation index at: https://enterprise-docs.dify.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Chatflow アプリ API

> チャットメッセージ、ワークフローレベルのストリーミング、会話管理、人間の入力の一時停止を扱う Chatflow アプリ向けの API

[Chatflow アプリ](https://enterprise-docs.dify.ai/ja/3.13.x/use/build/workflow-chatflow.md) は `advanced-chat` モードで動作します。返信とあわせて、ワークフローレベルのイベント（ノードの開始、完了、イテレーション、一時停止）をストリーミングします。それまでの会話内容はコンテキストとして保持され、後のメッセージから参照できます。

> [!NOTE]
>
> 認証、ベース URL、エンドユーザーごとにデータを区分する `user` フィールドについては、[クイックスタート](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/guides/get-started.md) と [エンドユーザーの識別](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/guides/end-user-identity.md) を参照してください。

## メッセージの送信とストリーミング返信

* **[チャットメッセージを送信](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/chat-messages/send-chat-message.md)**：Chatflow アプリに質問を送信します。ストリーミングモードでは、回答テキストとあわせてワークフローイベントとノードイベントが届きます。ブロッキングモードでは、実行が完了してから結果を返します。
* **[チャットメッセージの生成を停止](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/chat-messages/stop-chat-message-generation.md)**：ストリーミング中の返信を完了前に中断します。
* **[次の推奨質問を取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/chat-messages/get-next-suggested-questions.md)**：返信の完了後に、それまでの会話内容をもとに次の質問を提案します。

## 会話の管理

* **[会話一覧を取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/conversations/list-conversations.md)**：現在のユーザーの会話を、最終アクティビティの新しい順に返します。
* **[会話履歴メッセージ一覧を取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/conversations/list-conversation-messages.md)**：1 つの会話のメッセージ履歴を返します。スクロール表示のチャット UI に適しています。
* **[会話の名前を変更](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/conversations/rename-conversation.md)**：表示名を設定または自動生成します。
* **[会話を削除](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/conversations/delete-conversation.md)**：会話を削除します。
* **[会話変数一覧を取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/conversations/list-conversation-variables.md)**：セッションが複数ターンにわたって保持する値を読み取ります。
* **[会話変数を更新](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/conversations/update-conversation-variable.md)**：指定した変数の値を直接変更します。

## ファイルの操作

* **[ファイルをアップロード](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/files/upload-file.md)**：画像、ドキュメント、音声、動画ファイルをアップロードし、[チャットメッセージを送信](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/chat-messages/send-chat-message.md) から参照できるようにします。ファイルはアップロードしたエンドユーザーのみが利用できます。
* **[ファイルをダウンロード](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/files/download-file.md)**：アップロード済みファイルをプレビューまたはダウンロードします。対象はアプリ内のメッセージに紐づくファイルに限られます。
* **[エンドユーザー取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/end-users/get-end-user-info.md)**：エンドユーザー ID（ファイルアップロードのレスポンスにある `created_by` など）から、そのユーザーの詳細を取得します。

## 音声とテキストの相互変換

* **[音声をテキストに変換](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/audio/convert-audio-to-text.md)**：アップロードされた音声ファイル（MP3、M4A、WAV、AMR、MPGA のいずれか、最大 30 MB）を文字起こしします。エンドユーザーはタイピングの代わりに音声で入力できます。
* **[テキストを音声に変換](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/audio/convert-text-to-audio.md)**：返信を音声として合成します。

## 人間の入力による一時停止

配信方法に Web アプリを指定した [人間の入力](https://enterprise-docs.dify.ai/ja/3.13.x/use/nodes/human-input) ノードに実行が到達したら、API で一時停止を完了させます。

**1. 一時停止の検知**

イベントストリームが `form_token` と実行の `workflow_run_id` を含む `human_input_required` を発行します。その後、ストリームは `workflow_paused` イベントで終了します。

**2. フォームの取得**

`form_token` を使い、[人間の入力フォームを取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/human-input/get-human-input-form.md) でフォームの内容を読み込みます。

**3. 回答の送信**

[人間の入力フォームを送信](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/human-input/submit-human-input-form.md) で受信者の入力内容を送信します。送信すると実行が再開します。

**4. ストリームの再開**

一時停止したストリームの `workflow_run_id` を使い、[ワークフローイベントをストリーム](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/workflow-runs/stream-workflow-events.md) で新しいストリームを開きます。最終回答までの残りのイベントを追跡します。

ファイルを添付した送信と完全なイベントシーケンスについては、[人間の入力フロー](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/guides/human-input-flow.md) ガイドを参照してください。

## ワークフロー実行の確認

* **[ワークフロー実行詳細を取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/workflow-runs/get-workflow-run-detail.md)**：`workflow_run_id` を指定して、実行のステータスと出力を取得します。この ID は、チャット返信とあわせてストリーミングされるワークフローイベントとノードイベントに含まれます。
* **[ワークフローログ一覧を取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/workflow-runs/list-workflow-logs.md)**：ステータス、token 使用量、ステップ数、所要時間を含む実行単位のサマリーを返します。ノード単位の実行ログではありません。

## アプリ情報と設定の取得

* **[アプリケーションの基本情報を取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/applications/get-app-info.md)**：アプリの名前、説明、タグ、モードを返します。
* **[アプリケーションのパラメータ情報を取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/applications/get-app-parameters.md)**：呼び出し時に `inputs` で送るフィールド（名前、型、デフォルト値）と、アプリの機能スイッチを返します。リクエストやクライアント UI を構築する際の基礎になります。
* **[アプリケーションのメタ情報を取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/applications/get-app-meta.md)**：ツールアイコンなどの設定メタデータを返します。
* **[アプリの Web アプリ設定を取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/applications/get-app-webapp-settings.md)**：Web アプリのサイト設定、テーマ、カスタマイズ項目を返します。

## フィードバックとアノテーションの収集

* **[メッセージフィードバックを送信](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/feedback/submit-message-feedback.md)**：エンドユーザーが返信を `like` または `dislike` で評価します。任意でコメントも付けられます。
* **[アプリのフィードバック一覧を取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/feedback/list-app-feedbacks.md)**：エンドユーザーと管理者の両方から寄せられた、アプリ全体のフィードバックをすべて返します。

アノテーションは質問と固定回答をペアにします。一致した場合、アプリは新しい回答を生成せず、固定回答をそのまま返します。

* **[アノテーションを作成](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/annotations/create-annotation.md)**、**[アノテーションリストを取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/annotations/list-annotations.md)**、**[アノテーションを更新](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/annotations/update-annotation.md)**、**[アノテーションを削除](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/annotations/delete-annotation.md)**：アノテーション一式を管理します。
* **[アノテーション返信を設定](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/annotations/configure-annotation-reply.md)**：アノテーションマッチングのオンとオフを切り替えます。変更は非同期で実行されます。
* **[アノテーション返信の初期設定タスクステータスを取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/annotations/get-annotation-reply-job-status.md)**：返されたジョブ ID でポーリングし、変更の完了を確認します。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.