ドキュメント詳細を取得

get/datasets/{dataset_id}/documents/{document_id}

Request example

curl --request GET \
  --url https://api.dify.ai/v1/datasets/{dataset_id}/documents/{document_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dify.ai/v1/datasets/{dataset_id}/documents/{document_id}"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/datasets/{dataset_id}/documents/{document_id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/datasets/{dataset_id}/documents/{document_id}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://api.dify.ai/v1/datasets/{dataset_id}/documents/{document_id}"

	req, _ := http.NewRequest("GET", url, nil)
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/datasets/{dataset_id}/documents/{document_id}"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://api.dify.ai/v1/datasets/{dataset_id}/documents/{document_id}')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

request = Net::HTTP::Get.new(url)
request['Authorization'] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

Response

{
  "archived": false,
  "average_segment_length": 70,
  "completed_at": 1741267260,
  "created_at": 1741267200,
  "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
  "created_from": "api",
  "data_source_info": {
    "upload_file": {
      "created_at": 1741267200,
      "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
      "extension": "txt",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "mime_type": "text/plain",
      "name": "guide.txt",
      "size": 2048
    }
  },
  "data_source_type": "upload_file",
  "dataset_process_rule": {
    "id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
    "mode": "custom"
  },
  "dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
  "disabled_at": null,
  "disabled_by": null,
  "display_status": "available",
  "doc_form": "text_model",
  "doc_language": "English",
  "doc_metadata": [],
  "doc_type": null,
  "document_process_rule": {
    "mode": "custom",
    "rules": {
      "pre_processing_rules": [],
      "segmentation": {
        "chunk_overlap": 50,
        "max_tokens": 500,
        "separator": "###"
      }
    }
  },
  "enabled": true,
  "error": null,
  "hit_count": 0,
  "id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
  "indexing_latency": 60,
  "indexing_status": "completed",
  "name": "guide.txt",
  "need_summary": false,
  "position": 1,
  "segment_count": 5,
  "summary_index_status": null,
  "tokens": 512,
  "updated_at": 1741267260
}

{
  "code": "invalid_metadata",
  "message": "Invalid metadata value: full",
  "status": 400
}

{
  "code": "forbidden",
  "message": "No permission.",
  "status": 403
}

{
  "code": "forbidden",
  "message": "Dataset api access is not enabled.",
  "status": 403
}

{
  "code": "forbidden",
  "message": "The API key is not authorized to access this knowledge base.",
  "status": 403
}

{
  "code": "not_found",
  "message": "Document not found.",
  "status": 404
}

{
  "code": "not_found",
  "message": "Dataset not found.",
  "status": 404
}

get/datasets/{dataset_id}/documents/{document_id}

Authorization

Authorizationstringheaderrequired#

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

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

Path parameters

dataset_idstringrequired#

ナレッジベース ID。ナレッジベースリストを取得で取得します。スコープを限定したキーでは、Dify の URL から ID をコピーしてください。

document_idstringrequired#

ドキュメント ID です。ナレッジベースのドキュメントリストを取得から取得します。

Query parameters

metadataenum<string>#

all はメタデータを含むすべてのフィールドを返します。only は id、doc_type、doc_metadata のみを返します。without は doc_type と doc_metadata を除くすべてのフィールドを返します。

Default: "all"

Options:allonlywithout

Responses

application/json

ドキュメントの詳細です。返されるフィールドは metadata クエリパラメータによって異なります。

archivedboolean#

ドキュメントがアーカイブ済みかどうかです。

average_segment_lengthnumber#

チャンクの平均文字長です。

completed_atnumber#

処理が完了した Unix タイムスタンプです。まだ完了していない場合は null です。

created_atnumber#

ドキュメント作成の Unix タイムスタンプです。

created_bystring#

ドキュメントを作成したユーザーの ID です。

created_fromstring#

ドキュメントの作成元です。API で作成した場合は api、UI で作成した場合は web です。

data_source_infoobject#

データソースの詳細です。ファイルアップロードの場合、この詳細エンドポイントは upload_file 配下に完全なファイルオブジェクトを返します（リストエンドポイントは upload_file_id のみを返します）。

Show child attributes

upload_fileobject#

アップロードされたファイルの詳細です。data_source_type が upload_file の場合に返されます。

Show child attributes

created_atinteger#

ファイルアップロードの Unix タイムスタンプです。

created_bystring#

ファイルをアップロードしたユーザーの ID です。

extensionstring#

ファイル拡張子です。

idstring#

ファイル識別子です。

mime_typestring#

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

namestring#

元のファイル名です。

sizeinteger#

ファイルサイズ（バイト単位）です。

data_source_typestring#

ドキュメントのアップロード方法です。ファイルアップロードの場合は upload_file、Notion インポートの場合は notion_import です。

dataset_process_ruleobject#

ナレッジベースレベルの処理ルール設定です。

dataset_process_rule_idstring#

このドキュメントに適用された処理ルールの ID です。

disabled_atnumber#

ドキュメントが無効化された Unix タイムスタンプです。有効な場合は null です。

disabled_bystring#

ドキュメントを無効化したユーザーの ID です。有効な場合は null です。

display_statusstring#

UI 向けの表示用インデックスステータスです。

doc_formstring#

ドキュメントのチャンキングモードです。text_model は標準テキスト、hierarchical_model は親子構造、qa_model は QA ペアを示します。

doc_languagestring#

ドキュメント内容の言語です。

doc_metadataobject[]#

このドキュメントのカスタムメタデータキーバリューペア。

Show child attributes

idstring#

メタデータフィールドの識別子です。

namestring#

メタデータフィールド名です。

typestring#

メタデータフィールドの種類です。

valuestring#

このドキュメントのメタデータフィールド値。

doc_typestring#

ドキュメントタイプの分類です。未設定の場合は null です。

document_process_ruleobject#

ドキュメントレベルの処理ルール設定です。

enabledboolean#

このドキュメントが検索に対して有効かどうかです。

errorstring#

インデックス作成が失敗した場合のエラーメッセージです。それ以外は null です。

hit_countinteger#

このドキュメントが検索された回数です。

idstring#

ドキュメント識別子です。

indexing_latencynumber#

インデックス作成にかかった時間（秒）です。未完了の場合は null です。

indexing_statusstring#

現在のインデックスステータスです（例：waiting、parsing、cleaning、splitting、indexing、completed、error、paused）。

namestring#

ドキュメント名です。

need_summaryboolean#

このドキュメントが要約生成を必要とするかどうかです。

positioninteger#

ナレッジベース内の位置インデックスです。

segment_countinteger#

ドキュメント内のチャンク数です。

summary_index_statusstring#

要約インデックスのステータスです。要約インデックスが有効でない場合は null です。

tokensinteger#

ドキュメント内のトークン数です。

updated_atnumber#

最終更新の Unix タイムスタンプです。更新されたことがない場合は null です。

ナレッジベースのドキュメントリストを取得ドキュメントを削除