CVAT Guides API
The guides API from CVAT — 2 operation(s) for guides.
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-guides-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 Guides 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: guides
paths:
/api/guides:
post:
operationId: guides_create
description: The new guide will be bound either to a project or a task, depending on parameters.
summary: Create an annotation guide
tags:
- guides
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AnnotationGuideWriteRequest'
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'201':
content:
application/vnd.cvat+json:
schema:
$ref: '#/components/schemas/AnnotationGuideRead'
description: ''
/api/guides/{id}:
get:
operationId: guides_retrieve
summary: Get annotation guide details
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this annotation guide.
required: true
tags:
- guides
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'200':
content:
application/vnd.cvat+json:
schema:
$ref: '#/components/schemas/AnnotationGuideRead'
description: ''
patch:
operationId: guides_partial_update
summary: Update an annotation guide
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this annotation guide.
required: true
tags:
- guides
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedAnnotationGuideWriteRequest'
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'200':
content:
application/vnd.cvat+json:
schema:
$ref: '#/components/schemas/AnnotationGuideRead'
description: ''
delete:
operationId: guides_destroy
description: This also deletes all assets attached to the guide.
summary: Delete an annotation guide
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this annotation guide.
required: true
tags:
- guides
security:
- tokenAuth: []
- accessTokenAuth: []
- sessionAuth: []
csrfAuth: []
csrfHeaderAuth: []
- basicAuth: []
responses:
'204':
description: The annotation guide has been deleted
components:
schemas:
PatchedAnnotationGuideWriteRequest:
type: object
properties:
task_id:
type:
- integer
- 'null'
project_id:
type:
- integer
- 'null'
markdown:
type: string
AnnotationGuideRead:
type: object
properties:
id:
type: integer
readOnly: true
task_id:
type:
- integer
- 'null'
readOnly: true
project_id:
type:
- integer
- 'null'
readOnly: true
created_date:
type: string
format: date-time
readOnly: true
updated_date:
type: string
format: date-time
readOnly: true
markdown:
type: string
readOnly: true
AnnotationGuideWriteRequest:
type: object
properties:
task_id:
type:
- integer
- 'null'
project_id:
type:
- integer
- 'null'
markdown:
type: string
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)