List Annotations | Dify Octri Demo

3 parameters

pageintegeroptional

Page number.

Default:1

limitintegeroptional

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

Default:20

keywordstringoptional

Keyword to filter annotations by question or answer content.

1 status code

200Successfully retrieved annotation list.

dataarray<object>optional

List of annotation items for the current page.

has_morebooleanoptional

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

limitintegeroptional

Number of items per page.

pageintegeroptional

Current page number.

totalintegeroptional

Total number of annotations matching the query.

import { Client } from "dify-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://{api_base_url}",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.annotations.list({
  page: 1,
  limit: 20,
  keyword: "example",
});

{
  "data": [
    {
      "answer": "Dify is an open-source LLM application development platform.",
      "created_at": 1705407629,
      "hit_count": 5,
      "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "question": "What is Dify?"
    }
  ],
  "has_more": false,
  "limit": 20,
  "page": 1,
  "total": 1
}

Request

Response