Galileo Technologies annotation API
The annotation API from Galileo Technologies — 12 operation(s) for annotation.
The annotation API from Galileo Technologies — 12 operation(s) for annotation.
openapi: 3.1.0
info:
title: Galileo API Server annotation API
version: 1.1085.0
servers:
- url: https://api.galileo.ai
description: Galileo API Server - galileo-v2
tags:
- name: annotation
paths:
/v2/projects/{project_id}/annotation/templates:
post:
tags:
- annotation
summary: Create Annotation Template
operationId: create_annotation_template_v2_projects__project_id__annotation_templates_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationTemplateCreate'
examples:
- name: creativity
criteria: How creative was the response?
constraints:
annotation_type: score
min: 1
max: 10
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'
get:
tags:
- annotation
summary: List Annotation Templates
operationId: list_annotation_templates_v2_projects__project_id__annotation_templates_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AnnotationTemplateDB'
title: Response List Annotation Templates V2 Projects Project Id Annotation Templates Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v2/projects/{project_id}/annotation/templates/{template_id}:
patch:
tags:
- annotation
summary: Update Annotation Template
operationId: update_annotation_template_v2_projects__project_id__annotation_templates__template_id__patch
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template 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'
get:
tags:
- annotation
summary: Get Annotation Template
operationId: get_annotation_template_v2_projects__project_id__annotation_templates__template_id__get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
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
summary: Delete Annotation Template
operationId: delete_annotation_template_v2_projects__project_id__annotation_templates__template_id__delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v2/projects/{project_id}/annotation/templates/reorder:
post:
tags:
- annotation
summary: Reorder Annotation Templates
operationId: reorder_annotation_templates_v2_projects__project_id__annotation_templates_reorder_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project 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'
/v2/projects/{project_id}/annotation/templates/{template_id}/traces/{trace_id}/rating:
put:
tags:
- annotation
summary: Create Annotation Rating
operationId: create_annotation_rating_v2_projects__project_id__annotation_templates__template_id__traces__trace_id__rating_put
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: trace_id
in: path
required: true
schema:
type: string
format: uuid4
title: Trace Id
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationRatingCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationRatingDB'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- annotation
summary: Get Annotation Rating
operationId: get_annotation_rating_v2_projects__project_id__annotation_templates__template_id__traces__trace_id__rating_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
- name: trace_id
in: path
required: true
schema:
type: string
format: uuid4
title: Trace Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationRatingDB'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- annotation
summary: Delete Annotation Rating
operationId: delete_annotation_rating_v2_projects__project_id__annotation_templates__template_id__traces__trace_id__rating_delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: trace_id
in: path
required: true
schema:
type: string
format: uuid4
title: Trace Id
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v2/projects/{project_id}/annotation/templates/{template_id}/records/{record_id}/rating:
put:
tags:
- annotation
summary: Create Log Record Annotation Rating
operationId: create_log_record_annotation_rating_v2_projects__project_id__annotation_templates__template_id__records__record_id__rating_put
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: record_id
in: path
required: true
schema:
type: string
format: uuid4
title: Record Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationRatingCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationRatingDB'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- annotation
summary: Get Log Record Annotation Rating
operationId: get_log_record_annotation_rating_v2_projects__project_id__annotation_templates__template_id__records__record_id__rating_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
- name: record_id
in: path
required: true
schema:
type: string
format: uuid4
title: Record Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationRatingDB'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- annotation
summary: Delete Log Record Annotation Rating
operationId: delete_log_record_annotation_rating_v2_projects__project_id__annotation_templates__template_id__records__record_id__rating_delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
- name: record_id
in: path
required: true
schema:
type: string
format: uuid4
title: Record Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v2/projects/{project_id}/annotation/ratings:
post:
tags:
- annotation
summary: Apply Bulk Annotation
operationId: apply_bulk_annotation_v2_projects__project_id__annotation_ratings_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BulkAnnotationRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BulkAnnotationRatingStatus'
title: Response Apply Bulk Annotation V2 Projects Project Id Annotation Ratings Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/public/v2/projects/{project_id}/annotation/templates:
post:
tags:
- annotation
summary: Create Annotation Template
operationId: create_annotation_template_public_v2_projects__project_id__annotation_templates_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationTemplateCreate'
examples:
- name: creativity
criteria: How creative was the response?
constraints:
annotation_type: score
min: 1
max: 10
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'
get:
tags:
- annotation
summary: List Annotation Templates
operationId: list_annotation_templates_public_v2_projects__project_id__annotation_templates_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AnnotationTemplateDB'
title: Response List Annotation Templates Public V2 Projects Project Id Annotation Templates Get
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/public/v2/projects/{project_id}/annotation/templates/{template_id}:
patch:
tags:
- annotation
summary: Update Annotation Template
operationId: update_annotation_template_public_v2_projects__project_id__annotation_templates__template_id__patch
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template 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'
get:
tags:
- annotation
summary: Get Annotation Template
operationId: get_annotation_template_public_v2_projects__project_id__annotation_templates__template_id__get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
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
summary: Delete Annotation Template
operationId: delete_annotation_template_public_v2_projects__project_id__annotation_templates__template_id__delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/public/v2/projects/{project_id}/annotation/templates/reorder:
post:
tags:
- annotation
summary: Reorder Annotation Templates
operationId: reorder_annotation_templates_public_v2_projects__project_id__annotation_templates_reorder_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project 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'
/public/v2/projects/{project_id}/annotation/templates/{template_id}/traces/{trace_id}/rating:
put:
tags:
- annotation
summary: Create Annotation Rating
operationId: create_annotation_rating_public_v2_projects__project_id__annotation_templates__template_id__traces__trace_id__rating_put
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: trace_id
in: path
required: true
schema:
type: string
format: uuid4
title: Trace Id
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationRatingCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationRatingDB'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- annotation
summary: Get Annotation Rating
operationId: get_annotation_rating_public_v2_projects__project_id__annotation_templates__template_id__traces__trace_id__rating_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
- name: trace_id
in: path
required: true
schema:
type: string
format: uuid4
title: Trace Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationRatingDB'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- annotation
summary: Delete Annotation Rating
operationId: delete_annotation_rating_public_v2_projects__project_id__annotation_templates__template_id__traces__trace_id__rating_delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: trace_id
in: path
required: true
schema:
type: string
format: uuid4
title: Trace Id
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/public/v2/projects/{project_id}/annotation/templates/{template_id}/records/{record_id}/rating:
put:
tags:
- annotation
summary: Create Log Record Annotation Rating
operationId: create_log_record_annotation_rating_public_v2_projects__project_id__annotation_templates__template_id__records__record_id__rating_put
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: record_id
in: path
required: true
schema:
type: string
format: uuid4
title: Record Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationRatingCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationRatingDB'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- annotation
summary: Get Log Record Annotation Rating
operationId: get_log_record_annotation_rating_public_v2_projects__project_id__annotation_templates__template_id__records__record_id__rating_get
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
- name: record_id
in: path
required: true
schema:
type: string
format: uuid4
title: Record Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationRatingDB'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- annotation
summary: Delete Log Record Annotation Rating
operationId: delete_log_record_annotation_rating_public_v2_projects__project_id__annotation_templates__template_id__records__record_id__rating_delete
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
- name: template_id
in: path
required: true
schema:
type: string
format: uuid4
title: Template Id
- name: record_id
in: path
required: true
schema:
type: string
format: uuid4
title: Record Id
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/public/v2/projects/{project_id}/annotation/ratings:
post:
tags:
- annotation
summary: Apply Bulk Annotation
operationId: apply_bulk_annotation_public_v2_projects__project_id__annotation_ratings_post
security:
- ClassicAPIKeyHeader: []
- APIKeyHeader: []
- OAuth2PasswordBearer: []
- HTTPBasic: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid4
title: Project Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/BulkAnnotationRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BulkAnnotationRatingStatus'
title: Response Apply Bulk Annotation Public V2 Projects Project Id Annotation Ratings Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
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.'
api__schemas__annotation__Tags
# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/galileo-technologies/refs/heads/main/openapi/galileo-technologies-annotation-api-openapi.yml