Skip to main content
GET
/
apps
/
annotations
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "question": "What is Dify?",
      "answer": "Dify is an open-source LLM application development platform.",
      "hit_count": 5,
      "created_at": 1705407629
    }
  ],
  "has_more": false,
  "limit": 20,
  "total": 1,
  "page": 1
}

Authorizations

Authorization
string
header
required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with Bearer. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Query Parameters

page
integer
default:1

Page number for pagination.

limit
integer
default:20

Number of items per page.

keyword
string

Keyword to filter annotations by question or answer content.

Response

200 - application/json

Successfully retrieved annotation list.

data
object[]

List of annotation items for the current page.

has_more
boolean

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

limit
integer

Number of items per page.

total
integer

Total number of annotations matching the query.

page
integer

Current page number.