ドキュメントとチャンク
ドキュメントのアウトラインを取得
ドキュメントファイルの現在のバージョンについて構築された見出しツリーを返します。
アウトラインは、インデックス処理で構築された後にのみ存在します。その段階より前にインデックス処理が失敗したファイルには、アウトラインはありません。再インデックスした場合は、新しいインデックスタスクの公開が済むと、そのタスクが構築したアウトラインを返します。
レスポンスはページ分割されません。
GET
/
knowledge-fs
/
spaces
/
{knowledge_base_id}
/
documents
/
{document_file_id}
/
outline
ドキュメントのアウトラインを取得
curl --request GET \
--url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline \
--header 'Authorization: Bearer <token>'import requests
url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline"
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))
}HttpResponse<String> response = Unirest.get("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"artifact_hash": "3a7bd3e2360a3d29eea436fcfb7e44c735d117c42d1c1835420b6b9942dd4f1b",
"created_at": "2026-09-03T10:04:00Z",
"document_asset_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
"id": "c9d8e7f6-a5b4-4c3d-8e2f-1a0b9c8d7e6f",
"knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
"metadata": {},
"nodes": [
{
"child_node_ids": [
"n-1-1"
],
"children": [
{
"child_node_ids": [],
"children": [],
"end_offset": 4210,
"end_page": 3,
"id": "n-1-1",
"level": 2,
"metadata": {},
"section_path": [
"1 Introduction",
"1.1 Scope"
],
"source_element_ids": [
"el-12"
],
"source_node_ids": [],
"start_offset": 2100,
"start_page": 2,
"summary": null,
"title": "1.1 Scope",
"title_location": null,
"toc_source": "parser-heading"
}
],
"end_offset": 9800,
"end_page": 6,
"id": "n-1",
"level": 1,
"metadata": {},
"section_path": [
"1 Introduction"
],
"source_element_ids": [
"el-3"
],
"source_node_ids": [],
"start_offset": 0,
"start_page": 1,
"summary": null,
"title": "1 Introduction",
"title_location": null,
"toc_source": "parser-heading"
}
],
"outline_version": "document-outline-v1",
"parse_artifact_id": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6",
"updated_at": null,
"version": 1
}
Authorizations
すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401（unauthorized）で失敗します。
Path Parameters
ナレッジベース ID です。ナレッジベースの API アクセス ダイアログに表示されるサービス API エンドポイントの最後のセグメント（…/knowledge-fs/spaces/<knowledge base ID>）です。アドレスバーでは /datasets/new/ の後のセグメントです。
ドキュメントファイル ID です。ドキュメントファイル一覧を取得 から取得します。
Response
アウトラインです。
内部用です。アウトラインの読み取りには不要です。
アウトラインが構築された日時（ISO 8601）です。
アウトラインの構築対象となったドキュメントファイルの ID です。
アウトライン ID です。
ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。
アウトラインの追加情報です。自由形式のオブジェクトです。
最上位の見出しです。ドキュメント内の順に並びます。下位の見出しは、各見出しの children に入ります。
Show child attributes
Show child attributes
内部用です。アウトラインの読み取りには不要です。
内部用です。アウトラインの読み取りには不要です。
アウトラインが最後に変更された日時（ISO 8601）です。構築後に変更されていない場合は null です。
アウトラインが属するドキュメントファイルの version です。ドキュメントファイルの version は変わらないため、再インデックスでアウトラインが再構築されても、この値は変わりません。
Was this page helpful?
⌘I
ドキュメントのアウトラインを取得
curl --request GET \
--url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline \
--header 'Authorization: Bearer <token>'import requests
url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline"
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))
}HttpResponse<String> response = Unirest.get("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"artifact_hash": "3a7bd3e2360a3d29eea436fcfb7e44c735d117c42d1c1835420b6b9942dd4f1b",
"created_at": "2026-09-03T10:04:00Z",
"document_asset_id": "6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b",
"id": "c9d8e7f6-a5b4-4c3d-8e2f-1a0b9c8d7e6f",
"knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
"metadata": {},
"nodes": [
{
"child_node_ids": [
"n-1-1"
],
"children": [
{
"child_node_ids": [],
"children": [],
"end_offset": 4210,
"end_page": 3,
"id": "n-1-1",
"level": 2,
"metadata": {},
"section_path": [
"1 Introduction",
"1.1 Scope"
],
"source_element_ids": [
"el-12"
],
"source_node_ids": [],
"start_offset": 2100,
"start_page": 2,
"summary": null,
"title": "1.1 Scope",
"title_location": null,
"toc_source": "parser-heading"
}
],
"end_offset": 9800,
"end_page": 6,
"id": "n-1",
"level": 1,
"metadata": {},
"section_path": [
"1 Introduction"
],
"source_element_ids": [
"el-3"
],
"source_node_ids": [],
"start_offset": 0,
"start_page": 1,
"summary": null,
"title": "1 Introduction",
"title_location": null,
"toc_source": "parser-heading"
}
],
"outline_version": "document-outline-v1",
"parse_artifact_id": "d1e2f3a4-b5c6-4d7e-8f90-a1b2c3d4e5f6",
"updated_at": null,
"version": 1
}