メインコンテンツへスキップ
GET
ナレッジベースのドキュメントリストを取得

承認

Authorization
string
header
必須

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

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

パスパラメータ

dataset_id
string<uuid>
必須

ナレッジベース ID です。ナレッジベースリストを取得 から取得します。

クエリパラメータ

page
integer
デフォルト:1

ページ番号。

limit
integer
デフォルト:20

1 ページあたりの項目数です。サーバーの上限は 100 です。

keyword
string

ドキュメント名でフィルタリングするための検索キーワードです。

status
enum<string>

表示ステータスでフィルタリングします。

利用可能なオプション:
queuing,
indexing,
paused,
error,
available,
disabled,
archived

レスポンス

ドキュメントのリストです。

data
object[]

ドキュメントオブジェクトの配列です。

has_more
boolean

次のページにさらに項目が存在するかどうかです。

limit
integer

1 ページあたりの件数です。

total
integer

一致する項目の合計数です。

page
integer

現在のページ番号です。