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/ の後のセグメントです。

document_id
string<uuid>
required

ドキュメント ID です。ドキュメント一覧を取得 から取得します。

Response

ドキュメントです。

active
object | null

アクティブなリビジョン、つまりナレッジベースが提供しているコンテンツです。その revision を チャンク一覧を取得 に、document_asset_id を ドキュメントファイルを取得 に渡します。アクティブなリビジョンがない間は null です。

active_revision
integer | null

アクティブなリビジョンの番号です。アクティブなリビジョンがない間は null です。

created_at
string

ドキュメントの作成日時(ISO 8601)です。

disabled_at
string | null

Dify でドキュメントが無効化された日時(ISO 8601)です。

disabled_by_subject_id
string | null

ドキュメントを無効化した操作者の内部 ID です。この API の呼び出しには不要です。

enabled
boolean

Dify でドキュメントが無効化されると false になります。ドキュメントを再インデックス は、無効化されたドキュメントをスキップします。

id
string

ドキュメント ID です。ドキュメントの内容を更新しても変わりません。

knowledge_space_id
string

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

latest_task
object | null

ドキュメントのリビジョンを作成した最新のインデックスタスクで、task_kind: document を持ちます。その id を指定して ドキュメントのインデックスタスクを取得 で追跡します。タスクがない場合は null です。ドキュメントメタデータを更新 のレスポンスでは常に null です。

provider_item_id
string | null

ソースからインポートしたドキュメントの場合、ソース側でのアイテムの識別子です。ソースのアイテムをインポート に送信した providerItemId、またはウェブサイトのページの page_id です。

row_version
integer

変更カウンターです。ドキュメントメタデータを更新 で expectedRowVersion として送信します。メタデータの更新時、新しいリビジョンがアクティブになった時、Dify でドキュメントが有効化または無効化された時に増加します。

source_id
string | null

ドキュメントの取得元のソースです。アップロードされたファイルでは null です。

status
string

pending(まだアクティブなリビジョンがない)、ready(リビジョンがアクティブ)、failed(最初のリビジョンのインデックス処理に失敗し、アクティブなリビジョンがない)、deleting のいずれかです。ready のドキュメントは、後続のリビジョンが失敗しても ready のままです。

title
string

ドキュメントのタイトルです。

updated_at
string

ドキュメントが最後に変更された日時(ISO 8601)です。

user_metadata
object

カスタムメタデータで、キーはメタデータフィールド名です。ドキュメントメタデータを更新 または Dify で変更できます。