Skip to main content
GET
/
api
/
v1
/
annotation-queues
/
{queue_id}
Error
A valid request URL is required to generate request examples
{
  "name": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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": [],
  "rubric_items": [
    {
      "feedback_key": "<string>",
      "description": "<string>",
      "value_descriptions": {},
      "score_descriptions": {},
      "is_required": true,
      "is_assertion": true
    }
  ],
  "rubric_instructions": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
queue_id
string<uuid>
required

Response

Successful Response

AnnotationQueue schema with rubric.

​
name
string
required
​
id
string<uuid>
required
​
tenant_id
string<uuid>
required
​
queue_type
enum<string>
required
Available options:
single,
pairwise
​
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
​
assigned_reviewers
AssignedReviewerSchema · object[]
​
rubric_items
AnnotationQueueRubricItemSchema · object[] | null
​
rubric_instructions
string | null