> ## 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.

# Agent API

> ストリーミングチャットメッセージ、会話管理、ファイルアップロード、アプリ設定を扱う Agent アプリ向けの API

> [!NOTE]
>
> ここでの Agent は、新しい Agent アプリタイプ（`agent` モード）を指します。レガシー Agent アプリ（`agent-chat`）は [Chatbotとレガシー Agent](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/guides/chat.md) で扱います。

[Agent アプリ](https://enterprise-docs.dify.ai/ja/3.13.x/use/build/new-agent/overview.md) は `agent` モードで動作します。メッセージを送信し、生成中の回答をストリーミングで受け取り、会話でマルチターンの文脈を保持します。

モデルは自律的に推論しツールを呼び出し、その過程もストリームに現れます。回答テキストは `agent_message` イベントとして順次届き、各推論ステップとツール呼び出しは `agent_thought` イベントとして並行して届きます。

ターンの最後には、完全な回答を含む `message` イベントが 1 つ届き、続いて `message_end` が届きます。ライブ表示には `agent_message` の差分を使い、最後の `message` は追加のテキストではなく最終回答として扱ってください。

各 `agent_thought` イベントには、そのステップの `thought`、呼び出した `tool` とその `tool_input`、ツールの `observation` が含まれます。ストリーム全体の構造は [チャットメッセージを送信](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/chat-messages/send-chat-message.md) を参照してください。

> [!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)**：Agent アプリに質問を送信します。ストリーミングモードのみに対応し、ブロッキングモードを指定すると 400 `bad_request` が返されます。

  返信テキストは `agent_message` の差分イベントとして届きます。おおよそ 0.5 秒ごとにまとめて送信され、トークン単位ではありません。

  最後の `message_end` イベントは token 使用量を報告します。ナレッジ検索の引用（`retriever_resources`）は含まれません。

  1 回の実行には 2 種類の上限があり、どちらに達してもストリームは `agent_run_limit_exceeded` エラーコードで終了します：

  * **実行時間**：1 回の実行は、デフォルトで 1 時間後に停止されます。より長く実行するには、`APP_MAX_EXECUTION_TIME`、`WORKFLOW_MAX_EXECUTION_TIME`、`DIFY_AGENT_RUN_TIMEOUT_SECONDS` をいずれも目標の実行時間より高く設定します。これらの変数の詳細は [環境変数](https://enterprise-docs.dify.ai/ja/3.13.x/deploy/advanced-configuration/environment-variables.md) を参照してください。
  * **モデルリクエスト数**：500 回まで。

* **[チャットメッセージの生成を停止](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 に適しています。各メッセージの `agent_thoughts` 配列には、そのターンの推論ステップが含まれます。
* **[会話の名前を変更](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/files/upload-file.md)**：画像、ドキュメント、音声、動画ファイルをアップロードします。ファイルはアップロードしたエンドユーザーのみが利用できます。

  [チャットメッセージを送信](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/chat-messages/send-chat-message.md) に渡したファイルは、ダウンロード可能な参照として Agent に渡され、Agent はサンドボックス内で取得して確認できます。

* **[エンドユーザー取得](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)**：返信を音声として合成します。

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

* **[アプリケーションの基本情報を取得](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)**：アプリの設定メタデータを返します。Agent アプリでは `tool_icons` は空です。
* **[アプリの Web アプリ設定を取得](https://enterprise-docs.dify.ai/ja/3.13.x/develop/api/applications/get-app-webapp-settings.md)**：Web アプリのサイト設定、テーマ、カスタマイズ項目を返します。


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