CVAT Labels API
Label taxonomy shared across projects, tasks, and jobs.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/cvat:cvat-labels-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: CVAT REST Labels API
version: 2.79.0 (2.0)
description: REST API for Computer Vision Annotation Tool (CVAT)
termsOfService: https://www.google.com/policies/terms/
contact:
name: CVAT.ai team
url: https://github.com/cvat-ai/cvat
email: support@cvat.ai
license:
name: MIT License
url: https://en.wikipedia.org/wiki/MIT_License
tags:
- name: Labels
paths:
/api/labels:
get:
operationId: labels_list
summary: List labels
parameters:
- in: header
name: X-Organization
schema:
type: string
description: 'Organization unique slug.
If omitted, results from all organizations available to the user are returned
(unfiltered). An empty value ("") selects the personal sandbox workspace only.
A non-empty value selects that organization.
'
- name: color
in: query
description: A simple equality filter for the color field
schema:
type: string
- name: filter
required: false
in: query
description: "\nJSON Logic filter. This filter can be used to perform complex filtering by grouping rules.\n\nFor example, using such a filter you can get all resources created by you:\n\n - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]}\n\nDetails about the syntax used can be found at the link: https://jsonlogic.com/\n\n Available filter_fields: ['color', 'id', 'name', 'parent', 'parent_id', 'type']."
schema:
type: string
- in: query
name: job_id
schema:
type: integer
description: A simple equality filter for job id
- name: name
in: query
description: A simple equality filter for the name field
schema:
type: string
- in: query
name: org
schema:
type: string
description: 'Organization unique slug.
If omitted, results from all organizations available to the user are returned
(unfiltered). An empty value ("") selects the personal sandbox workspace only.
A non-empty value selects that organization.
'
- in: query
name: org_id
schema:
type: integer
description: 'Organization unique id.
If omitted, results from all organizations available to the user are returned
(unfiltered). An empty value ("") selects the personal sandbox workspace only.
A positive integer selects that organization.
'
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- name: page_size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- name: parent
in: query
description: A simple equality filter for the parent field
schema:
type: string
- name: parent_id
in: query
description: A simple equality filter for the parent_id field
schema:
type: integer
- in: query
name: project_id
schema:
type: integer
description: A simple equality filter for project id
- name: search
required: false
in: query
description: 'A search term. Available search_fields: [''name'', ''parent'']'
schema:
type: string
- name: sort
required: false
in: query
description: 'Which field to use when ordering the results. Available ordering_fields: [''color'', ''id'', ''name'', ''parent'', ''parent_id'', ''type'']'
schema:
type: string
- in: query
name: task_id
schema:
type: integer
description: A simple equality filter for task id
- name: type
in: query
description: A simple equality filter for the type field
schema:
type: string
enum:
- any
- cuboid
- ellipse
- mask
- points
- polygon
- polyline
- rectangle
- skeleton
- interval
- tag
tags:
- Labels
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'200':
content:
application/vnd.cvat+json:
schema:
$ref: '#/components/schemas/PaginatedLabelList'
description: ''
/api/labels/{id}:
get:
operationId: labels_retrieve
summary: Get label details
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this label.
required: true
tags:
- Labels
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'200':
content:
application/vnd.cvat+json:
schema:
$ref: '#/components/schemas/Label'
description: ''
patch:
operationId: labels_partial_update
description: To modify a sublabel, please use the PATCH method of the parent label.
summary: Update a label
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this label.
required: true
tags:
- Labels
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedLabelRequest'
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'200':
content:
application/vnd.cvat+json:
schema:
$ref: '#/components/schemas/Label'
description: ''
delete:
operationId: labels_destroy
description: To delete a sublabel, please use the PATCH method of the parent label.
summary: Delete a label
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this label.
required: true
tags:
- Labels
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'204':
description: The label has been deleted
components:
schemas:
InputTypeEnum:
enum:
- checkbox
- radio
- number
- text
- select
type: string
description: '* `checkbox` - CHECKBOX
* `radio` - RADIO
* `number` - NUMBER
* `text` - TEXT
* `select` - SELECT'
Sublabel:
type: object
properties:
id:
type: integer
name:
type: string
maxLength: 64
color:
type: string
description: The hex value for the RGB color. Will be generated automatically, unless specified explicitly.
attributes:
type: array
items:
$ref: '#/components/schemas/Attribute'
default: []
description: The list of attributes. To remove an attribute, pass the full attribute body with deleted=true. Related annotation attribute values will be deleted.
type:
allOf:
- $ref: '#/components/schemas/LabelType'
description: 'Associated annotation type for this label
* `any` - ANY
* `cuboid` - CUBOID
* `ellipse` - ELLIPSE
* `mask` - MASK
* `points` - POINTS
* `polygon` - POLYGON
* `polyline` - POLYLINE
* `rectangle` - RECTANGLE
* `skeleton` - SKELETON
* `interval` - INTERVAL
* `tag` - TAG'
has_parent:
type: boolean
required:
- name
PaginatedLabelList:
type: object
required:
- count
- results
properties:
count:
type: integer
example: 123
next:
type:
- string
- 'null'
format: uri
example: http://api.example.org/accounts/?page=4
previous:
type:
- string
- 'null'
format: uri
example: http://api.example.org/accounts/?page=2
results:
type: array
items:
$ref: '#/components/schemas/Label'
AttributeRequest:
type: object
properties:
id:
type: integer
name:
type: string
minLength: 1
maxLength: 64
mutable:
type: boolean
input_type:
$ref: '#/components/schemas/InputTypeEnum'
default_value:
type: string
maxLength: 128
values:
type: array
items:
type: string
maxLength: 200
deleted:
type: boolean
writeOnly: true
description: Delete the attribute and all related annotation values.
required:
- input_type
- mutable
- name
- values
PatchedLabelRequest:
type: object
properties:
id:
type: integer
name:
type: string
minLength: 1
maxLength: 64
color:
type: string
description: The hex value for the RGB color. Will be generated automatically, unless specified explicitly.
attributes:
type: array
items:
$ref: '#/components/schemas/AttributeRequest'
default: []
description: The list of attributes. To remove an attribute, pass the full attribute body with deleted=true. Related annotation attribute values will be deleted.
deleted:
type: boolean
writeOnly: true
description: Delete the label. Only applicable in the PATCH methods of a project or a task.
type:
allOf:
- $ref: '#/components/schemas/LabelType'
description: 'Associated annotation type for this label
* `any` - ANY
* `cuboid` - CUBOID
* `ellipse` - ELLIPSE
* `mask` - MASK
* `points` - POINTS
* `polygon` - POLYGON
* `polyline` - POLYLINE
* `rectangle` - RECTANGLE
* `skeleton` - SKELETON
* `interval` - INTERVAL
* `tag` - TAG'
svg:
type: string
sublabels:
type: array
items:
$ref: '#/components/schemas/SublabelRequest'
Label:
type: object
properties:
id:
type: integer
name:
type: string
maxLength: 64
color:
type: string
description: The hex value for the RGB color. Will be generated automatically, unless specified explicitly.
attributes:
type: array
items:
$ref: '#/components/schemas/Attribute'
default: []
description: The list of attributes. To remove an attribute, pass the full attribute body with deleted=true. Related annotation attribute values will be deleted.
type:
allOf:
- $ref: '#/components/schemas/LabelType'
description: 'Associated annotation type for this label
* `any` - ANY
* `cuboid` - CUBOID
* `ellipse` - ELLIPSE
* `mask` - MASK
* `points` - POINTS
* `polygon` - POLYGON
* `polyline` - POLYLINE
* `rectangle` - RECTANGLE
* `skeleton` - SKELETON
* `interval` - INTERVAL
* `tag` - TAG'
svg:
type: string
sublabels:
type: array
items:
$ref: '#/components/schemas/Sublabel'
project_id:
type:
- integer
- 'null'
readOnly: true
task_id:
type:
- integer
- 'null'
readOnly: true
parent_id:
type:
- integer
- 'null'
readOnly: true
has_parent:
type: boolean
readOnly: true
required:
- name
SublabelRequest:
type: object
properties:
id:
type: integer
name:
type: string
minLength: 1
maxLength: 64
color:
type: string
description: The hex value for the RGB color. Will be generated automatically, unless specified explicitly.
attributes:
type: array
items:
$ref: '#/components/schemas/AttributeRequest'
default: []
description: The list of attributes. To remove an attribute, pass the full attribute body with deleted=true. Related annotation attribute values will be deleted.
type:
allOf:
- $ref: '#/components/schemas/LabelType'
description: 'Associated annotation type for this label
* `any` - ANY
* `cuboid` - CUBOID
* `ellipse` - ELLIPSE
* `mask` - MASK
* `points` - POINTS
* `polygon` - POLYGON
* `polyline` - POLYLINE
* `rectangle` - RECTANGLE
* `skeleton` - SKELETON
* `interval` - INTERVAL
* `tag` - TAG'
has_parent:
type: boolean
required:
- name
Attribute:
type: object
properties:
id:
type: integer
name:
type: string
maxLength: 64
mutable:
type: boolean
input_type:
$ref: '#/components/schemas/InputTypeEnum'
default_value:
type: string
maxLength: 128
values:
type: array
items:
type: string
maxLength: 200
required:
- input_type
- mutable
- name
- values
LabelType:
enum:
- any
- cuboid
- ellipse
- mask
- points
- polygon
- polyline
- rectangle
- skeleton
- interval
- tag
type: string
description: '* `any` - ANY
* `cuboid` - CUBOID
* `ellipse` - ELLIPSE
* `mask` - MASK
* `points` - POINTS
* `polygon` - POLYGON
* `polyline` - POLYLINE
* `rectangle` - RECTANGLE
* `skeleton` - SKELETON
* `interval` - INTERVAL
* `tag` - TAG'
securitySchemes:
accessTokenAuth:
type: http
scheme: bearer
description: 'To authenticate using an API Access token, you need to include
the ''Authentication'' header with the ''Bearer '' prefix
An API Access token has to be issued in the user profile section of the UI or
via the /auth/access_tokens API before this authentication method can be used.
'
basicAuth:
type: http
scheme: basic
csrfAuth:
type: apiKey
in: cookie
name: csrftoken
description: 'A CSRF protection token. Can be received in the ''csrftoken'' cookie in the
server response on the /api/auth/login endpoint. The ''Origin'' header
must also be specified in the request.
'
csrfHeaderAuth:
type: apiKey
in: header
name: X-CSRFToken
description: 'A CSRF protection token. Can be received in the ''csrftoken'' cookie in the
server response on the /api/auth/login endpoint. The ''Origin'' header
must also be specified in the request.
'
sessionAuth:
type: apiKey
in: cookie
name: sessionid
tokenAuth:
type: apiKey
in: header
name: Authorization
description: 'Deprecated.
You can obtain an API key (the token) from the server response on
the /api/auth/login/ endpoint.
'
x-token-prefix: Token
externalDocs:
description: CVAT documentation
url: https://docs.cvat.ai/docs/
x-provenance:
method: harvested
publisher: CVAT
source: https://app.cvat.ai/api/schema/
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)