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 Parameters

document_asset_id
string
required

ドキュメントファイル ID です。ドキュメントファイル一覧を取得 の id、または引用の documentAssetId を指定します。UUID である必要があります。

Required string length: 1 - 255
document_asset_version
integer
required

ドキュメントファイルの version、または引用の documentVersion です。ドキュメントファイルの version は常に 1 です。

Required range: x >= 1

Response

ドキュメントとリビジョンです。

document_id
string

ドキュメント ID です。ドキュメントを取得 または チャンク一覧を取得 に渡します。

revision
integer

このファイルバージョンから構築されたリビジョンです。document_id と一緒に チャンク一覧を取得 に渡します。