メインコンテンツへスキップ
GET
アノテーションリストを取得

承認

Authorization
string
header
必須

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

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

クエリパラメータ

page
integer
デフォルト:1

ページ番号。

必須範囲: x >= 1
limit
integer
デフォルト:20

1 ページあたりのアイテム数。100 を超えるリクエストは 100 に制限されます。

必須範囲: x >= 1
keyword
string

質問または回答の内容でアノテーションをフィルタリングするためのキーワードです。

レスポンス

200 - application/json

アノテーションリストの取得に成功しました。

data
object[]

現在のページのアノテーション項目のリストです。

has_more
boolean

現在の結果セットの後にさらにページがある場合は true です。

limit
integer

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

total
integer

クエリに一致するアノテーションの合計数です。

page
integer

現在のページ番号です。