チャンクを取得

GET

knowledge-fs

spaces

{knowledge_base_id}

documents

{document_id}

revisions

{revision}

chunks

{chunk_id}

チャンクを取得

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id}"

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

	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_id}/revisions/{revision}/chunks/{chunk_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id}")

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

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

Authorizations

Authorization

string

header

required

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

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

Path Parameters

knowledge_base_id

string<uuid>

required

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

document_id

string<uuid>

required

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

revision

integer

required

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

Required range: x >= 1

chunk_id

string<uuid>

required

チャンク ID です。チャンク一覧を取得から取得します。

Response

チャンクです。

オフセットは、解析済みのドキュメントテキスト内の位置を指します。元のファイル内の位置ではありません。

created_at

string

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

document_id

string

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

document_revision

integer

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

enabled

boolean

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

end_offset

integer | null

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

string

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

kind

string

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

knowledge_space_id

string

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

ordinal

integer

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

parent_chunk_id

string | null

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

parse_element_ids

string[]

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

section_path

string[]

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

start_offset

integer | null

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

text

string

チャンクの内容です。

token_count

integer

text のトークン数です。

user_metadata

object

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

チャンクを取得

curl --request GET \
  --url https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id}"

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

	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_id}/revisions/{revision}/chunks/{chunk_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/knowledge-fs/spaces/{knowledge_base_id}/documents/{document_id}/revisions/{revision}/chunks/{chunk_id}")

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

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

ガイド

アプリ API

ナレッジ API

チャンクを取得

Authorizations

Path Parameters

Response