CVAT Comments API
The comments API from CVAT — 2 operation(s) for comments.
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-comments-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 Comments 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: Comments
paths:
/api/comments:
get:
operationId: comments_list
summary: List comments
parameters:
- name: X-Organization
in: header
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.
'
schema:
type: string
allowEmptyValue: true
- 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: ['frame_id', 'id', 'issue_id', 'job_id', 'owner']."
schema:
type: string
- name: frame_id
in: query
description: A simple equality filter for the frame_id field
schema:
type: integer
- name: issue_id
in: query
description: A simple equality filter for the issue_id field
schema:
type: integer
- name: job_id
in: query
description: A simple equality filter for the job_id field
schema:
type: integer
- name: org
in: query
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.
'
schema:
type: string
allowEmptyValue: true
- name: org_id
in: query
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.
'
schema:
type: integer
allowEmptyValue: true
- name: owner
in: query
description: A simple equality filter for the owner field
schema:
type: string
- 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: search
required: false
in: query
description: 'A search term. Available search_fields: [''owner'']'
schema:
type: string
- name: sort
required: false
in: query
description: 'Which field to use when ordering the results. Available ordering_fields: [''frame_id'', ''id'', ''issue_id'', ''job_id'', ''owner'']'
schema:
type: string
tags:
- Comments
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'200':
content:
application/vnd.cvat+json:
schema:
$ref: '#/components/schemas/PaginatedCommentReadList'
description: ''
post:
operationId: comments_create
summary: Create a comment
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.
'
- 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.
'
tags:
- Comments
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CommentWriteRequest'
required: true
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'201':
content:
application/vnd.cvat+json:
schema:
$ref: '#/components/schemas/CommentRead'
description: ''
/api/comments/{id}:
get:
operationId: comments_retrieve
summary: Get comment details
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this comment.
required: true
tags:
- Comments
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'200':
content:
application/vnd.cvat+json:
schema:
$ref: '#/components/schemas/CommentRead'
description: ''
patch:
operationId: comments_partial_update
summary: Update a comment
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this comment.
required: true
tags:
- Comments
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedCommentWriteRequest'
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'200':
content:
application/vnd.cvat+json:
schema:
$ref: '#/components/schemas/CommentRead'
description: ''
delete:
operationId: comments_destroy
summary: Delete a comment
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this comment.
required: true
tags:
- Comments
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'204':
description: The comment has been deleted
components:
schemas:
PatchedCommentWriteRequest:
type: object
properties:
message:
type: string
minLength: 1
CommentRead:
type: object
properties:
id:
type: integer
readOnly: true
issue:
type: integer
readOnly: true
owner:
allOf:
- $ref: '#/components/schemas/BasicUser'
message:
type: string
readOnly: true
created_date:
type: string
format: date-time
readOnly: true
updated_date:
type: string
format: date-time
readOnly: true
PaginatedCommentReadList:
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/CommentRead'
BasicUser:
type: object
properties:
url:
type: string
format: uri
readOnly: true
id:
type: integer
readOnly: true
username:
type: string
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
pattern: ^[\w.@+-]+$
maxLength: 150
first_name:
type: string
maxLength: 150
last_name:
type: string
maxLength: 150
required:
- username
CommentWriteRequest:
type: object
properties:
issue:
type: integer
message:
type: string
minLength: 1
required:
- issue
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)