Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CVAT annotations API

Shapes, tracks, and tags attached to tasks and jobs.

CVAT annotations API is one of 8 APIs that CVAT publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include annotations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against 2 base URLs: https://app.cvat.ai/api, http://localhost:8080/api.

6 operations 2 paths 3 schemas 1 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://app.cvat.ai/api
Authentication
API Key, HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 2

CVAT annotations API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (tokenAuth). It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • tokenAuth — Token authentication. Send the header Authorization: Token where the key is obtained from POST /auth/login.
  • basicAuth — HTTP Basic authentication with CVAT username and password.

Paths & Operations 6

Across 2 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

annotations 6

Shapes, tracks, and tags attached to tasks and jobs.

GET
/tasks/{id}/annotations
Get task annotations
tasks_retrieve_annotations 1 param → 200
PUT
/tasks/{id}/annotations
Replace task annotations
tasks_update_annotations 1 param body → 200
POST
/tasks/{id}/annotations
Import task annotations
tasks_create_annotations 2 params → 202
DELETE
/tasks/{id}/annotations
Delete task annotations
tasks_destroy_annotations 1 param → 204
GET
/jobs/{id}/annotations
Get job annotations
jobs_retrieve_annotations 1 param → 200
PUT
/jobs/{id}/annotations
Replace job annotations
jobs_update_annotations 1 param body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are LabeledShape (10 properties), LabeledImage (5 properties), LabeledData (4 properties). Each schema is shown below with its type and property counts.

LabeledImage
object
5 properties
LabeledData
object
Container of annotations for a task or job.
4 properties
LabeledShape
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cvat-annotations-api-openapi.yml Raw ↑

Other APIs CVAT publishes across the network.

CVAT cloudstorages API
CVAT jobs API
CVAT labels API
CVAT memberships API
CVAT organizations API
CVAT projects API
CVAT tasks API