AnnosaurusClient reference¶

Generated from specs/annosaurus.yaml, cross-referenced against vars_client.generated.annosaurus. Regenerate with just docs-generate after just generate picks up spec changes -- do not hand-edit this file.

See also: data models.

Health¶

Health check¶

GET /v1/health

result = await client.annosaurus.v1.health.get()

Returns: Optional[HealthStatus]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Authorization¶

Exchange an API key for a JWT. Header format is Authorization: APIKEY <key>¶

POST /v1/auth

result = await client.annosaurus.v1.auth.post()

Returns: Optional[AuthorizationSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Analysis¶

Generate a histogram of depths base on the query constraints¶

POST /v1/histogram/depth

# body: QueryConstraints
from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.histogram.depth.depth_request_builder import DepthRequestBuilder

request_configuration = RequestConfiguration(query_parameters=DepthRequestBuilder.DepthRequestBuilderPostQueryParameters(size=...))
result = await client.annosaurus.v1.histogram.depth.post(body, request_configuration)

Query parameters:

• size: Optional[int]

Returns: Optional[QueryConstraintsResponseSC_DepthHistogramSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Generate a histogram of times base on the query constraints¶

POST /v1/histogram/time

# body: QueryConstraints
from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.histogram.time.time_request_builder import TimeRequestBuilder

request_configuration = RequestConfiguration(query_parameters=TimeRequestBuilder.TimeRequestBuilderPostQueryParameters(size=...))
result = await client.annosaurus.v1.histogram.time.post(body, request_configuration)

Query parameters:

• size: Optional[int]

Returns: Optional[QueryConstraintsResponseSC_TimeHistogramSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Annotations¶

Update multiple annotations. This will not update imageReferences, associations, or ancillary data¶

PUT /v1/annotations/bulk

# body: list[AnnotationUpdateSC]
result = await client.annosaurus.v1.annotations.bulk.put(body)

Returns: Optional[list[AnnotationSC]]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Create a new annotation¶

POST /v1/annotations/bulk

# body: list[BulkAnnotationSC]
result = await client.annosaurus.v1.annotations.bulk.post(body)

Returns: Optional[list[AnnotationSC]]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Count concurrent annotations. JSON body can be snake_case or camelCase¶

POST /v1/annotations/concurrent/count

# body: ConcurrentRequest
result = await client.annosaurus.v1.annotations.concurrent.count.post(body)

Returns: Optional[ConcurrentRequestCountSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find an annotation by one of its association UUIDs¶

GET /v1/annotations/association/{associationUuid}

result = await client.annosaurus.v1.annotations.association.by_association_uuid(association_uuid).get()

Returns: Optional[AnnotationSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find an annotation by its image reference UUID¶

GET /v1/annotations/imagereference/{imageReferenceUuid}

result = await client.annosaurus.v1.annotations.imagereference.by_image_reference_uuid(image_reference_uuid).get()

Returns: Optional[list[AnnotationSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count multiple annotations. JSON body can be snake_case or camelCase¶

POST /v1/annotations/multi/count

# body: MultiRequest
result = await client.annosaurus.v1.annotations.multi.count.post(body)

Returns: Optional[MultiRequestCountSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find annotations by its video reference UUID¶

GET /v1/annotations/videoreference/{videoReferenceUuid}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.annotations.videoreference.item.with_video_reference_uu_item_request_builder import WithVideoReferenceUuItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithVideoReferenceUuItemRequestBuilder.WithVideoReferenceUuItemRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.annosaurus.v1.annotations.videoreference.by_video_reference_uuid(video_reference_uuid).get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[AnnotationSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find an annotation by its UUID¶

GET /v1/annotations/{observationUuid}

result = await client.annosaurus.v1.annotations.by_observation_uuid(observation_uuid).get()

Returns: Optional[AnnotationSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Update an annotation. The request body can be camelCase or snake_case¶

PUT /v1/annotations/{observationUuid}

# body: AnnotationUpdateSC
result = await client.annosaurus.v1.annotations.by_observation_uuid(observation_uuid).put(body)

Returns: Optional[AnnotationSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Create a new annotation¶

POST /v1/annotations

# body: AnnotationCreateSC
result = await client.annosaurus.v1.annotations.post(body)

Returns: Optional[AnnotationSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Associations¶

Delete a list of associations by their UUIDs¶

POST /v1/associations/delete

# body: list[UUID]
result = await client.annosaurus.v1.associations.delete_path.post(body)

Returns: None

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Update a list of associations¶

PUT /v1/associations/bulk

# body: list[AssociationSC]
result = await client.annosaurus.v1.associations.bulk.put(body)

Returns: Optional[list[AssociationSC]]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Find associations by concept association request. Request can be camelCase or snake_case. Response will be snake_case.¶

POST /v1/associations/conceptassociations

# body: ConceptAssociationRequest
result = await client.annosaurus.v1.associations.conceptassociations.post(body)

Returns: Optional[ConceptAssociationResponseSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count associations by toConcept¶

GET /v1/associations/toconcept/count/{concept}

result = await client.annosaurus.v1.associations.toconcept.count.by_concept(concept).get()

Returns: Optional[ConceptCount]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Rename toConcept¶

PUT /v1/associations/toconcept/rename

# body: RenameConcept
result = await client.annosaurus.v1.associations.toconcept.rename.put(body)

Returns: Optional[RenameCountSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Find associations by its videoReferenceUuid and linkName¶

GET /v1/associations/{videoReferenceUuid}/{linkName}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.associations.item.item.with_link_name_item_request_builder import WithLinkNameItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithLinkNameItemRequestBuilder.WithLinkNameItemRequestBuilderGetQueryParameters(concept=...))
result = await client.annosaurus.v1.associations.by_association_uu_id(association_uu_id).by_link_name(link_name).get(request_configuration)

Query parameters:

• concept: Optional[str]

Returns: Optional[list[AssociationSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find an association by its UUID¶

GET /v1/associations/{associationUuid}

result = await client.annosaurus.v1.associations.by_association_uu_id(association_uu_id).get()

Returns: Optional[AssociationSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Update an association¶

PUT /v1/associations/{associationUuid}

# body: AssociationUpdateSC
result = await client.annosaurus.v1.associations.by_association_uu_id(association_uu_id).put(body)

Returns: Optional[AssociationSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Delete an association¶

DELETE /v1/associations/{associationUuid}

result = await client.annosaurus.v1.associations.by_association_uu_id(association_uu_id).delete()

Returns: None

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Create an association¶

POST /v1/associations

# body: AssociationSC
result = await client.annosaurus.v1.associations.post(body)

Returns: Optional[AssociationSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Ancillary Data¶

Create many ancillary data¶

POST /v1/ancillarydata/bulk

# body: list[CachedAncillaryDatumSC]
result = await client.annosaurus.v1.ancillarydata.bulk.post(body)

Returns: Optional[list[CachedAncillaryDatumSC]]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Find ancillary data by imaged moment UUID¶

GET /v1/ancillarydata/imagedmoment/{imagedMomentUuid}

result = await client.annosaurus.v1.ancillarydata.imagedmoment.by_imaged_moment_uuid(imaged_moment_uuid).get()

Returns: Optional[CachedAncillaryDatumSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Merge ancillary data¶

PUT /v1/ancillarydata/merge/{videoReferenceUuid}

# body: list[CachedAncillaryDatumSC]
from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.ancillarydata.merge.item.with_video_reference_uu_item_request_builder import WithVideoReferenceUuItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithVideoReferenceUuItemRequestBuilder.WithVideoReferenceUuItemRequestBuilderPutQueryParameters(window=...))
result = await client.annosaurus.v1.ancillarydata.merge.by_video_reference_uuid(video_reference_uuid).put(body, request_configuration)

Query parameters:

• window: Optional[int]

Returns: Optional[list[CachedAncillaryDatumSC]]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Find ancillary data by observation UUID¶

GET /v1/ancillarydata/observation/{observationUuid}

result = await client.annosaurus.v1.ancillarydata.observation.by_observation_uuid(observation_uuid).get()

Returns: Optional[CachedAncillaryDatumSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find ancillary data by video reference UUID¶

GET /v1/ancillarydata/videoreference/{videoReferenceUuid}

result = await client.annosaurus.v1.ancillarydata.videoreference.by_video_reference_uuid(video_reference_uuid).get()

Returns: Optional[list[CachedAncillaryDatumSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Delete ancillary data by video reference UUID¶

DELETE /v1/ancillarydata/videoreference/{videoReferenceUuid}

result = await client.annosaurus.v1.ancillarydata.videoreference.by_video_reference_uuid(video_reference_uuid).delete()

Returns: Optional[CountForVideoReferenceSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Find ancillary data by UUID¶

GET /v1/ancillarydata/{ancillaryDataUuid}

result = await client.annosaurus.v1.ancillarydata.by_ancillary_data_uuid(ancillary_data_uuid).get()

Returns: Optional[CachedAncillaryDatumSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Update one ancillary data¶

PUT /v1/ancillarydata/{ancillaryDataUuid}

# body: CachedAncillaryDatumSC
result = await client.annosaurus.v1.ancillarydata.by_ancillary_data_uuid(ancillary_data_uuid).put(body)

Returns: Optional[CachedAncillaryDatumSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Create one ancillary data¶

POST /v1/ancillarydata

# body: CachedAncillaryDatumSC
result = await client.annosaurus.v1.ancillarydata.post(body)

Returns: Optional[CachedAncillaryDatumSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Video Information¶

Find video references by mission contact¶

GET /v1/videoreferences/missioncontact/{missioncontact}

result = await client.annosaurus.v1.videoreferences.missioncontact.by_missioncontact(missioncontact).get()

Returns: Optional[list[CachedVideoReferenceInfoSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all mission contacts¶

GET /v1/videoreferences/missioncontacts

result = await client.annosaurus.v1.videoreferences.missioncontacts.get()

Returns: Optional[list[str]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find video references by mission ID¶

GET /v1/videoreferences/missionid/{missionid}

result = await client.annosaurus.v1.videoreferences.missionid.by_missionid(missionid).get()

Returns: Optional[list[CachedVideoReferenceInfoSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all mission IDs¶

GET /v1/videoreferences/missionids

result = await client.annosaurus.v1.videoreferences.missionids.get()

Returns: Optional[list[str]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find a video reference info by a video reference UUID¶

GET /v1/videoreferences/videoreference/{videoReferenceUuid}

result = await client.annosaurus.v1.videoreferences.videoreference.by_video_reference_uuid(video_reference_uuid).get()

Returns: Optional[CachedVideoReferenceInfoSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all video reference UUIDs¶

GET /v1/videoreferences/videoreferences

result = await client.annosaurus.v1.videoreferences.videoreferences.get()

Returns: Optional[list[UUID]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find a video reference by UUID¶

GET /v1/videoreferences/{videoInfoUuid}

result = await client.annosaurus.v1.videoreferences.by_video_info_uuid(video_info_uuid).get()

Returns: Optional[CachedVideoReferenceInfoSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Update a video reference¶

PUT /v1/videoreferences/{videoInfoUuid}

# body: CachedVideoReferenceInfoUpdateSC
result = await client.annosaurus.v1.videoreferences.by_video_info_uuid(video_info_uuid).put(body)

Returns: Optional[CachedVideoReferenceInfoSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Delete a video reference¶

DELETE /v1/videoreferences/{videoInfoUuid}

result = await client.annosaurus.v1.videoreferences.by_video_info_uuid(video_info_uuid).delete()

Returns: None

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Find all video references¶

GET /v1/videoreferences

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.videoreferences.videoreferences_request_builder import VideoreferencesRequestBuilder

request_configuration = RequestConfiguration(query_parameters=VideoreferencesRequestBuilder.VideoreferencesRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.annosaurus.v1.videoreferences.get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[CachedVideoReferenceInfoSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Create a video reference¶

POST /v1/videoreferences

# body: CachedVideoReferenceInfoCreateSC
result = await client.annosaurus.v1.videoreferences.post(body)

Returns: Optional[CachedVideoReferenceInfoSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Fast Annotation Queries¶

Find annotations with images by concept¶

GET /v1/fast/concept/images/{concept}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.fast.concept.images.item.with_concept_item_request_builder import WithConceptItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithConceptItemRequestBuilder.WithConceptItemRequestBuilderGetQueryParameters(data=..., limit=..., offset=...))
result = await client.annosaurus.v1.fast.concept.images.by_concept(concept).get(request_configuration)

Query parameters:

• data: Optional[bool]
• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[AnnotationSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find annotations by concept¶

GET /v1/fast/concept/{concept}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.fast.concept.item.with_concept_item_request_builder import WithConceptItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithConceptItemRequestBuilder.WithConceptItemRequestBuilderGetQueryParameters(data=..., limit=..., offset=...))
result = await client.annosaurus.v1.fast.concept.by_concept(concept).get(request_configuration)

Query parameters:

• data: Optional[bool]
• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[AnnotationSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find annotations by concurrent request¶

POST /v1/fast/concurrent

# body: ConcurrentRequestSC
from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.fast.concurrent.concurrent_request_builder import ConcurrentRequestBuilder

request_configuration = RequestConfiguration(query_parameters=ConcurrentRequestBuilder.ConcurrentRequestBuilderPostQueryParameters(data=..., limit=..., offset=...))
result = await client.annosaurus.v1.fast.concurrent.post(body, request_configuration)

Query parameters:

• data: Optional[bool]
• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[AnnotationSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count all annotations¶

GET /v1/fast/count

result = await client.annosaurus.v1.fast.count.get()

Returns: Optional[Count]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count annotations by query constraints. Constraints can be snake_case or camelCase. The response will be in snake_case.¶

POST /v1/fast/count

# body: QueryConstraints
result = await client.annosaurus.v1.fast.count.post(body)

Returns: Optional[QueryConstraintsResponseSC_Count]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find annotations by link name and link value¶

GET /v1/fast/details/{link_name}/{link_value}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.fast.details.item.item.with_link_value_item_request_builder import WithLink_valueItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithLink_valueItemRequestBuilder.WithLink_valueItemRequestBuilderGetQueryParameters(data=...))
result = await client.annosaurus.v1.fast.details.by_link_name(link_name).by_link_value(link_value).get(request_configuration)

Query parameters:

• data: Optional[bool]

Returns: Optional[list[AnnotationSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find annotations by query constraints. Constraints can be snake_case or camelCase. The response will be in snake_case.¶

POST /v1/fast/georange

# body: QueryConstraints
result = await client.annosaurus.v1.fast.georange.post(body)

Returns: Optional[QueryConstraintsResponseSC_GeographicRangeSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find the UUIDS of image moments by concept. Only include image moments with images. Sorted by recorded timestamp.¶

GET /v1/fast/imagedmoments/concept/images/{concept}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.fast.imagedmoments.concept.images.item.with_concept_item_request_builder import WithConceptItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithConceptItemRequestBuilder.WithConceptItemRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.annosaurus.v1.fast.imagedmoments.concept.images.by_concept(concept).get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[UUID]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find image moment UUIDs by to concept. Only include image moments with images. Sorted by recorded timestamp.¶

GET /v1/fast/imagedmoments/toconcept/images/{toconcept}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.fast.imagedmoments.toconcept.images.item.with_toconcept_item_request_builder import WithToconceptItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithToconceptItemRequestBuilder.WithToconceptItemRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.annosaurus.v1.fast.imagedmoments.toconcept.images.by_toconcept(toconcept).get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[UUID]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count annotations with images by video reference UUID¶

GET /v1/fast/images/count/videoreference/{videoReferenceUuid}

result = await client.annosaurus.v1.fast.images.count.videoreference.by_video_reference_uuid(video_reference_uuid).get()

Returns: Optional[Count]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find annotations with images by video reference UUID¶

GET /v1/fast/images/videoreference/{videoReferenceUuid}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.fast.images.videoreference.item.with_video_reference_uu_item_request_builder import WithVideoReferenceUuItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithVideoReferenceUuItemRequestBuilder.WithVideoReferenceUuItemRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.annosaurus.v1.fast.images.videoreference.by_video_reference_uuid(video_reference_uuid).get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[ImageSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find annotations by multi request¶

POST /v1/fast/multi

# body: MultiRequestSC
from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.fast.multi.multi_request_builder import MultiRequestBuilder

request_configuration = RequestConfiguration(query_parameters=MultiRequestBuilder.MultiRequestBuilderPostQueryParameters(data=..., limit=..., offset=...))
result = await client.annosaurus.v1.fast.multi.post(body, request_configuration)

Query parameters:

• data: Optional[bool]
• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[AnnotationSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find annotations with images by to concept¶

GET /v1/fast/toconcept/images/{toconcept}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.fast.toconcept.images.item.with_toconcept_item_request_builder import WithToconceptItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithToconceptItemRequestBuilder.WithToconceptItemRequestBuilderGetQueryParameters(data=..., limit=..., offset=...))
result = await client.annosaurus.v1.fast.toconcept.images.by_toconcept(toconcept).get(request_configuration)

Query parameters:

• data: Optional[bool]
• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[AnnotationSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find annotations by video reference UUID¶

GET /v1/fast/videoreference/{videoReferenceUuid}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.fast.videoreference.item.with_video_reference_uu_item_request_builder import WithVideoReferenceUuItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithVideoReferenceUuItemRequestBuilder.WithVideoReferenceUuItemRequestBuilderGetQueryParameters(data=..., limit=..., offset=...))
result = await client.annosaurus.v1.fast.videoreference.by_video_reference_uuid(video_reference_uuid).get(request_configuration)

Query parameters:

• data: Optional[bool]
• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[AnnotationSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Delete annotations by video reference UUID¶

DELETE /v1/fast/videoreference/{videoReferenceUuid}

result = await client.annosaurus.v1.fast.videoreference.by_video_reference_uuid(video_reference_uuid).delete()

Returns: Optional[DeleteCountSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all annotations¶

GET /v1/fast

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.fast.fast_request_builder import FastRequestBuilder

request_configuration = RequestConfiguration(query_parameters=FastRequestBuilder.FastRequestBuilderGetQueryParameters(data=..., limit=..., offset=...))
result = await client.annosaurus.v1.fast.get(request_configuration)

Query parameters:

• data: Optional[bool]
• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[AnnotationSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find annotations by query constraints. Constraints can be snake_case or camelCase. The response will be in snake_case.¶

POST /v1/fast

# body: QueryConstraints
result = await client.annosaurus.v1.fast.post(body)

Returns: Optional[QueryConstraintsResponseSC_Seq_AnnotationSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Imaged Moments¶

GET /v1/imagedmoments/concept/count/{conceptName}¶

GET /v1/imagedmoments/concept/count/{conceptName}

result = await client.annosaurus.v1.imagedmoments.concept.count.by_concept_name(concept_name).get()

Returns: Optional[ConceptCount]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

GET /v1/imagedmoments/concept/images/count/{conceptName}¶

GET /v1/imagedmoments/concept/images/count/{conceptName}

result = await client.annosaurus.v1.imagedmoments.concept.images.count.by_concept_name(concept_name).get()

Returns: Optional[ConceptCount]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all imaged moments with a given concept name that have images¶

GET /v1/imagedmoments/concept/images/{conceptName}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.imagedmoments.concept.images.item.with_concept_name_item_request_builder import WithConceptNameItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithConceptNameItemRequestBuilder.WithConceptNameItemRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.annosaurus.v1.imagedmoments.concept.images.by_concept_name(concept_name).get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[ImagedMomentSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all imaged moments with a given concept name¶

GET /v1/imagedmoments/concept/{conceptName}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.imagedmoments.concept.item.with_concept_name_item_request_builder import WithConceptNameItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithConceptNameItemRequestBuilder.WithConceptNameItemRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.annosaurus.v1.imagedmoments.concept.by_concept_name(concept_name).get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[ImagedMomentSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count all imaged moments with an observation that has an association using the given link name¶

GET /v1/imagedmoments/count/linkname/{linkName}

result = await client.annosaurus.v1.imagedmoments.count.linkname.by_link_name(link_name).get()

Returns: Optional[Count]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count all imaged moments with images for a given video reference UUID¶

GET /v1/imagedmoments/count/images/{videoReferenceUuid}

result = await client.annosaurus.v1.imagedmoments.count.images.by_video_reference_uuid(video_reference_uuid).get()

Returns: Optional[Count]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count all imaged moments with images¶

GET /v1/imagedmoments/count/images

result = await client.annosaurus.v1.imagedmoments.count.images.get()

Returns: Optional[Count]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count all imaged moments¶

GET /v1/imagedmoments/count/all

result = await client.annosaurus.v1.imagedmoments.count.all.get()

Returns: Optional[Count]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count all imaged moments per video reference¶

GET /v1/imagedmoments/counts

result = await client.annosaurus.v1.imagedmoments.counts.get()

Returns: Optional[list[CountForVideoReferenceSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all imaged moments with a given link name¶

GET /v1/imagedmoments/find/linkname/{linkName}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.imagedmoments.find.linkname.item.with_link_name_item_request_builder import WithLinkNameItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithLinkNameItemRequestBuilder.WithLinkNameItemRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.annosaurus.v1.imagedmoments.find.linkname.by_link_name(link_name).get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[ImagedMomentSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all imaged moments with images¶

GET /v1/imagedmoments/find/images

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.imagedmoments.find.images.images_request_builder import ImagesRequestBuilder

request_configuration = RequestConfiguration(query_parameters=ImagesRequestBuilder.ImagesRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.annosaurus.v1.imagedmoments.find.images.get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[ImagedMomentSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all imaged moments for a given image reference UUID¶

GET /v1/imagedmoments/imagereference/{imageReferenceUuid}

result = await client.annosaurus.v1.imagedmoments.imagereference.by_image_reference_uuid(image_reference_uuid).get()

Returns: Optional[ImagedMomentSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Bulk move imaged moments to a new video reference. JSON request can be camelCase or snake_case¶

PUT /v1/imagedmoments/bulk/move

# body: MoveImagedMoments
result = await client.annosaurus.v1.imagedmoments.bulk.move.put(body)

Returns: Optional[Count]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Count all imaged moments modified between two dates¶

GET /v1/imagedmoments/modified/count/{start}/{end}

result = await client.annosaurus.v1.imagedmoments.modified.count.by_start(start).by_end(end).get()

Returns: Optional[Count]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all imaged moments modified between two dates¶

GET /v1/imagedmoments/modified/{start}/{end}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.imagedmoments.modified.item.item.with_end_item_request_builder import WithEndItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithEndItemRequestBuilder.WithEndItemRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.annosaurus.v1.imagedmoments.modified.by_start(start).by_end(end).get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[ImagedMomentSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Recalculate recorded timestamps for a given video reference UUID using a new start time and the imagedmoments elapsed time¶

PUT /v1/imagedmoments/newtime/{videoReferenceUuid}/{time}

result = await client.annosaurus.v1.imagedmoments.newtime.by_video_reference_uuid(video_reference_uuid).by_time(time).put()

Returns: Optional[list[ImagedMomentSC]]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Find an imaged moment for a given observation UUID¶

GET /v1/imagedmoments/observation/{observationUuid}

result = await client.annosaurus.v1.imagedmoments.observation.by_observation_uuid(observation_uuid).get()

Returns: Optional[ImagedMomentSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Recalculate recorded timestamps for a given video reference UUID using a new start time and the imagedmoments elapsed time. Annotations need observation_uuid and recorded_timestamp fields. This is not an atomic operation¶

PUT /v1/imagedmoments/tapetime

# body: list[AnnotationSC]
result = await client.annosaurus.v1.imagedmoments.tapetime.put(body)

Returns: Optional[ImagedMomentTimestampUpdateSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Count all imaged moments modifed before a given date for a given video reference UUID¶

GET /v1/imagedmoments/videoreference/modified/{uuid}/{date}

result = await client.annosaurus.v1.imagedmoments.videoreference.modified.by_uuid(uuid).by_date(date).get()

Returns: Optional[CountForVideoReferenceSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all imaged moments for a given video reference UUID¶

GET /v1/imagedmoments/videoreference/{videoReferenceUuid}

result = await client.annosaurus.v1.imagedmoments.videoreference.by_video_reference_uuid(video_reference_uuid).get()

Returns: Optional[list[ImagedMomentSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Delete all imaged moments for a given video reference UUID¶

DELETE /v1/imagedmoments/videoreference/{videoReferenceUuid}

result = await client.annosaurus.v1.imagedmoments.videoreference.by_video_reference_uuid(video_reference_uuid).delete()

Returns: Optional[CountForVideoReferenceSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all video reference UUIDs¶

GET /v1/imagedmoments/videoreference

result = await client.annosaurus.v1.imagedmoments.videoreference.get()

Returns: Optional[list[UUID]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find all imaged moments for a given window request¶

POST /v1/imagedmoments/windowrequest

# body: WindowRequestSC
from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.imagedmoments.windowrequest.windowrequest_request_builder import WindowrequestRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WindowrequestRequestBuilder.WindowrequestRequestBuilderPostQueryParameters(limit=..., offset=...))
result = await client.annosaurus.v1.imagedmoments.windowrequest.post(body, request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[ImagedMomentSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find an imaged moment by UUID¶

GET /v1/imagedmoments/{imagedMomentUuid}

result = await client.annosaurus.v1.imagedmoments.by_imaged_moment_uuid(imaged_moment_uuid).get()

Returns: Optional[ImagedMomentSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Update an imaged moment¶

PUT /v1/imagedmoments/{imagedMomentUuid}

# body: VideoTimestampSC
result = await client.annosaurus.v1.imagedmoments.by_imaged_moment_uuid(imaged_moment_uuid).put(body)

Returns: Optional[ImagedMomentSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Delete an imaged moment¶

DELETE /v1/imagedmoments/{imagedMomentUuid}

result = await client.annosaurus.v1.imagedmoments.by_imaged_moment_uuid(imaged_moment_uuid).delete()

Returns: None

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Find all imaged moments¶

GET /v1/imagedmoments

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.imagedmoments.imagedmoments_request_builder import ImagedmomentsRequestBuilder

request_configuration = RequestConfiguration(query_parameters=ImagedmomentsRequestBuilder.ImagedmomentsRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.annosaurus.v1.imagedmoments.get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[ImagedMomentSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Images¶

Find images by the image file's name¶

GET /v1/images/name/{imageFileName}

result = await client.annosaurus.v1.images.name.by_image_file_name(image_file_name).get()

Returns: Optional[list[ImageSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find images by the image file's URL¶

GET /v1/images/url/{url}

result = await client.annosaurus.v1.images.url.by_url(url).get()

Returns: Optional[ImageSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find images by video reference UUID¶

GET /v1/images/videoreference/{videoReferenceUuid}

result = await client.annosaurus.v1.images.videoreference.by_video_reference_uuid(video_reference_uuid).get()

Returns: Optional[list[ImageSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find an image by its UUID¶

GET /v1/images/{imageReferenceUuid}

result = await client.annosaurus.v1.images.by_image_reference_uuid(image_reference_uuid).get()

Returns: Optional[ImageSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Update an image¶

PUT /v1/images/{imageReferenceUuid}

# body: ImageUpdateSC
result = await client.annosaurus.v1.images.by_image_reference_uuid(image_reference_uuid).put(body)

Returns: Optional[ImageSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Create a new image¶

POST /v1/images

# body: ImageCreateSC
result = await client.annosaurus.v1.images.post(body)

Returns: Optional[ImageSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Image References¶

GET /v1/imagereferences/{imageReferenceUuid}¶

GET /v1/imagereferences/{imageReferenceUuid}

result = await client.annosaurus.v1.imagereferences.by_image_reference_uuid(image_reference_uuid).get()

Returns: Optional[ImageReferenceSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Update an image reference by its UUID and a json or form body¶

PUT /v1/imagereferences/{imageReferenceUuid}

# body: ImageReferenceSC
result = await client.annosaurus.v1.imagereferences.by_image_reference_uuid(image_reference_uuid).put(body)

Returns: Optional[ImageReferenceSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Delete an image reference by its UUID¶

DELETE /v1/imagereferences/{imageReferenceUuid}

result = await client.annosaurus.v1.imagereferences.by_image_reference_uuid(image_reference_uuid).delete()

Returns: None

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Time Indices¶

GET /v1/index/videoreference/{videoReferenceUuid}¶

GET /v1/index/videoreference/{videoReferenceUuid}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.index.videoreference.item.with_video_reference_uu_item_request_builder import WithVideoReferenceUuItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithVideoReferenceUuItemRequestBuilder.WithVideoReferenceUuItemRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.annosaurus.v1.index.videoreference.by_video_reference_uuid(video_reference_uuid).get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[IndexSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Bulk update the recordedTimestamp of multiple indices¶

PUT /v1/index/tapetime

# body: list[IndexUpdateSC]
result = await client.annosaurus.v1.index.tapetime.put(body)

Returns: Optional[list[IndexSC]]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Observations¶

List all activities found in the database¶

GET /v1/observations/activities

result = await client.annosaurus.v1.observations.activities.get()

Returns: Optional[list[str]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Update many observations. The observations to update are provided in the request body as a JSON array¶

PUT /v1/observations/bulk

# body: ObservationsUpdate
result = await client.annosaurus.v1.observations.bulk.put(body)

Returns: Optional[Count]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Find an observation by one of its association UUIDs¶

GET /v1/observations/association/{associationUuid}

result = await client.annosaurus.v1.observations.association.by_association_uuid(association_uuid).get()

Returns: Optional[ObservationSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count the number of observations for a given concept¶

GET /v1/observations/concept/count/{concept}

result = await client.annosaurus.v1.observations.concept.count.by_concept(concept).get()

Returns: Optional[ConceptCount]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count the number of observations with images for a given concept¶

GET /v1/observations/concept/images/count/{concept}

result = await client.annosaurus.v1.observations.concept.images.count.by_concept(concept).get()

Returns: Optional[ConceptCount]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Rename a concept in all observations¶

PUT /v1/observations/concept/rename

# body: RenameConcept
result = await client.annosaurus.v1.observations.concept.rename.put(body)

Returns: Optional[RenameCountSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

List all concepts used to annotation in a given video reference UUID¶

GET /v1/observations/concepts/{videoReferenceUuid}

result = await client.annosaurus.v1.observations.concepts.by_video_reference_uuid(video_reference_uuid).get()

Returns: Optional[list[str]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

List all concepts found in the database¶

GET /v1/observations/concepts

result = await client.annosaurus.v1.observations.concepts.get()

Returns: Optional[list[str]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count the number of observations for all video reference UUIDs¶

GET /v1/observations/counts

result = await client.annosaurus.v1.observations.counts.get()

Returns: Optional[list[CountForVideoReferenceSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Delete the duration of an observation¶

PUT /v1/observations/delete/duration/{observationUuid}

result = await client.annosaurus.v1.observations.delete_path.duration.by_observation_uuid(observation_uuid).put()

Returns: Optional[ObservationSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Delete many observations. The UUIDs of the observations to delete are provided in the request body as a JSON array¶

POST /v1/observations/delete

# body: list[UUID]
result = await client.annosaurus.v1.observations.delete_path.post(body)

Returns: None

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

List all groups found in the database¶

GET /v1/observations/groups

result = await client.annosaurus.v1.observations.groups.get()

Returns: Optional[list[str]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count the number of observations for a given video reference UUID. If start and end query params are provided, then the count will be limited to observations between those timestamps¶

GET /v1/observations/videoreference/count/{videoReferenceUuid}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.observations.videoreference.count.item.with_video_reference_uu_item_request_builder import WithVideoReferenceUuItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithVideoReferenceUuItemRequestBuilder.WithVideoReferenceUuItemRequestBuilderGetQueryParameters(end=..., start=...))
result = await client.annosaurus.v1.observations.videoreference.count.by_video_reference_uuid(video_reference_uuid).get(request_configuration)

Query parameters:

• end: Optional[str]
• start: Optional[str]

Returns: Optional[CountForVideoReferenceSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find observations by video reference UUID¶

GET /v1/observations/videoreference/{videoReferenceUuid}

from kiota_abstractions.base_request_configuration import RequestConfiguration
from vars_client.generated.annosaurus.v1.observations.videoreference.item.with_video_reference_uu_item_request_builder import WithVideoReferenceUuItemRequestBuilder

request_configuration = RequestConfiguration(query_parameters=WithVideoReferenceUuItemRequestBuilder.WithVideoReferenceUuItemRequestBuilderGetQueryParameters(limit=..., offset=...))
result = await client.annosaurus.v1.observations.videoreference.by_video_reference_uuid(video_reference_uuid).get(request_configuration)

Query parameters:

• limit: Optional[int]
• offset: Optional[int]

Returns: Optional[list[ObservationSC]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Find an observation by its UUID¶

GET /v1/observations/{observationUuid}

result = await client.annosaurus.v1.observations.by_observation_uuid(observation_uuid).get()

Returns: Optional[ObservationSC]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Update an observation. If the observation timestamp is not provided, then it will be set to the current time¶

PUT /v1/observations/{observationUuid}

# body: ObservationUpdateSC
result = await client.annosaurus.v1.observations.by_observation_uuid(observation_uuid).put(body)

Returns: Optional[ObservationSC]

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Delete an observation¶

DELETE /v1/observations/{observationUuid}

result = await client.annosaurus.v1.observations.by_observation_uuid(observation_uuid).delete()

Returns: None

Errors: 400 BadRequest · 401 Unauthorized · 404 NotFound · 500 ServerError

Query¶

List columns in the query view¶

GET /v1/query/columns

result = await client.annosaurus.v1.query.columns.get()

Returns: Optional[list[Metadata]]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Run a query¶

POST /v1/query/run

# body: QueryRequest
result = await client.annosaurus.v1.query.run.post(body)

Returns: Optional[str]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Run a query and download the results as a tab-separate value file¶

POST /v1/query/download

# body: QueryRequest
result = await client.annosaurus.v1.query.download.post(body)

Returns: Optional[bytes]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError

Count the number of rows in a query¶

POST /v1/query/count

# body: QueryRequest
result = await client.annosaurus.v1.query.count.post(body)

Returns: Optional[Count]

Errors: 400 BadRequest · 404 NotFound · 500 ServerError