Skip to main content
GET
/
v0
/
annotations
List annotations
curl --request GET \
  --url https://api.avidoai.com/v0/annotations \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>'
{
  "data": [
    {
      "id": "789e4567-e89b-12d3-a456-426614174000",
      "orgId": "org_123456",
      "title": "New system prompt",
      "description": "The system prompt was updated to include more examples",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z"
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 1,
    "totalPages": 1
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

​
x-application-id
string
header
required

Your unique Avido Application ID

Query Parameters

​
skip
integer
default:0

Number of items to skip before starting to collect the result set.

Required range: x >= 0
Example:

0

​
limit
integer
default:25

Number of items to include in the result set.

Required range: 1 <= x <= 100
Example:

25

​
orderBy
string
default:createdAt

Field to order by in the result set.

Example:

"createdAt"

​
orderDir
enum<string>
default:desc

Order direction.

Available options:
asc,
desc
Example:

"desc"

​
applicationSlug
string
required

Filter by application slug

Example:

"my-application"

​
title
string

Filter by annotation title (case-insensitive)

Example:

"system prompt"

Response

Successfully retrieved annotations

Paginated response containing annotations

​
data
Annotation · object[]
required
​
pagination
object
required

Pagination metadata returned in a paginated response.