Galileo Technologies annotation_queue API
The annotation_queue API from Galileo Technologies — 18 operation(s) for annotation_queue.
The annotation_queue API from Galileo Technologies — 18 operation(s) for annotation_queue.
openapi: 3.1.0
info:
title: Galileo API Server annotation annotation_queue API
version: 1.1085.0
servers:
- url: https://api.galileo.ai
description: Galileo API Server - galileo-v2
tags:
- name: annotation_queue
paths:
/annotation_queues:
post:
tags:
- annotation_queue
summary: Create Annotation Queue
description: 'Create an annotation queue at the organization level.
The creator will automatically be granted the ''owner'' role.
Optionally accepts a list of annotator emails. Users that don''t exist in the organization will be invited.
Optionally copies templates from an existing queue if copy_templates_from_queue_id is provided.'
operationId: create_annotation_queue_annotation_queues_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAnnotationQueueRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationQueueResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
/annotation_queues/{queue_id}:
delete:
tags:
- annotation_queue
summary: Delete Annotation Queue
description: Delete an annotation queue.
operationId: delete_annotation_queue_annotation_queues__queue_id__delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- annotation_queue
summary: Get Annotation Queue
description: Get an annotation queue by ID with templates and counts.
operationId: get_annotation_queue_annotation_queues__queue_id__get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationQueueResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- annotation_queue
summary: Update Annotation Queue
description: Update an annotation queue.
operationId: update_annotation_queue_annotation_queues__queue_id__patch
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAnnotationQueueRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationQueueResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/annotation_queues/{queue_id}/users:
post:
tags:
- annotation_queue
summary: Share Annotation Queue With Users
description: 'Share an annotation queue with users by granting them specific roles.
Users can be specified by user_id or email. If using email and the user doesn''t exist
in the organization, they will be invited automatically with the ''user'' role.
Roles: owner, annotator'
operationId: share_annotation_queue_with_users_annotation_queues__queue_id__users_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AnnotationQueueUserCollaboratorCreate'
title: Body
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/UserAnnotationQueueCollaborator'
title: Response Share Annotation Queue With Users Annotation Queues Queue Id Users Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- annotation_queue
summary: List Annotation Queue Users
description: List users who have access to an annotation queue with pagination.
operationId: list_annotation_queue_users_annotation_queues__queue_id__users_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
- name: starting_token
in: query
required: false
schema:
type: integer
default: 0
title: Starting Token
- name: limit
in: query
required: false
schema:
type: integer
default: 100
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListAnnotationQueueCollaboratorsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/annotation_queues/{queue_id}/users/{user_id}:
delete:
tags:
- annotation_queue
summary: Remove Annotation Queue User
description: Remove a user's access to an annotation queue.
operationId: remove_annotation_queue_user_annotation_queues__queue_id__users__user_id__delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
- name: user_id
in: path
required: true
schema:
type: string
format: uuid4
title: User Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- annotation_queue
summary: Update Annotation Queue User Role
description: Update a user's role for an annotation queue.
operationId: update_annotation_queue_user_role_annotation_queues__queue_id__users__user_id__patch
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
- name: user_id
in: path
required: true
schema:
type: string
format: uuid4
title: User Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationQueueUserCollaboratorUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/UserAnnotationQueueCollaborator'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/annotation_queues/{queue_id}/details:
get:
tags:
- annotation_queue
summary: Queue Details
operationId: queue_details_annotation_queues__queue_id__details_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationQueueDetailsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/annotation_queues/count:
post:
tags:
- annotation_queue
summary: Count Annotation Queues
description: Count annotation queues in the user's organization with filtering.
operationId: count_annotation_queues_annotation_queues_count_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListAnnotationQueueParams'
default:
filters: []
sort:
name: created_at
ascending: false
sort_type: column
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationQueueCountResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
/annotation_queues/query:
post:
tags:
- annotation_queue
summary: Query Annotation Queues
description: 'Query annotation queues in the user''s organization with filtering and sorting.
Response includes num_templates for each queue to support copy selection UI.'
operationId: query_annotation_queues_annotation_queues_query_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: starting_token
in: query
required: false
schema:
type: integer
default: 0
title: Starting Token
- name: limit
in: query
required: false
schema:
type: integer
default: 100
title: Limit
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListAnnotationQueueParams'
default:
filters: []
sort:
name: created_at
ascending: false
sort_type: column
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListAnnotationQueueResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/annotation_queues/{queue_id}/templates/reorder:
post:
tags:
- annotation_queue
summary: Reorder Queue Templates
description: 'Reorder templates within an annotation queue.
The ordering must include all and only the template IDs currently in the queue.
Templates will be assigned positions 1, 2, 3... based on their order in the list.'
operationId: reorder_queue_templates_annotation_queues__queue_id__templates_reorder_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationTemplateReorder'
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/annotation_queues/{queue_id}/templates:
get:
tags:
- annotation_queue
summary: Get Queue Templates
description: 'Get all templates for an annotation queue.
Templates are returned ordered by position (ascending).'
operationId: get_queue_templates_annotation_queues__queue_id__templates_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AnnotationTemplateDB'
title: Response Get Queue Templates Annotation Queues Queue Id Templates Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- annotation_queue
summary: Create Queue Template
description: 'Create template(s) in an annotation queue.
Supports two scenarios:
1. Create a single template: Provide ''template'' field
2. Copy all templates from source queue: Provide ''copy_from_queue_id'' field'
operationId: create_queue_template_annotation_queues__queue_id__templates_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateQueueTemplateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AnnotationTemplateDB'
title: Response Create Queue Template Annotation Queues Queue Id Templates Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/annotation_queues/{queue_id}/templates/{template_id}:
patch:
tags:
- annotation_queue
summary: Update Queue Template
description: 'Update an existing template in an annotation queue.
Can update:
- Template name (must be unique within the queue)
- Template criteria
Note: Constraints and other fields cannot be updated.'
operationId: update_queue_template_annotation_queues__queue_id__templates__template_id__patch
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationTemplateUpdate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationTemplateDB'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- annotation_queue
summary: Delete Queue Template
description: 'Delete a template from an annotation queue.
Validates that:
- Template exists
- Template belongs to the specified queue
- User has UPDATE permission on the queue
After deletion, remaining templates are renumbered to maintain sequential positions.'
operationId: delete_queue_template_annotation_queues__queue_id__templates__template_id__delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v2/annotation_queues/{queue_id}:
get:
tags:
- annotation_queue
summary: Get Annotation Queue
description: Get an annotation queue by ID with templates and counts.
operationId: get_annotation_queue_v2_annotation_queues__queue_id__get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationQueueResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v2/annotation_queues/query:
post:
tags:
- annotation_queue
summary: Query Annotation Queues
description: 'Query annotation queues in the user''s organization with filtering and sorting.
Response includes num_templates for each queue to support copy selection UI.'
operationId: query_annotation_queues_v2_annotation_queues_query_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: starting_token
in: query
required: false
schema:
type: integer
default: 0
title: Starting Token
- name: limit
in: query
required: false
schema:
type: integer
default: 100
title: Limit
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListAnnotationQueueParams'
default:
filters: []
sort:
name: created_at
ascending: false
sort_type: column
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListAnnotationQueueResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v2/annotation_queues/{queue_id}/templates:
get:
tags:
- annotation_queue
summary: Get Queue Templates
description: 'Get all templates for an annotation queue.
Templates are returned ordered by position (ascending).'
operationId: get_queue_templates_v2_annotation_queues__queue_id__templates_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AnnotationTemplateDB'
title: Response Get Queue Templates V2 Annotation Queues Queue Id Templates Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v2/annotation_queues/{queue_id}/users:
get:
tags:
- annotation_queue
summary: List Annotation Queue Users
description: List users who have access to an annotation queue with pagination.
operationId: list_annotation_queue_users_v2_annotation_queues__queue_id__users_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
- name: starting_token
in: query
required: false
schema:
type: integer
default: 0
title: Starting Token
- name: limit
in: query
required: false
schema:
type: integer
default: 100
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListAnnotationQueueCollaboratorsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/public/v2/annotation_queues/{queue_id}:
get:
tags:
- annotation_queue
summary: Get Annotation Queue
description: Get an annotation queue by ID with templates and counts.
operationId: get_annotation_queue_public_v2_annotation_queues__queue_id__get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationQueueResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/public/v2/annotation_queues/query:
post:
tags:
- annotation_queue
summary: Query Annotation Queues
description: 'Query annotation queues in the user''s organization with filtering and sorting.
Response includes num_templates for each queue to support copy selection UI.'
operationId: query_annotation_queues_public_v2_annotation_queues_query_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: starting_token
in: query
required: false
schema:
type: integer
default: 0
title: Starting Token
- name: limit
in: query
required: false
schema:
type: integer
default: 100
title: Limit
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListAnnotationQueueParams'
default:
filters: []
sort:
name: created_at
ascending: false
sort_type: column
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListAnnotationQueueResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/public/v2/annotation_queues/{queue_id}/templates:
get:
tags:
- annotation_queue
summary: Get Queue Templates
description: 'Get all templates for an annotation queue.
Templates are returned ordered by position (ascending).'
operationId: get_queue_templates_public_v2_annotation_queues__queue_id__templates_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AnnotationTemplateDB'
title: Response Get Queue Templates Public V2 Annotation Queues Queue Id Templates Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/public/v2/annotation_queues/{queue_id}/users:
get:
tags:
- annotation_queue
summary: List Annotation Queue Users
description: List users who have access to an annotation queue with pagination.
operationId: list_annotation_queue_users_public_v2_annotation_queues__queue_id__users_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: queue_id
in: path
required: true
schema:
type: string
format: uuid4
title: Queue Id
- name: starting_token
in: query
required: false
schema:
type: integer
default: 0
title: Starting Token
- name: limit
in: query
required: false
schema:
type: integer
default: 100
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListAnnotationQueueCollaboratorsResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
AnnotationAgreementBucket:
properties:
min_inclusive:
type: number
title: Min Inclusive
max_exclusive:
anyOf:
- type: number
- type: 'null'
title: Max Exclusive
count:
type: integer
title: Count
type: object
required:
- min_inclusive
- max_exclusive
- count
title: AnnotationAgreementBucket
AnnotationQueueCountResponse:
properties:
total_count:
type: integer
title: Total Count
description: Total number of annotation queues matching the filters
type: object
required:
- total_count
title: AnnotationQueueCountResponse
AnnotationTemplateReorder:
properties:
ordering:
items:
type: string
format: uuid4
type: array
title: Ordering
type: object
required:
- ordering
title: AnnotationTemplateReorder
description: 'Request to re-order the annotation templates of a project.
- Expects a list of strings where each string is the ID of a template in the project in the order
we want the templates to appear in.
- Expects the list to be complete list of all template IDs.'
AnnotationTagsAggregate:
properties:
annotation_type:
type: string
const: tags
title: Annotation Type
default: tags
counts:
additionalProperties:
type: integer
type: object
title: Counts
unrated_count:
type: integer
title: Unrated Count
type: object
required:
- counts
- unrated_count
title: AnnotationTagsAggregate
AnnotationQueueNumTemplatesSort:
properties:
name:
type: string
const: num_templates
title: Name
default: num_templates
ascending:
type: boolean
title: Ascending
default: true
sort_type:
type: string
const: column
title: Sort Type
default: column
type: object
title: AnnotationQueueNumTemplatesSort
api__schemas__annotation__TagsConstraints:
properties:
annotation_type:
type: string
# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/galileo-technologies/refs/heads/main/openapi/galileo-technologies-annotation-queue-api-openapi.yml