获取文档大纲

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

Authorization

string

header

required

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

API Key 应保存在服务端，切勿嵌入客户端代码。缺失或无效的 Key 会返回 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

大纲。

artifact_hash

string

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

created_at

string

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

document_asset_id

string

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

string

大纲 ID。

knowledge_space_id

string

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

metadata

object

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

nodes

object[]

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

Show child attributes

outline_version

string

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

parse_artifact_id

string

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

updated_at

string | null

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

version

integer

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

获取文档大纲

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
}