Skip to main content
GET
チャンク一覧を取得

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

Query Parameters

cursor
string

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

Required string length: 1 - 1000
query
string

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

Required string length: 1 - 512
limit
integer
default:50

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

Required range: 1 <= x <= 100

Response

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

data
object[]

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

next_cursor
string | null

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