Skip to main content
get/apps/annotations
Request example
Response
get/apps/annotations

Authorization

Authorizationstringheaderrequired#

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

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

Query parameters

pageinteger#
ページ番号。

Default: 1

Range: >= 1

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

Default: 20

Range: >= 1

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

Responses

application/json
200
アノテーションリストの取得に成功しました。
dataobject[]#
現在のページのアノテーション項目のリストです。
has_moreboolean#
現在の結果セットの後にさらにページがある場合は true です。
limitinteger#
1 ページあたりの件数です。
pageinteger#
現在のページ番号です。
totalinteger#
クエリに一致するアノテーションの合計数です。