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_file_id
string<uuid>
required

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

Response

ドキュメントファイルです。

created_at
string

ファイルが保存された日時(ISO 8601)です。

filename
string

元のファイル名です。

id
string

ドキュメントファイル ID です。Dify でドキュメントを開いたときにアドレスバーに表示されるドキュメント ID とは異なります。

knowledge_space_id
string

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

metadata
object

ファイルのアップロード時またはインポート時に、ファイルとともに記録されたメタデータです。

mime_type
string

ファイルの MIME タイプです。

object_key
string

オブジェクトストレージ内のファイルのキーです。この API には、ファイルの内容を返す操作はありません。

parser_status
string

このバージョンのファイルの解析状態で、pending、parsed、failed のいずれかです。解析はインデックス処理の 1 ステップです。parsed のファイルでも、アウトラインとチャンクがない場合があります。

sha256
string

ファイル内容の SHA-256 ハッシュ(16 進数エンコード)です。

size_bytes
integer

ファイルサイズ(バイト単位)です。

source_id
string | null

ファイルのインポート元のソース ID です。アップロードされたファイルでは null です。

updated_at
string | null

ファイルレコードが最後に変更された日時(ISO 8601)です。作成後に変更されていない場合は null です。

version
integer

このファイル ID では常に 1 です。ソースの同期を含め、内容を更新するとこの値は増えず、別のファイル ID が作成されます。ドキュメントのコンテンツのリビジョンとは別の値です。ドキュメントファイルを削除 に expectedRevision として送信します。