Get Document Outline

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#

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path parameters

knowledge_base_idstringrequired#

Knowledge base ID: the last segment of the Service API endpoint shown in the knowledge base's API Access dialog (…/knowledge-fs/spaces/<knowledge base ID>), and the segment after /datasets/new/ in the address bar.

document_file_idstringrequired#

Document file ID. From List Document Files.

Responses

application/json

The outline.

artifact_hashstring#

Internal. Not needed to read the outline.

created_atstring#

When the outline was built, ISO 8601.

document_asset_idstring#

ID of the document file the outline was built for.

idstring#

Outline ID.

knowledge_space_idstring#

Internal ID of the knowledge base. Not the knowledge base ID in the path.

metadataobject#

Additional outline details. Free-form object.

nodesobject[]#

Top-level headings, in document order. Nested headings are in each heading's children.

Show child attributes

child_node_idsstring[]#

IDs of the headings in children.

childrenKnowledgeBaseOutlineHeading[]#

Nested headings, in document order.

circular

end_offsetinteger#

Zero-based UTF-8 byte offset in the parsed document text. Exclusive end. null when unknown.

end_pageinteger#

Last page of the section, starting at 1. null when the file has no pages.

idstring#

Heading ID.

levelinteger#

Heading depth, starting at 1.

metadataobject#

Additional heading details. Free-form object.

section_pathstring[]#

Headings from the document root to this heading, itself included.

source_element_idsstring[]#

IDs of the parsed elements the heading was detected from.

source_node_idsstring[]#

Internal. Not needed to read the outline.

start_offsetinteger#

Zero-based UTF-8 byte offset in the parsed document text. Inclusive start. null when unknown.

start_pageinteger#

First page of the section, starting at 1. null when the file has no pages.

summarystring#

Generated summary of the section. null when none was generated.

titlestring#

Heading text.

title_locationobject#

Where the heading sits in the file. null when unknown.

toc_sourcestring#

How the heading was detected: native-toc, llm-inferred, parser-heading, or fallback.

outline_versionstring#

Internal. Not needed to read the outline.

parse_artifact_idstring#

Internal. Not needed to read the outline.

updated_atstring#

When the outline last changed, ISO 8601. null when it has not changed since it was built.

versioninteger#

The document file's version the outline belongs to. It does not change when a re-index rebuilds the outline, because a document file's version never changes.

Delete Document File List Document Revisions