Skip to main content
PATCH
Error

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
queue_id
string<uuid>
required

ID of the annotation queue.

Body

application/json

AnnotationQueue update schema.

​
name
string | null

New name for the queue.

​
description
string | null

New description.

​
default_dataset
string<uuid> | null

Dataset that reviewed runs are added to by default.

​
num_reviewers_per_item
default:{"__missing__":"__missing__"}

How many reviewers must review each run.

​
enable_reservations
default:{"__missing__":"__missing__"}

Whether a reviewer reserves a run while reviewing it, so others skip it.

​
reservation_minutes
default:{"__missing__":"__missing__"}

How long a reservation lasts, in minutes.

​
rubric_items
AnnotationQueueRubricItemSchema · object[] | null

Feedback keys reviewers fill in for each run.

​
rubric_instructions
string | null

Instructions shown to reviewers.

​
metadata
Metadata · object

Metadata to store on the queue. Replaces the existing metadata.

​
reviewer_access_mode
enum<string> | null

Who completes a run: any (one reviewer is enough) or assigned (every assigned reviewer must submit).

Available options:
any,
assigned

Response

Successful Response