Get annotation queues

GET /api/v1/annotation-queues

Error

A valid request URL is required to generate request examples

200

[
  {
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "total_runs": 123,
    "description": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "num_reviewers_per_item": 1,
    "enable_reservations": true,
    "reservation_minutes": 1,
    "reviewer_access_mode": "any",
    "source_rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "run_rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "default_dataset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metadata": {},
    "assigned_reviewers": []
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Query Parameters

ids · string<uuid>[] | null

name · string | null

name_contains · string | null

offset · integer · default: 0

Required range: x >= 0

limit · integer · default: 100

Required range: 1 <= x <= 100

tag_value_id · string<uuid>[] | null

dataset_id · string<uuid> | null

queue_type · enum<string> | null

Available options: single, pairwise

assigned_to_me · boolean · default: false

sort_by · string | null

sort_by_desc · boolean · default: true

Response

200

application/json

Successful Response

name · string · required

id · string<uuid> · required

tenant_id · string<uuid> · required

queue_type · enum<string> · required

Available options: single, pairwise

total_runs · integer · required

description · string | null

created_at · string<date-time>

updated_at · string<date-time>

num_reviewers_per_item · integer | null · default: 1

enable_reservations · boolean | null · default: true

reservation_minutes · integer | null · default: 1

reviewer_access_mode · string · default: any

source_rule_id · string<uuid> | null

run_rule_id · string<uuid> | null

default_dataset · string<uuid> | null

metadata · Metadata · object | null

assigned_reviewers · AssignedReviewerSchema · object[]

Show child attributes