CVAT Requests API
The requests API from CVAT — 3 operation(s) for requests.
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-requests-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 Requests 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: Requests
paths:
/api/requests:
get:
operationId: requests_list
summary: List requests
parameters:
- name: action
in: query
description: A simple equality filter for the action 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\nDetails about the syntax used can be found at the link: https://jsonlogic.com/\n\n Available filter_fields: ['action', 'format', 'job_id', 'org', 'org_id', 'project_id', 'status', 'subresource', 'target', 'task_id']."
schema:
type: string
- name: format
in: query
description: A simple equality filter for the format field
schema:
type: string
- name: job_id
in: query
description: A simple equality filter for the job_id field
schema:
type: integer
- name: org
in: query
description: A simple equality filter for the org field
schema:
type: string
- name: org_id
in: query
description: A simple equality filter for the org_id field
schema:
type: integer
- 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: project_id
in: query
description: A simple equality filter for the project_id field
schema:
type: integer
- name: sort
required: false
in: query
description: 'Which field to use when ordering the results. Available ordering_fields: [''action'', ''created_date'', ''status'']'
schema:
type: string
- name: status
in: query
description: A simple equality filter for the status field
schema:
type: string
enum:
- queued
- started
- failed
- finished
- name: subresource
in: query
description: A simple equality filter for the subresource field
schema:
type: string
- name: target
in: query
description: A simple equality filter for the target field
schema:
type: string
- name: task_id
in: query
description: A simple equality filter for the task_id field
schema:
type: integer
tags:
- Requests
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'200':
content:
application/vnd.cvat+json:
schema:
$ref: '#/components/schemas/PaginatedRequestList'
description: ''
/api/requests/{id}:
get:
operationId: requests_retrieve
summary: Get request details
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Requests
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'200':
content:
application/vnd.cvat+json:
schema:
$ref: '#/components/schemas/Request'
description: ''
/api/requests/{id}/cancel:
post:
operationId: requests_create_cancel
summary: Cancel request
parameters:
- in: path
name: id
schema:
type: string
required: true
tags:
- Requests
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'200':
description: The request has been cancelled
components:
schemas:
RequestStatus:
enum:
- queued
- started
- failed
- finished
type: string
description: '* `queued` - Queued
* `started` - Started
* `failed` - Failed
* `finished` - Finished'
PaginatedRequestList:
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/Request'
UserIdentifiers:
type: object
properties:
id:
type: integer
readOnly: true
username:
type: string
description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
pattern: ^[\w.@+-]+$
maxLength: 150
required:
- username
Request:
type: object
properties:
status:
$ref: '#/components/schemas/RequestStatus'
message:
type: string
readOnly: true
id:
type: string
operation:
$ref: '#/components/schemas/RequestDataOperation'
progress:
type:
- number
- 'null'
format: double
maximum: 1
minimum: 0
readOnly: true
created_date:
type: string
format: date-time
started_date:
type:
- string
- 'null'
format: date-time
finished_date:
type:
- string
- 'null'
format: date-time
expiry_date:
type:
- string
- 'null'
format: date-time
readOnly: true
owner:
allOf:
- $ref: '#/components/schemas/UserIdentifiers'
readOnly: true
result_url:
type:
- string
- 'null'
format: uri
result_id:
type:
- integer
- 'null'
required:
- created_date
- id
- operation
- status
RequestDataOperation:
type: object
properties:
type:
type: string
target:
type: string
project_id:
type:
- integer
- 'null'
task_id:
type:
- integer
- 'null'
job_id:
type:
- integer
- 'null'
org_id:
type:
- integer
- 'null'
format:
type:
- string
- 'null'
function_id:
type:
- string
- 'null'
lightweight:
type:
- boolean
- 'null'
required:
- target
- type
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)