For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Copy to LLMGithubGo to App
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
DocumentationIntegrationsBuilding Self-Improving AgentsSelf-hosting OpikSDK & API reference
    • Overview
  • Python SDK
    • Reference
    • REST API Client
  • Typescript SDK
    • Overview
    • Opik TS
    • Prompts
    • Opik Query Language (OQL)
  • Rest API
    • Overview
        • POSTAdd items to annotation queue
        • GETFind annotation queues
        • POSTCreate annotation queue
        • POSTCreate annotation queue batch
        • POSTDelete annotation queue batch
        • GETGet annotation queue by id
        • PATCHUpdate annotation queue
        • POSTRemove items from annotation queue
LogoLogo
Copy to LLMGithubGo to App
Rest APIAPI ReferenceAnnotation Queues

Find annotation queues

GET
/v1/private/annotation-queues
GET
/api/v1/private/annotation-queues
$curl http://localhost:5173/api/v1/private/annotation-queues
200Retrieved
1{
2 "page": 1,
3 "size": 1,
4 "total": 1,
5 "content": [
6 {
7 "project_id": "string",
8 "name": "string",
9 "scope": "trace",
10 "id": "string",
11 "project_name": "string",
12 "description": "string",
13 "instructions": "string",
14 "comments_enabled": true,
15 "feedback_definition_names": [
16 "string"
17 ],
18 "reviewers": [
19 {
20 "username": "string",
21 "status": 1
22 }
23 ],
24 "feedback_scores": [
25 {
26 "name": "string",
27 "value": 1.1
28 }
29 ],
30 "items_count": 1,
31 "created_at": "2024-01-15T09:30:00Z",
32 "created_by": "string",
33 "last_updated_at": "2024-01-15T09:30:00Z",
34 "last_updated_by": "string"
35 }
36 ],
37 "sortableBy": [
38 "string"
39 ]
40}
Find annotation queues with filtering and sorting
Was this page helpful?
Previous

Create annotation queue

Next
Built with

Query parameters

pageintegerOptional>=1Defaults to 1
sizeintegerOptional>=1Defaults to 10
namestringOptional
filtersstringOptional
sortingstringOptional

Response

Annotation queues page
pageinteger
sizeinteger
totallong
contentlist of objects
sortableBylist of strings