Find annotation queues | Opik Documentation

GET/v1/private/annotation-queuesFind annotation queues

Find annotation queues with filtering and sorting

Parameters

pageinteger · int32query

default 1 · minimum 1

sizeinteger · int32query

default 10 · minimum 1

namestringquery

Filter annotation queues by name (partial match, case insensitive)

filtersstringquery

sortingstringquery

Responses

objectAnnotationQueuePage_Public

contentarray of object

Show child attributes

Show array items

annotators_per_iteminteger · int32

maximum 1000 · minimum 1

automationobject

Show child attributes

conditionsobject

Show child attributes

groupsarray of objectrequired

maxItems 5 · minItems 0

Show child attributes

maxItems 5 · minItems 0

Show array items

conditionsarray of objectrequired

maxItems 5 · minItems 0

Show child attributes

maxItems 5 · minItems 0

Show array items

operatorstringrequired

one of ">", "<", "="

score_namestringrequired

maxLength 255 · minLength 0

valuenumber · doublerequired

enabledboolean

max_items_in_queueinteger · int32

comments_enabledboolean

created_atstring · date-time

created_bystring

descriptionstring

feedback_definition_namesarray of string

Show child attributes

feedback_scoresarray of object

Show child attributes

Show array items

namestringrequired

minLength 1

valuenumberrequired

idstring · uuid

instructionsstring

items_countinteger · int64

last_updated_atstring · date-time

last_updated_bystring

lock_timeout_secondsinteger · int32

maximum 3600 · minimum 1

namestringrequired

minLength 1

project_idstring · uuidrequired

project_namestring

reviewersarray of object

Show child attributes

Show array items

statusinteger · int64

usernamestring

scopestringrequired

one of "trace", "thread"

pageinteger · int32

sizeinteger · int32

sortableByarray of string

Show child attributes

totalinteger · int64

Example response

{
  "content": [
    {
      "annotators_per_item": 0,
      "automation": {
        "conditions": {
          "groups": [
            {
              "conditions": [
                {
                  "operator": "<",
                  "score_name": "string",
                  "value": 0
                }
              ]
            }
          ]
        },
        "enabled": true,
        "max_items_in_queue": 0
      },
      "comments_enabled": true,
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "description": "string",
      "feedback_definition_names": [
        "string"
      ],
      "feedback_scores": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "instructions": "string",
      "items_count": 0,
      "last_updated_at": "2026-06-09T00:00:00Z",
      "last_updated_by": "string",
      "lock_timeout_seconds": 0,
      "name": "string",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "project_name": "string",
      "reviewers": [
        {
          "status": 0,
          "username": "string"
        }
      ],
      "scope": "thread"
    }
  ],
  "page": 0,
  "size": 0,
  "sortableBy": [
    "string"
  ],
  "total": 0
}

Examples

pagequery parameter

sizequery parameter

namequery parameter

filtersquery parameter

sortingquery parameter

curl -X GET 'http://localhost:5173/api/v1/private/annotation-queues?filters=string&name=string&page=1&size=10&sorting=string'

const response = await fetch('http://localhost:5173/api/v1/private/annotation-queues?filters=string&name=string&page=1&size=10&sorting=string', { method: 'GET' });
const data = await response.json();

const response = await fetch('http://localhost:5173/api/v1/private/annotation-queues?filters=string&name=string&page=1&size=10&sorting=string', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "http://localhost:5173/api/v1/private/annotation-queues?filters=string&name=string&page=1&size=10&sorting=string")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "http://localhost:5173/api/v1/private/annotation-queues?filters=string&name=string&page=1&size=10&sorting=string", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("http://localhost:5173/api/v1/private/annotation-queues?filters=string&name=string&page=1&size=10&sorting=string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("http://localhost:5173/api/v1/private/annotation-queues?filters=string&name=string&page=1&size=10&sorting=string"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("http://localhost:5173/api/v1/private/annotation-queues?filters=string&name=string&page=1&size=10&sorting=string")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:5173/api/v1/private/annotation-queues?filters=string&name=string&page=1&size=10&sorting=string");
using var response = await client.SendAsync(request);

{
  "content": [
    {
      "annotators_per_item": 0,
      "automation": {
        "conditions": {
          "groups": [
            {
              "conditions": [
                {
                  "operator": "<",
                  "score_name": "string",
                  "value": 0
                }
              ]
            }
          ]
        },
        "enabled": true,
        "max_items_in_queue": 0
      },
      "comments_enabled": true,
      "created_at": "2026-06-09T00:00:00Z",
      "created_by": "string",
      "description": "string",
      "feedback_definition_names": [
        "string"
      ],
      "feedback_scores": [
        {
          "name": "string",
          "value": 0
        }
      ],
      "id": "00000000-0000-0000-0000-000000000000",
      "instructions": "string",
      "items_count": 0,
      "last_updated_at": "2026-06-09T00:00:00Z",
      "last_updated_by": "string",
      "lock_timeout_seconds": 0,
      "name": "string",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "project_name": "string",
      "reviewers": [
        {
          "status": 0,
          "username": "string"
        }
      ],
      "scope": "thread"
    }
  ],
  "page": 0,
  "size": 0,
  "sortableBy": [
    "string"
  ],
  "total": 0
}