ナレッジベースのドキュメントリストを取得
ナレッジベース内のドキュメントのページネーションされた一覧を返します。
1 min read
get/datasets/{dataset_id}/documents
Request example
curl --request GET \
--url https://api.dify.ai/v1/datasets/{dataset_id}/documents \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.dify.ai/v1/datasets/{dataset_id}/documents"
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', {
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',
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"
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"))
.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')
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_bodyResponse
{
"data": [
{
"archived": false,
"created_at": 1741267200,
"created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
"created_from": "api",
"data_source_detail_dict": {
"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_info": {
"upload_file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
"data_source_type": "upload_file",
"dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
"disabled_at": null,
"disabled_by": null,
"display_status": "available",
"doc_form": "text_model",
"doc_metadata": [],
"enabled": true,
"error": null,
"hit_count": 0,
"id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
"indexing_status": "completed",
"name": "guide.txt",
"need_summary": false,
"position": 1,
"summary_index_status": null,
"tokens": 512,
"word_count": 350
}
],
"has_more": false,
"limit": 20,
"page": 1,
"total": 1
}{
"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": "Dataset not found.",
"status": 404
}get/datasets/{dataset_id}/documents
Authorization
すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。
Path parameters
ナレッジベース ID。ナレッジベースリストを取得 で取得します。スコープを限定したキーでは、Dify の URL から ID をコピー してください。
Query parameters
ドキュメント名でフィルタリングするための検索キーワードです。
Responses
application/json
ドキュメントのリストです。
ドキュメントオブジェクトの配列です。
Show child attributesHide child attributes
ドキュメントがアーカイブ済みかどうかです。
作成タイムスタンプ(Unix エポック、秒単位)です。
ドキュメントを作成したユーザーの ID です。
ドキュメントの作成元です。API で作成した場合は
api、UI で作成した場合は web です。ファイル詳細を含む詳細なデータソース情報です。
生のデータソース情報です。
data_source_type によって異なります。ドキュメントの作成方法です。ファイルアップロードの場合は
upload_file、Notion インポートの場合は notion_import です。このドキュメントに適用された処理ルールの ID です。
ドキュメントが無効化されたタイムスタンプです。有効な場合は
null です。ドキュメントを無効化したユーザーの ID です。有効な場合は
null です。indexing_status と enabled 状態から導出されたユーザー向け表示ステータスです。ドキュメントのチャンキングモードです。
text_model は標準テキストチャンキング、hierarchical_model は親子構造、qa_model は QA ペア抽出を示します。このドキュメントに割り当てられたメタデータ値です。
このドキュメントが検索に対して有効かどうかです。
インデックス作成が失敗した場合のエラーメッセージです。エラーなしの場合は
null です。ドキュメントが検索クエリでマッチした回数です。
ドキュメントの一意識別子です。
現在のインデックスステータスです。
waiting はキュー待ち、parsing はコンテンツ抽出中、cleaning はノイズ除去中、splitting はチャンキング中、indexing はベクトル構築中、completed は準備完了、error は失敗、paused は手動一時停止を示します。ドキュメント名です。
このドキュメントに要約を生成する必要があるかどうかです。
リスト内のドキュメントの表示位置です。
このドキュメントの要約インデックスのステータスです。要約インデックスが設定されていない場合は
null です。ドキュメント内の合計トークン数です。
ドキュメントの合計単語数です。
次のページにさらに項目が存在するかどうかです。
1 ページあたりの件数です。
現在のページ番号です。
一致する項目の合計数です。