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

Get annotation queue by id

GET
/v1/private/annotation-queues/:id
GET
/api/v1/private/annotation-queues/:id
$curl http://localhost:5173/api/v1/private/annotation-queues/id
1{
2  "project_id": "string",
3  "name": "string",
4  "scope": "trace",
5  "id": "string",
6  "project_name": "string",
7  "description": "string",
8  "instructions": "string",
9  "comments_enabled": true,
10  "feedback_definition_names": [
11    "string"
12  ],
13  "reviewers": [
14    {
15      "username": "string",
16      "status": 1
17    }
18  ],
19  "feedback_scores": [
20    {
21      "name": "string",
22      "value": 1.1
23    }
24  ],
25  "items_count": 1,
26  "created_at": "2024-01-15T09:30:00Z",
27  "created_by": "string",
28  "last_updated_at": "2024-01-15T09:30:00Z",
29  "last_updated_by": "string"
30}
Get annotation queue by id
Was this page helpful?
Previous

Update annotation queue

Next
Built with

Path parameters

idstringRequiredformat: "uuid"

Response

Annotation queue resource
project_idstringformat: "uuid"
namestring>=1 character
scopeenum
Allowed values:
idstringformat: "uuid"
project_namestringRead-only
descriptionstring
instructionsstring
comments_enabledboolean
feedback_definition_nameslist of strings
reviewerslist of objectsRead-only
feedback_scoreslist of objectsRead-only
items_countlongRead-only
created_atdatetimeRead-only
created_bystringRead-only
last_updated_atdatetimeRead-only
last_updated_bystringRead-only

Errors

404
Not Found Error