Queue management

create

Creates a new annotation queue.

def create(
    self,
    name: str,
    *,
    description: Optional[str] = None,
    instructions: Optional[str] = None,
    assignment_strategy: Optional[str] = None,
    annotations_required: Optional[int] = None,
    reservation_timeout_minutes: Optional[int] = None,
    requires_review: Optional[bool] = None,
    project: Optional[str] = None,
    dataset: Optional[str] = None,
    agent_definition: Optional[str] = None,
    timeout: Optional[int] = None,
) -> QueueDetail

• Arguments:
  • name (str): Name of the annotation queue.
  • description (Optional[str]): Description of the queue’s purpose.
  • instructions (Optional[str]): Guidelines for annotators.
  • assignment_strategy (Optional[str]): How items are assigned — "manual", "round_robin", or "load_balanced".
  • annotations_required (Optional[int]): Number of annotations needed per item.
  • reservation_timeout_minutes (Optional[int]): Time limit (in minutes) for an annotator to complete an item.
  • requires_review (Optional[bool]): Whether completed annotations require reviewer approval.
  • project (Optional[str]): Project ID to scope the queue to.
  • dataset (Optional[str]): Dataset ID to associate with the queue.
  • agent_definition (Optional[str]): Agent definition ID to associate with the queue.
  • timeout (Optional[int]): Request timeout in seconds.
• Returns:
  • QueueDetail instance

list_queues

Lists annotation queues with optional filters.

def list_queues(
    self,
    *,
    status: Optional[str] = None,
    search: Optional[str] = None,
    include_counts: bool = True,
    page: int = 1,
    page_size: int = 20,
    timeout: Optional[int] = None,
) -> List[QueueDetail]

• Arguments:
  • status (Optional[str]): Filter by queue status — "draft", "active", "paused", or "completed".
  • search (Optional[str]): Search queues by name.
  • include_counts (bool): Whether to include item/completed counts. Defaults to True.
  • page (int): Page number for pagination. Defaults to 1.
  • page_size (int): Number of results per page. Defaults to 20.
  • timeout (Optional[int]): Request timeout in seconds.
• Returns:
  • List[QueueDetail]

get

Gets a single annotation queue by ID or name.

def get(
    self,
    queue_id: Optional[str] = None,
    *,
    queue_name: Optional[str] = None,
    timeout: Optional[int] = None,
) -> QueueDetail

• Arguments:
  • queue_id (Optional[str]): UUID of the annotation queue.
  • queue_name (Optional[str]): Name of the annotation queue (alternative to queue_id).
  • timeout (Optional[int]): Request timeout in seconds.
• Returns:
  • QueueDetail instance

update

Updates an annotation queue.

def update(
    self,
    queue_id: Optional[str] = None,
    *,
    queue_name: Optional[str] = None,
    name: Optional[str] = None,
    description: Optional[str] = None,
    instructions: Optional[str] = None,
    assignment_strategy: Optional[str] = None,
    annotations_required: Optional[int] = None,
    reservation_timeout_minutes: Optional[int] = None,
    requires_review: Optional[bool] = None,
    timeout: Optional[int] = None,
) -> QueueDetail

• Arguments:
  • queue_id (Optional[str]): UUID of the annotation queue.
  • queue_name (Optional[str]): Name of the annotation queue (alternative to queue_id).
  • name (Optional[str]): Updated queue name.
  • description (Optional[str]): Updated description.
  • instructions (Optional[str]): Updated annotator instructions.
  • assignment_strategy (Optional[str]): Updated assignment strategy.
  • annotations_required (Optional[int]): Updated annotations required per item.
  • reservation_timeout_minutes (Optional[int]): Updated reservation timeout.
  • requires_review (Optional[bool]): Updated review requirement.
  • timeout (Optional[int]): Request timeout in seconds.
• Returns:
  • QueueDetail instance

delete

Deletes (soft-deletes) an annotation queue.

def delete(
    self,
    queue_id: Optional[str] = None,
    *,
    queue_name: Optional[str] = None,
    timeout: Optional[int] = None,
) -> Dict[str, Any]

• Arguments:
  • queue_id (Optional[str]): UUID of the annotation queue.
  • queue_name (Optional[str]): Name of the annotation queue (alternative to queue_id).
  • timeout (Optional[int]): Request timeout in seconds.
• Returns:
  • Dict[str, Any]