Skip to main content
GET
クエリ記録を取得

Authorizations

Authorization
string
header
required

すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。

Path Parameters

knowledge_base_id
string<uuid>
required

ナレッジベース ID です。ナレッジベースの API アクセス ダイアログに表示されるサービス API エンドポイントの最後のセグメント(…/knowledge-fs/spaces/<knowledge base ID>)です。アドレスバーでは /datasets/new/ の後のセグメントです。

query_record_id
string<uuid>
required

クエリ記録 ID です。クエリを実行 のレスポンスヘッダー x-query-run-id、または クエリ記録一覧を取得 の id です。

Response

クエリ記録です。

created_at
string

実行が記録された日時(ISO 8601)です。

evidence_bundle_id
string | null

この記録が参照する、検索されたチャンクのセットの ID です。この ID を受け取る操作はありません。チャンク自体は query.generate ステップに埋め込まれています。実行で何も記録されなかった場合は null です。

id
string

クエリ記録 ID です。

knowledge_space_id
string

ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。

mode
string

実行の検索の深度です。fast、deep、research のいずれかです。

query
string

クエリのテキストです。

query_images
object[]

元のクエリで使用された画像です(ある場合)。テキストのみのクエリでは省略されます。

source
string

記録の生成元です。service_api、workflow、agent、mcp、retrieval_test のいずれかです。

steps
object[]

実行のステップです。実行順に並びます。