获取文档大纲

get/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline

Request example

curl --request GET \
  --url https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline"
headers = {
    "Authorization": "Bearer <token>",
}

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

print(response.text)

const response = await fetch('https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline', {
  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/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline',
  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/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))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline"))
    .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/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline')

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

{
  "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
}

{
  "code": "knowledge_fs_invalid_request",
  "failure": {
    "category": "validation",
    "code": "KNOWLEDGE_FS_INVALID_REQUEST",
    "message": "The Agent Knowledge Base request is invalid.",
    "retryPolicy": "never",
    "traceId": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
  },
  "message": "The Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400
}

{
  "code": "knowledge_fs_invalid_credential",
  "message": "Invalid Agent Knowledge Base service credential.",
  "status": 401
}

{
  "code": "unauthorized",
  "message": "Access token is invalid",
  "status": 401
}

{
  "code": "forbidden",
  "message": "Sorry, you have reached the knowledge base request rate limit of your subscription.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "message": "Agent Knowledge Base operation is not allowed.",
  "status": 403
}

{
  "code": "knowledge_fs_access_denied",
  "failure": {
    "action": "contact_admin",
    "category": "authorization",
    "code": "KNOWLEDGE_FS_ACCESS_DENIED",
    "message": "You do not have permission to perform this Agent Knowledge Base operation.",
    "retryPolicy": "never",
    "traceId": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
  },
  "message": "You do not have permission to perform this Agent Knowledge Base operation.",
  "status": 403
}

{
  "code": "knowledge_fs_resource_not_found",
  "failure": {
    "category": "not_found",
    "code": "KNOWLEDGE_FS_NOT_FOUND",
    "message": "The requested Agent Knowledge Base resource was not found.",
    "retryPolicy": "never",
    "traceId": "7f3c1a90-2e64-4b7d-8a51-6c0d9e2f4b83"
  },
  "message": "The requested Agent Knowledge Base resource was not found.",
  "status": 404
}

{
  "code": "not_found",
  "message": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.",
  "status": 404
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "failure": {
    "action": "contact_admin",
    "category": "internal",
    "code": "KNOWLEDGE_FS_INTERNAL_ERROR",
    "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "Agent Knowledge Base could not complete the operation. Try again, or contact an administrator with the error reference.",
  "status": 502
}

{
  "code": "knowledge_fs_upstream_unavailable",
  "message": "Agent Knowledge Base is unavailable.",
  "status": 502
}

{
  "code": "knowledge_fs_operation_unavailable",
  "message": "Agent Knowledge Base operation is not available.",
  "status": 503
}

{
  "code": "knowledge_fs_operation_unavailable",
  "failure": {
    "action": "retry",
    "category": "dependency",
    "code": "KNOWLEDGE_FS_UNAVAILABLE",
    "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
    "retryPolicy": "manual",
    "traceId": "5e2a9c17-3b4d-4f60-8a1b-2c3d4e5f6a7b"
  },
  "message": "A service required by Agent Knowledge Base is temporarily unavailable.",
  "status": 503
}

get/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_file_id}/outline

Authorization

Authorizationstringheaderrequired#

每个请求都通过 API Key 认证：Authorization: Bearer {API_KEY}。应用接口使用应用 API Key，知识库接口使用知识库 API Key（快速开始）。

API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 HTTP 401（unauthorized）。

Path parameters

knowledge_base_idstringrequired#

知识库 ID：即知识库 API 访问 对话框中所示服务 API 端点的最后一段（…/knowledge-fs/spaces/<knowledge base ID>），也是地址栏中 /datasets/new/ 之后的那一段。

document_file_idstringrequired#

文档文件 ID。从获取文档文件列表获取。

Responses

application/json

大纲。

artifact_hashstring#

内部字段，读取大纲时无需使用。

created_atstring#

大纲的构建时间，ISO 8601 格式。

document_asset_idstring#

该大纲所属文档文件的 ID。

idstring#

大纲 ID。

knowledge_space_idstring#

知识库的内部 ID，并非路径中的知识库 ID。

metadataobject#

大纲的附加信息，为自由格式的对象。

nodesobject[]#

顶级标题，按文档顺序排列。嵌套的子标题位于各标题的 children 中。

Show child attributes

child_node_idsstring[]#

children 中各标题的 ID。

childrenKnowledgeBaseOutlineHeading[]#

嵌套的下级标题，按文档顺序排列。

circular

end_offsetinteger#

解析后文档文本中的 UTF-8 字节偏移量，从 0 开始计数，为结束位置（不包含）。未知时为 null。

end_pageinteger#

该章节的最后一页，页码从 1 开始。文件没有分页时为 null。

idstring#

标题 ID。

levelinteger#

标题层级，从 1 开始。

metadataobject#

标题的其他详细信息，为自由格式的对象。

section_pathstring[]#

从文档根到此标题的各级标题，包含此标题本身。

source_element_idsstring[]#

识别出该标题所依据的解析元素 ID。

source_node_idsstring[]#

内部字段，读取大纲时无需使用。

start_offsetinteger#

解析后文档文本中的 UTF-8 字节偏移量，从 0 开始计数，为起始位置（包含）。未知时为 null。

start_pageinteger#

该章节的第一页，页码从 1 开始。文件没有分页时为 null。

summarystring#

为该章节生成的摘要。未生成摘要时为 null。

titlestring#

标题文本。

title_locationobject#

标题在文件中的位置。未知时为 null。

toc_sourcestring#

标题的识别方式：native-toc、llm-inferred、parser-heading 或 fallback。

outline_versionstring#

内部字段，读取大纲时无需使用。

parse_artifact_idstring#

内部字段，读取大纲时无需使用。

updated_atstring#

大纲最后变更时间，ISO 8601 格式。构建后未发生变更时为 null。

versioninteger#

大纲所属的文档文件 version。重新索引重建大纲时，该值不会改变，因为文档文件的 version 永远不变。

删除文档文件获取文档修订版本列表