チャンク一覧を取得

ドキュメントの 1 つのリビジョンのチャンクを、位置順ではなくチャンク ID 順に一覧表示します。ドキュメントファイル ID ではなくドキュメント一覧を取得で得たドキュメント ID と、リビジョン番号を受け取ります。

ドキュメント内の順序でチャンクを読むには、すべてのページを取得して ordinal で並べ替えてください。

元になっているドキュメントファイルのバージョンが残っていれば、置き換えられたリビジョンを含め、どのリビジョンでも一覧表示できます。

ドキュメント ID とドキュメントファイル ID の関係については、ドキュメントとチャンクの参照を参照してください。

1 min read

get/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks

Request example

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

import requests

url = "https://api.dify.ai/v1/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks"
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_id}/revisions/{revision}/chunks', {
  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_id}/revisions/{revision}/chunks',
  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_id}/revisions/{revision}/chunks"

	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_id}/revisions/{revision}/chunks"))
    .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_id}/revisions/{revision}/chunks')

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

{
  "data": [
    {
      "created_at": "2026-09-03T10:04:30Z",
      "document_id": "3d2f1c0b-9a8e-4d7c-b6a5-4f3e2d1c0b9a",
      "document_revision": 2,
      "enabled": true,
      "end_offset": 5120,
      "id": "7a6b5c4d-3e2f-4a1b-9c8d-7e6f5a4b3c2d",
      "kind": "chunk",
      "knowledge_space_id": "9b2e5b7a-3c1d-4e2f-8a9b-1c2d3e4f5a6b",
      "ordinal": 14,
      "parent_chunk_id": null,
      "parse_element_ids": [
        "el-40",
        "el-41"
      ],
      "section_path": [
        "3 Employment",
        "3.4 Termination"
      ],
      "start_offset": 4600,
      "text": "Either party may terminate this agreement with thirty days' written notice.",
      "token_count": 131,
      "user_metadata": {}
    }
  ],
  "next_cursor": null
}

{
  "code": "knowledge_fs_invalid_request",
  "message": "Agent Knowledge Base request is invalid.",
  "status": 400,
  "violations": [
    {
      "field": [
        "query"
      ],
      "type": "string_too_long"
    }
  ]
}

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

{
  "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_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_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_id}/revisions/{revision}/chunks

Authorization

Authorizationstringheaderrequired#

すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401（unauthorized）で失敗します。

Path parameters

knowledge_base_idstringrequired#

ナレッジベース ID です。ナレッジベースの API アクセス ダイアログに表示されるサービス API エンドポイントの最後のセグメント（…/knowledge-fs/spaces/<knowledge base ID>）です。アドレスバーでは /datasets/new/ の後のセグメントです。

document_idstringrequired#

ドキュメント ID です。ドキュメント一覧を取得から取得するか、開いているドキュメントのアドレスバー（/datasets/new/<knowledge base ID>/documents/<document ID>）から取得します。

revisionintegerrequired#

リビジョン番号です。ドキュメントリビジョン一覧を取得から取得します。

Range: >= 1

Query parameters

cursorstring#

前のページの next_cursor から取得したカーソルです。

Length: 1–1000

querystring#

text と照合する部分文字列（大文字と小文字を区別しない）です。セマンティック検索ではありません。省略すると、すべてのチャンクを一覧表示します。

Length: 1–512

limitinteger#

1 ページあたりのチャンク数です。

Default: 50

Range: 1–100

Responses

application/json

1 ページ分のチャンクです。

dataobject[]#

1 ページ分のチャンクです。チャンク ID 順に並びます。

Show child attributes

created_atstring#

チャンクの作成日時（ISO 8601）です。

document_idstring#

ドキュメント ID です。ドキュメントを取得の id にあたります。

document_revisioninteger#

チャンクが属するリビジョンです。チャンクはリビジョンごとに別々に存在します。チャンク ID は、そのチャンクが属するリビジョンを通してのみ参照できます。

enabledboolean#

チャンクが検索の対象になるかどうかです。この API には、この値を変更する操作はありません。

end_offsetinteger#

解析済みドキュメントテキスト内の 0 始まりの UTF-8 バイトオフセットです。終了位置を表し、この位置自体は範囲に含みません。不明な場合は null です。

idstring#

チャンク ID です。チャンクを取得のパスパラメータ chunk_id に指定する値です。

kindstring#

チャンクの生成元です。本文の連続したテキストは chunk（デフォルト）、見出しのセクションは section、表は table、画像は image、生成された要約は summary です。

knowledge_space_idstring#

ナレッジベースの内部 ID です。パスのナレッジベース ID とは異なります。

ordinalinteger#

リビジョン内でのチャンクの位置で、0 から始まります。この値で並べ替えると、ドキュメント内の順序でチャンクを読めます。

parent_chunk_idstring#

親子チャンキングにおける親チャンクの ID です。最上位のチャンクでは null です。

parse_element_idsstring[]#

チャンクの生成元となった解析済み要素の ID です。

section_pathstring[]#

ドキュメントのルートから、チャンクが属するセクションまでの見出しです。

start_offsetinteger#

解析済みドキュメントテキスト内の 0 始まりの UTF-8 バイトオフセットです。開始位置を表し、この位置自体を範囲に含みます。不明な場合は null です。

textstring#

チャンクの内容です。

token_countinteger#

text のトークン数です。

user_metadataobject#

チャンクに付与されたメタデータです。自由形式のオブジェクトです。

next_cursorstring#

次のページのカーソルです。最後のページでは null です。cursor として送り返してください。

ドキュメントリビジョン一覧を取得チャンクを取得