Annotations

List Annotations

Changed on

Available for: Chatflow, Chatbot, Legacy Agent apps.

Lists the app's annotations, optionally filtered by keyword.

get/apps/annotations

Request

  • Base URL
    https://api.dify.ai/v1
  • URL
    https://api.dify.ai/v1/apps/annotations
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number.

limitinteger

Number of items per page. Requests above 100 are capped at 100.

keywordstring

Keyword to filter annotations by question or answer content.

Response

Successfully retrieved annotation list.

has_moreboolean

true if more pages are available beyond the current result set.

limitinteger

Number of items per page.

pageinteger

Current page number.

totalinteger

Total number of annotations matching the query.

Changes

  • 1647da477789Revision changes
    • warning

      for the query request parameter limit, the min was set to 1.00

    • warning

      for the query request parameter page, the min was set to 1.00