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

Annotation projects that group tasks and share a label set.

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

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

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

5 operations 2 paths 7 schemas 1 DELETE2 GET1 PATCH1 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 projects 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 5

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

projects 5

Annotation projects that group tasks and share a label set.

GET
/projects
List projects
projects_list 3 params → 200
POST
/projects
Create a project
projects_create body → 201
GET
/projects/{id}
Retrieve a project
projects_retrieve 1 param → 200
PATCH
/projects/{id}
Update a project
projects_partial_update 1 param body → 200
DELETE
/projects/{id}
Delete a project
projects_destroy 1 param → 204

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Project (10 properties), Label (6 properties), Attribute (6 properties), ProjectWriteRequest (4 properties). Each schema is shown below with its type and property counts.

Attribute
object
6 properties
BasicUser
object
4 properties
PaginatedBase
object
4 properties
ProjectWriteRequest
object
4 properties 1 required
PaginatedProjectList
Label
object
6 properties
Project
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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