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 tasks API

Annotation tasks holding media data and annotations.

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

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

This API exposes 7 operations across 4 paths, and defines 8 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.

7 operations 4 paths 8 schemas 1 DELETE2 GET1 PATCH3 POST

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 tasks 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 7

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

tasks 7

Annotation tasks holding media data and annotations.

GET
/tasks
List tasks
tasks_list 3 params → 200
POST
/tasks
Create a task
tasks_create body → 201
GET
/tasks/{id}
Retrieve a task
tasks_retrieve 1 param → 200
PATCH
/tasks/{id}
Update a task
tasks_partial_update 1 param body → 200
DELETE
/tasks/{id}
Delete a task
tasks_destroy 1 param → 204
POST
/tasks/{id}/data
Attach data to a task
tasks_create_data 1 param body → 202
POST
/tasks/{id}/dataset/export
Export a task dataset
tasks_create_dataset_export 3 params → 202

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Task (13 properties), TaskWriteRequest (7 properties), Attribute (6 properties), DataRequest (6 properties). Each schema is shown below with its type and property counts.

Attribute
object
6 properties
BasicUser
object
4 properties
Task
object
13 properties
PaginatedBase
object
4 properties
PaginatedTaskList
TaskWriteRequest
object
7 properties 1 required
DataRequest
object
6 properties
Label
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cvat-tasks-api-openapi.yml Raw ↑

Other APIs CVAT publishes across the network.

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