> ## Documentation Index > Fetch the complete documentation index at: https://docs.dify.ai/llms.txt > Use this file to discover all available pages before exploring further. # クエリを実行 > [クエリトークンを作成](/ja/api-reference/queries/create-query-token) でトークンを発行したクエリを実行し、回答を Server-Sent Events としてストリーミングで返します。認証情報はナレッジベースの API キーではなく、クエリトークンです。トークンはリクエストの受け付け時に検証されます。 2 回の呼び出しの流れとストリームの読み方については、[ナレッジベースへのクエリ](/ja/api-reference/guides/knowledge-base#query-the-knowledge-base) を参照してください。 再試行すべきエラーとエラー詳細の意味については、[エラーの処理](/ja/api-reference/guides/knowledge-base#handle-errors) を参照してください。 クエリが成功すると、`answer.done` を送信する前にクエリ記録が保存されます。同じ呼び出しを繰り返すと、クエリはもう一度実行されます。 ## OpenAPI ````yaml /ja/api-reference/openapi_service.json post /knowledge-fs/query-stream openapi: 3.0.1 info: description: >- Dify アプリケーションとナレッジベースのための REST API です。アプリケーション系エンドポイントはアプリの API キーで、ナレッジ系エンドポイントはナレッジベースの API キーで認証します。 title: Dify サービス API version: 1.0.0 servers: - description: Dify サービス API のベース URL です。セルフホスト環境では、独自の API ベース URL に置き換えてください。 url: https://{api_base_url} variables: api_base_url: default: api.dify.ai/v1 description: API ベース URL のホストとパス（`https://` を除く）。 security: - ApiKeyAuth: [] tags: - description: チャットメッセージとインタラクションに関連する操作です。 name: チャットメッセージ - description: ファイルのアップロードとプレビューの操作です。 name: ファイル操作 - description: エンドユーザー情報に関連する操作です。 name: エンドユーザー - description: ユーザーフィードバックの操作です。 name: メッセージフィードバック - description: 会話管理に関連する操作です。 name: 会話管理 - description: テキスト読み上げと音声認識の操作です。 name: 音声・テキスト変換 - description: アプリケーション設定と情報を取得する操作です。 name: アプリケーション設定 - description: ダイレクト返信用のアノテーション管理に関連する操作です。 name: アノテーション管理 - description: 人間の入力を要する一時停止中のワークフローの再開操作です。 name: 人間の入力 - description: ワークフローの実行と管理のための操作です。 name: ワークフロー実行 - description: テキスト生成に関連する操作です。 name: 完了メッセージ - description: ナレッジベースの作成、設定、取得を含むナレッジベース管理の操作です。 name: ナレッジベース - description: ナレッジベース内のドキュメントの作成、更新、管理のための操作です。 name: ドキュメント - description: ドキュメントチャンクと子チャンクの管理のための操作です。 name: チャンク - description: ナレッジベースのメタデータフィールドとドキュメントメタデータ値の管理のための操作です。 name: メタデータ - description: ナレッジベースタグとタグバインディングの管理のための操作です。 name: タグ管理 - description: 利用可能なモデルを取得するための操作です。 name: モデル - description: データソースプラグインとパイプライン実行を含むナレッジパイプラインの管理と実行のための操作です。 name: ナレッジパイプライン - description: ナレッジベースに質問し、回答をストリーミングで受け取ります。 name: クエリ - description: クエリが何を検索したか、またその理由を確認します。 name: クエリ記録 - description: リサーチの質問をバックグラウンドで実行し、その結果を取得します。 name: リサーチタスク - description: ナレッジベースのドキュメントと、そのファイル、リビジョン、チャンクを読み取り、ドキュメントにメタデータのラベルを付けます。 name: ドキュメントとチャンク - description: インデックス処理の追跡、キャンセル、再試行と、ナレッジベースのバックグラウンドタスクの一覧表示を行います。 name: インデックスタスク - description: ドキュメントファイル、ファイルのバッチ、またはソースの削除を、完了するまで追跡します。 name: 削除ジョブ - description: ナレッジベースにデータを供給するソース、その同期スケジュール、接続を管理します。 name: ソース - description: ソースの即時同期、ウェブサイトのページまたはプロバイダーのアイテムのインポート、実行の追跡、キャンセル、再試行を行います。 name: ソースの同期とインポート - description: ナレッジベースのモデルと検索設定の読み取りと変更、および変更によって始まる移行の追跡を行います。 name: 設定 paths: /knowledge-fs/query-stream: post: tags: - Queries summary: クエリを実行 description: >- [クエリトークンを作成](/ja/api-reference/queries/create-query-token) でトークンを発行したクエリを実行し、回答を Server-Sent Events としてストリーミングで返します。認証情報はナレッジベースの API キーではなく、クエリトークンです。トークンはリクエストの受け付け時に検証されます。 2 回の呼び出しの流れとストリームの読み方については、[ナレッジベースへのクエリ](/ja/api-reference/guides/knowledge-base#query-the-knowledge-base) を参照してください。 再試行すべきエラーとエラー詳細の意味については、[エラーの処理](/ja/api-reference/guides/knowledge-base#handle-errors) を参照してください。 クエリが成功すると、`answer.done` を送信する前にクエリ記録が保存されます。同じ呼び出しを繰り返すと、クエリはもう一度実行されます。 operationId: runQuery parameters: - description: >- [クエリトークンを作成](/ja/api-reference/queries/create-query-token) のレスポンスに含まれる `trace_id` です。トークンの `trace_id` クレームと同じ値です。トークンと一致しない値は `403` で拒否されます。[ナレッジベースへのクエリ](/ja/api-reference/guides/knowledge-base#query-the-knowledge-base) を参照してください。 in: header name: X-Trace-ID required: true schema: type: string requestBody: content: application/json: examples: request: summary: リクエスト例 - 新しいセッション value: activeDocumentIds: [] activeEntityIds: [] knowledgeSpaceId: 8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f mode: fast query: What changed in the refund policy this quarter? request_session: summary: リクエスト例 - セッション ID あり value: activeDocumentIds: [] activeEntityIds: [] knowledgeSpaceId: 8d2c6a1e-5b3f-4c7d-9e01-2a3b4c5d6e7f mode: fast query: What is the refund window for monthly plans? sessionId: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d schema: additionalProperties: false description: 空白のみではない `query` を指定してください。 properties: activeDocumentIds: description: >- 返された `request` オブジェクトからコピーした値です。これらの ID は、検索されたコンテンツの絞り込みにも順位付けにも使われません。 items: format: uuid type: string maxItems: 100 type: array activeEntityIds: description: >- 返された `request` オブジェクトからコピーした値です。これらの ID は、検索されたコンテンツの絞り込みにも順位付けにも使われません。 items: maxLength: 200 minLength: 1 type: string maxItems: 100 type: array knowledgeSpaceId: description: >- ナレッジベースの内部 ID です。[クエリトークンを作成](/ja/api-reference/queries/create-query-token) の `request` オブジェクトからコピーします。トークンと一致している必要があり、一致しない場合は `403` で拒否されます。 format: uuid minLength: 1 type: string mode: description: >- 検索の深度です。[クエリトークンを作成](/ja/api-reference/queries/create-query-token) の `request` オブジェクトからコピーします。`null` も指定でき、その場合はナレッジベースのデフォルトの深度を意味します。 enum: - fast - deep - research - null nullable: true type: string query: description: 質問です。空白のみではないクエリを指定してください。また、UTF-8 で 16,384 バイトまでに制限されます。 maxLength: 16000 nullable: false pattern: \S type: string sessionId: description: >- セッション ID です。[クエリトークンを作成](/ja/api-reference/queries/create-query-token) の `request` オブジェクトからコピーします。 format: uuid nullable: true type: string required: - knowledgeSpaceId - query type: object description: >- [クエリトークンを作成](/ja/api-reference/queries/create-query-token) の `request` オブジェクトを変更せずに送信してください。不明なフィールドが含まれていると `400` が返ります。 nullable と記されたオプションフィールドでは、`null` は省略と同じ扱いになります。 正規化後のリクエストは、UTF-8 で 65,536 バイト以内に収める必要があります。超えると `413` が返ります。[リクエストサイズの制限](/ja/api-reference/guides/knowledge-base#request-size-limits) を参照してください。 required: true responses: '200': content: text/event-stream: schema: description: >- 各フレームには、イベント名を示す `event:` 行と、JSON オブジェクトを 1 つ含む `data:` 行があります。イベントの振り分けには `event:` 行を使ってください。JSON には `event` フィールドが含まれません。 クライアントの読み取りタイムアウトは、使用する検索モードのうち最も遅いものに合わせて設定してください。API 側には読み取りタイムアウトがなく、キープアライブのイベントも送信しません。クライアントがタイムアウトしても処理を続ける必要がある場合は、[リサーチタスクを作成](/ja/api-reference/research-tasks/create-research-task) を使用してください。 ストリーミングの流れについては、[ナレッジベースへのクエリ](/ja/api-reference/guides/knowledge-base#query-the-knowledge-base) を参照してください。 **イベント** - `answer.delta`：回答の断片を 1 つ届けます。 - `delta`：追加するテキストです。 - `traceId`：クエリ記録 ID です。 - `answer.done`：回答が完了し、クエリ記録が保存されたことを示します。 - `finishReason`：チャンクが見つかった場合は `retrieval-evidence`、何も一致しなかった場合は `no-retrieval-evidence` です。 - `metadata`：キーが固定されていないマップです。`fast`、`deep`、`research` のいずれの深度でも `mode` と `evidenceBundle` を含み、`retrieval-evidence` の場合は `citations` を含みます。そのほか、実行で生成されたキーも含まれます。`evidenceBundle.items` には、検索されたチャンクがテキストとスコアとともに格納されます。 後から確認するには、[クエリのチャンク一覧を取得](/ja/api-reference/query-records/list-query-chunks) を呼び出します。チャンクをページ単位で返し、実行後にドキュメントが削除されたチャンクにはその旨を示します。 - `traceId`：クエリ記録 ID です。 - `answer.error`：ストリームの開始後にクエリが失敗したことを示します。 - `code`：失敗の種類で、次のいずれかです。 - `RETRIEVAL_EXECUTION_LEASE_LOST`：ナレッジベースの削除が始まったか、実行が期限切れになりました。クエリを再実行してください。 - `KNOWLEDGE_FS_UNAVAILABLE`：回答の生成中またはクエリ記録の保存中に発生した、その他の失敗です。 - `error`：メッセージです。 - `failure`：エラー詳細です。`category`、`code`、`message`、`retryPolicy`、`stage`、`traceId`、および任意で `action` を含みます。 - `stage`：常に `query_generation` です。 - `traceId`：クエリ記録 ID です。 **`citations`** 回答を裏付ける、検索されたチャンクごとに 1 つのエントリがあります。 - `nodeId`：チャンク ID です。 - `label`：`node:` です。 - `documentAssetId`：チャンクの取得元のドキュメントファイルです。 - `sectionPath`：アウトライン上のパスです。 - `pageNumber`：ソースがページ情報を提供する場合のページ番号で、1 から始まります。それ以外の場合は省略されます。 - `projectionIds`：この一致に寄与した検索インデックスの ID です。元のファイルの特定には `documentAssetId` を使用してください。 - `sources`：チャンクを見つけた検索の種類（`dense`、`fts`、`pageindex`、`visual`）です。 画像の引用には `multimodalCandidate.assetRef.analysisUnavailable.reason` が含まれることがあります。これが含まれる場合、リソースの制限または画像処理の失敗により、画像の解析はスキップされています。その場合でも、関連するテキストは結果に寄与できます。 `evidenceBundle.items[].citations[]` には `startOffset` と `endOffset` が含まれることもあります。これらは解析済みドキュメントテキスト内の 0 始まりの UTF-8 バイトオフセットで、開始位置を含み、終了位置を含みません。引用の表示には返されたチャンクテキストを使用し、元のファイルをこのオフセットで切り出さないでください。 **結果別の終了シーケンス** - 成功：0 個以上の `answer.delta` の後に `answer.done` が 1 つ届き、ストリームが閉じます。 - 失敗：`answer.done` の代わりに `answer.error` が届き、ストリームが閉じます。その前に一部の断片がすでに配信されている場合があり、HTTP ステータスは `200` のままです。これを最終結果として扱い、やり直す場合は新しいクエリを開始してください。 - クライアントの切断：実行はキャンセルされ、ストリームが終了します。 **回答の内容**：`fast` と `deep` では、検索されたチャンクのダイジェストが 1 つの `answer.delta` で届きます（`Retrieval evidence answer:` に続けて、番号付きのセクションパスとそのテキスト）。`research` では、統合された回答が 1 つ以上の断片としてストリーミングで返されます。何も一致しなかった場合、断片は `I could not find evidence for that query in the indexed retrieval projections.` の 1 つだけで、`finishReason` は `no-retrieval-evidence` になります。 回答はどの深度でも 2,000 文字が上限です。回答がこの長さに達していても、切り詰められたかどうかは判断できません。 成功した実行の例： ```text event: answer.delta data: {"delta":"Retrieval evidence answer:\n1. Policies / Refunds: Refund window extended from 14 to 30 days for annual plans.","traceId":"6c1f0b2e-9d3a-4f5b-8c7d-0e1f2a3b4c5d"} event: answer.done data: {"finishReason":"retrieval-evidence","metadata":{"mode":"fast","generator":"hybrid-query","topScore":0.83,"citations":[{"documentAssetId":"b3f4c8d2-6a1e-4f7b-9c0d-2e3f4a5b6c7d","label":"node:9f2e6b41-7c3d-4a58-b0e9-1d2c3f4a5b6e","nodeId":"9f2e6b41-7c3d-4a58-b0e9-1d2c3f4a5b6e","pageNumber":4,"projectionIds":["c7a0d5b2-3e14-4f89-a6b7-0c1d2e3f4a5b"],"sectionPath":["Policies","Refunds"],"sources":["dense","fts"]}],"evidenceBundle":{"createdAt":"2026-09-06T08:31:12Z","id":"e4b2f7a0-1c3d-4e58-9f6a-0b1c2d3e4f5a","items":[{"citations":[{"documentAssetId":"b3f4c8d2-6a1e-4f7b-9c0d-2e3f4a5b6c7d","documentVersion":1,"pageNumber":4,"sectionPath":["Policies","Refunds"]}],"conflicts":[],"freshness":{"status":"fresh"},"metadata":{},"nodeId":"9f2e6b41-7c3d-4a58-b0e9-1d2c3f4a5b6e","score":0.83,"scores":{"final":0.83,"retrieval":0.71},"text":"Refund window extended from 14 to 30 days for annual plans."}],"missingEvidence":[],"query":"What changed in the refund policy this quarter?","state":"answerable","traceId":"6c1f0b2e-9d3a-4f5b-8c7d-0e1f2a3b4c5d"}},"traceId":"6c1f0b2e-9d3a-4f5b-8c7d-0e1f2a3b4c5d"} ``` ストリームの開始後に失敗した例： ```text event: answer.error data: {"code":"KNOWLEDGE_FS_UNAVAILABLE","error":"Agent Knowledge Base is temporarily unavailable. Try again later.","failure":{"action":"retry","category":"dependency","code":"KNOWLEDGE_FS_UNAVAILABLE","message":"Agent Knowledge Base is temporarily unavailable. Try again later.","retryPolicy":"manual","stage":"query_generation","traceId":"6c1f0b2e-9d3a-4f5b-8c7d-0e1f2a3b4c5d"},"traceId":"6c1f0b2e-9d3a-4f5b-8c7d-0e1f2a3b4c5d"} ``` type: string description: >- ストリームが開きました。リクエストの `Accept` にかかわらず、イベントは `text/event-stream` として続きます。ストリームが開く前の失敗は、HTTP エラーとして処理してください。開いた後は、HTTP ステータスが `200` であっても `answer.error` イベントを失敗として処理してください。 headers: x-query-run-id: description: >- クエリ記録 ID（UUID）です。[クエリ記録を取得](/ja/api-reference/query-records/get-query-record) で使用します。同じ値が、すべてのイベントの `traceId` と、[クエリ記録一覧を取得](/ja/api-reference/query-records/list-query-records) での記録の `id` になります。ストリームが開く前に失敗した場合、実行 ID は含まれません。 schema: type: string x-session-id: description: >- クエリセッション ID（UUID）です。送信した `sessionId`、またはこのクエリで開始された新しいセッションの ID です。セッションを再利用するには、後続の [クエリトークンを作成](/ja/api-reference/queries/create-query-token) でこの値を `sessionId` として送信します。 schema: type: string '400': content: application/json: examples: KNOWLEDGE_FS_INVALID_REQUEST: summary: KNOWLEDGE_FS_INVALID_REQUEST value: code: KNOWLEDGE_FS_INVALID_REQUEST error: The Agent Knowledge Base request is invalid. failure: category: validation code: KNOWLEDGE_FS_INVALID_REQUEST message: The Agent Knowledge Base request is invalid. retryPolicy: never traceId: 3f1e9a7c-2b4d-4e6f-8a90-1b2c3d4e5f60 RETRIEVAL_PROFILE_SCORE_THRESHOLD_REQUIRES_RERANK: summary: RETRIEVAL_PROFILE_SCORE_THRESHOLD_REQUIRES_RERANK value: code: RETRIEVAL_PROFILE_SCORE_THRESHOLD_REQUIRES_RERANK error: The Agent Knowledge Base request is invalid. failure: category: validation code: KNOWLEDGE_FS_INVALID_REQUEST message: The Agent Knowledge Base request is invalid. retryPolicy: never traceId: 3f1e9a7c-2b4d-4e6f-8a90-1b2c3d4e5f60 mode: fast knowledge_fs_invalid_request: summary: knowledge_fs_invalid_request (X-Trace-ID) value: code: knowledge_fs_invalid_request message: Agent Knowledge Base request is invalid. status: 400 knowledge_fs_invalid_request_body: summary: knowledge_fs_invalid_request (body validation) value: code: knowledge_fs_invalid_request message: Agent Knowledge Base request is invalid. status: 400 violations: - field: - knowledgeSpaceId type: missing description: >- Dify が返す標準エラーボディ： - `knowledge_fs_invalid_request`：`X-Trace-ID` がないか、255 バイトを超えているか、NUL、CR、LF のいずれかの文字を含んでいます。このボディにはフィールドの詳細は含まれません。 - `knowledge_fs_invalid_request`：ボディに不明なキーが含まれているか、`knowledgeSpaceId` がないか、[クエリトークンを作成](/ja/api-reference/queries/create-query-token) のルールに違反しています。`violations` には、問題のあるフィールドがそれぞれ示されます。 クエリの実行中に発生するエラー（`error`、`code`、`failure` 内のエラー詳細）： - `KNOWLEDGE_FS_INVALID_REQUEST`：ボディがサービス側の検証に通りませんでした。`sessionId` または `activeDocumentIds` のエントリが UUID ではないか、`activeEntityIds` のエントリが 1〜200 文字の範囲外です。ボディには `violations` が含まれることもあり、それぞれに `code` と `path` があります。 - `RETRIEVAL_PROFILE_SCORE_THRESHOLD_REQUIRES_RERANK`：決定された深度が `fast` または `deep` で、ナレッジベースの検索設定ではスコアしきい値が有効なのに `rerank.enabled: false` になっています。Dify の **設定** > **検索** で、リランクモデルの設定を確認してください。ボディには `mode` も含まれます。 '401': content: application/json: examples: KNOWLEDGE_FS_ACCESS_DENIED: summary: KNOWLEDGE_FS_ACCESS_DENIED value: code: KNOWLEDGE_FS_ACCESS_DENIED error: >- You do not have permission to perform this Agent Knowledge Base operation. failure: action: contact_admin category: authorization code: KNOWLEDGE_FS_ACCESS_DENIED message: >- You do not have permission to perform this Agent Knowledge Base operation. retryPolicy: never traceId: 3f1e9a7c-2b4d-4e6f-8a90-1b2c3d4e5f60 knowledge_fs_invalid_credential: summary: knowledge_fs_invalid_credential value: code: knowledge_fs_invalid_credential message: Invalid Agent Knowledge Base service credential. status: 401 description: >- Dify が返す標準エラーボディ： - `knowledge_fs_invalid_credential`：`Authorization` ヘッダーがないか、`Bearer ` の形式ではありません。またはトークンが空であるか、16 KiB を超えているか、空白を含んでいます。 クエリの実行中に発生するエラー： - `KNOWLEDGE_FS_ACCESS_DENIED`：トークンの有効期限が切れているか、署名、発行者、オーディエンスのいずれかを検証できません。新しいトークンを作成して、もう一度呼び出してください。 '403': content: application/json: examples: KNOWLEDGE_FS_ACCESS_DENIED: summary: KNOWLEDGE_FS_ACCESS_DENIED value: code: KNOWLEDGE_FS_ACCESS_DENIED error: >- You do not have permission to perform this Agent Knowledge Base operation. failure: action: contact_admin category: authorization code: KNOWLEDGE_FS_ACCESS_DENIED message: >- You do not have permission to perform this Agent Knowledge Base operation. retryPolicy: never traceId: 3f1e9a7c-2b4d-4e6f-8a90-1b2c3d4e5f60 description: >- クエリの実行中に発生するエラー： - `KNOWLEDGE_FS_ACCESS_DENIED`：`X-Trace-ID` がトークンの `trace_id` クレームと異なるか、ボディの `knowledgeSpaceId` がトークンと一致しないか、トークンが別の操作向けに発行されています。 '404': content: application/json: examples: KNOWLEDGE_FS_NOT_FOUND: summary: KNOWLEDGE_FS_NOT_FOUND value: code: KNOWLEDGE_FS_NOT_FOUND error: The requested Agent Knowledge Base resource was not found. failure: category: not_found code: KNOWLEDGE_FS_NOT_FOUND message: >- The requested Agent Knowledge Base resource was not found. retryPolicy: never traceId: 3f1e9a7c-2b4d-4e6f-8a90-1b2c3d4e5f60 QUERY_IMAGE_NOT_FOUND: summary: QUERY_IMAGE_NOT_FOUND value: code: QUERY_IMAGE_NOT_FOUND error: The requested Agent Knowledge Base resource was not found. failure: category: not_found code: KNOWLEDGE_FS_NOT_FOUND message: >- The requested Agent Knowledge Base resource was not found. retryPolicy: never traceId: 3f1e9a7c-2b4d-4e6f-8a90-1b2c3d4e5f60 not_found: summary: not_found (feature off) value: code: not_found message: >- The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again. status: 404 description: >- Dify が返す標準エラーボディ： - `not_found`：このデプロイ環境では Agent ナレッジベース機能が無効になっています。このルートでは、このチェックはトークン、`X-Trace-ID`、ボディのチェックの後に行われます。 クエリの実行中に発生するエラー： - `KNOWLEDGE_FS_NOT_FOUND`：ナレッジベースがすでに存在しません。たとえば、トークンの発行後に削除された場合です。`knowledgeSpaceId` がトークンと一致しない場合は `403` が返ります。 - `QUERY_IMAGE_NOT_FOUND`：参照されたクエリ画像が存在しないか、呼び出し元から利用できません。 '409': content: application/json: examples: RETRIEVAL_DELETION_IN_PROGRESS: summary: RETRIEVAL_DELETION_IN_PROGRESS value: code: RETRIEVAL_DELETION_IN_PROGRESS error: >- This Agent Knowledge Base is being deleted and cannot be searched. failure: category: conflict code: RETRIEVAL_DELETION_IN_PROGRESS message: >- This Agent Knowledge Base is being deleted and cannot be searched. retryPolicy: never traceId: 3f1e9a7c-2b4d-4e6f-8a90-1b2c3d4e5f60 RETRIEVAL_EXECUTION_LEASE_LOST: summary: RETRIEVAL_EXECUTION_LEASE_LOST value: code: RETRIEVAL_EXECUTION_LEASE_LOST error: >- The retrieval execution expired before it could finish. Run the query again. failure: action: retry category: conflict code: RETRIEVAL_EXECUTION_LEASE_LOST message: >- The retrieval execution expired before it could finish. Run the query again. retryPolicy: manual traceId: 3f1e9a7c-2b4d-4e6f-8a90-1b2c3d4e5f60 description: >- クエリの実行中に発生するエラー： - `RETRIEVAL_DELETION_IN_PROGRESS`：ナレッジベースが削除中のため、クエリは拒否されます。 - `RETRIEVAL_EXECUTION_LEASE_LOST`：削除が始まったか実行が期限切れになったため、ストリームが開く前に実行がキャンセルされました。クエリを再実行してください。 '413': content: application/json: examples: knowledge_fs_request_too_large: summary: knowledge_fs_request_too_large value: code: knowledge_fs_request_too_large message: Agent Knowledge Base request is too large. status: 413 description: >- Dify が返す標準エラーボディ： - `knowledge_fs_request_too_large`：Dify がデフォルト値を追加した後のリクエストが、UTF-8 で 65,536 バイトを超えています。[リクエストサイズの制限](/ja/api-reference/guides/knowledge-base#request-size-limits) を参照してください。 '500': content: application/json: examples: KNOWLEDGE_FS_INTERNAL_ERROR: summary: KNOWLEDGE_FS_INTERNAL_ERROR value: code: KNOWLEDGE_FS_INTERNAL_ERROR error: >- Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference. failure: action: contact_admin category: internal code: KNOWLEDGE_FS_INTERNAL_ERROR message: >- Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference. retryPolicy: manual traceId: 3f1e9a7c-2b4d-4e6f-8a90-1b2c3d4e5f60 description: >- クエリの実行中に発生するエラー： - `KNOWLEDGE_FS_INTERNAL_ERROR`：ストリームが開く前に、クエリが予期せず失敗しました。しばらく待ってから、新しいクエリトークンで再試行してください。 '502': content: application/json: examples: knowledge_fs_upstream_unavailable: summary: knowledge_fs_upstream_unavailable value: code: knowledge_fs_upstream_unavailable message: Agent Knowledge Base is unavailable. status: 502 description: >- Dify が返す標準エラーボディ： - `knowledge_fs_upstream_unavailable`：時間内に応答が返らなかったか、API が中継できない形式の応答でした（圧縮されたボディ、イベントストリームではない成功応答、JSON ではないエラー）。しばらく待ってから、新しいクエリトークンと、それとともに返されたリクエストでやり直してください。これは別の実行を開始するもので、失われたストリームを再開するものではありません。 '503': content: application/json: examples: KNOWLEDGE_FS_UNAVAILABLE: summary: KNOWLEDGE_FS_UNAVAILABLE value: code: KNOWLEDGE_FS_UNAVAILABLE error: >- Agent Knowledge Base is temporarily unavailable. Try again later. failure: action: retry category: dependency code: KNOWLEDGE_FS_UNAVAILABLE message: >- Agent Knowledge Base is temporarily unavailable. Try again later. retryPolicy: manual traceId: 3f1e9a7c-2b4d-4e6f-8a90-1b2c3d4e5f60 knowledge_fs_operation_unavailable: summary: knowledge_fs_operation_unavailable value: code: knowledge_fs_operation_unavailable message: Agent Knowledge Base operation is not available. status: 503 description: >- Dify が返す標準エラーボディ： - `knowledge_fs_operation_unavailable`：このデプロイ環境では「クエリを実行」を利用できません。 クエリの実行中に発生するエラー： - `KNOWLEDGE_FS_UNAVAILABLE`：決定された深度で回答する準備が、ナレッジベースでまだ整っていません。公開済みのコンテンツがまだないか、アクティブな埋め込みモデルがないか、検索インデックスがまだ構築中です。[ナレッジベース設定を取得](/ja/api-reference/settings/get-knowledge-base-settings) の `capabilities` を確認し、後で再試行してください。 - `TIDB_FTS_POSTINGS_NOT_READY`：キーワード検索インデックスがまだ準備中です。ボディには `runState` も含まれます。後で再試行してください。 security: - QueryToken: [] components: securitySchemes: ApiKeyAuth: bearerFormat: API_KEY description: >- すべてのリクエストは API キーで認証します：`Authorization: Bearer {API_KEY}`。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（[Dify API クイックスタート](/ja/api-reference/guides/get-started)）。 キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP `401`（`unauthorized`）で失敗します。 scheme: bearer type: http QueryToken: bearerFormat: JWT description: >- [クエリトークンを作成](/ja/api-reference/queries/create-query-token) が返すクエリトークンで、`Authorization: Bearer {token}` として送信します。返された `expires_at` の時刻（発行から最大 60 秒後）より前に使用してください。このトークンで認可されるのは、そのナレッジベースに対する「クエリを実行」だけです。 同じリクエストで、「クエリトークンを作成」が返した `trace_id` を `X-Trace-ID` として送信してください。 scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.