APIs

All URIs are relative to http://localhost

Class Method HTTP request Description
AnalyticsApi create_report POST /api/analytics/reports Creates a analytics report asynchronously and allows to check request status
AnalyticsApi get_reports GET /api/analytics/reports Method returns analytics report
AssetsApi create POST /api/assets Method saves new asset on the server and attaches it to a corresponding guide
AssetsApi destroy DELETE /api/assets/{uuid} Method deletes a specific asset from the server
AssetsApi retrieve GET /api/assets/{uuid} Method returns an asset file
AuthApi create_login POST /api/auth/login
AuthApi create_logout POST /api/auth/logout
AuthApi create_password_change POST /api/auth/password/change
AuthApi create_password_reset POST /api/auth/password/reset
AuthApi create_password_reset_confirm POST /api/auth/password/reset/confirm
AuthApi create_register POST /api/auth/register
AuthApi create_signing POST /api/auth/signing This method signs URL for access to the server
AuthApi retrieve_rules GET /api/auth/rules
CloudstoragesApi create POST /api/cloudstorages Method creates a cloud storage with a specified characteristics
CloudstoragesApi destroy DELETE /api/cloudstorages/{id} Method deletes a specific cloud storage
CloudstoragesApi list GET /api/cloudstorages Returns a paginated list of storages
CloudstoragesApi partial_update PATCH /api/cloudstorages/{id} Methods does a partial update of chosen fields in a cloud storage instance
CloudstoragesApi retrieve GET /api/cloudstorages/{id} Method returns details of a specific cloud storage
CloudstoragesApi retrieve_actions GET /api/cloudstorages/{id}/actions Method returns allowed actions for the cloud storage
CloudstoragesApi retrieve_content_v2 GET /api/cloudstorages/{id}/content-v2 Method returns the content of the cloud storage
CloudstoragesApi retrieve_preview GET /api/cloudstorages/{id}/preview Method returns a preview image from a cloud storage
CloudstoragesApi retrieve_status GET /api/cloudstorages/{id}/status Method returns a cloud storage status
CommentsApi create POST /api/comments Method creates a comment
CommentsApi destroy DELETE /api/comments/{id} Method deletes a comment
CommentsApi list GET /api/comments Method returns a paginated list of comments
CommentsApi partial_update PATCH /api/comments/{id} Methods does a partial update of chosen fields in a comment
CommentsApi retrieve GET /api/comments/{id} Method returns details of a comment
EventsApi create POST /api/events Method saves logs from a client on the server
EventsApi list GET /api/events Method returns csv log file
GuidesApi create POST /api/guides Method creates a new annotation guide binded to a project or to a task
GuidesApi destroy DELETE /api/guides/{id} Method deletes a specific annotation guide and all attached assets
GuidesApi partial_update PATCH /api/guides/{id} Methods does a partial update of chosen fields in an annotation guide
GuidesApi retrieve GET /api/guides/{id} Method returns details of a specific annotation guide
InvitationsApi accept POST /api/invitations/{key}/accept Method registers user and accepts invitation to organization
InvitationsApi create POST /api/invitations Method creates an invitation
InvitationsApi decline POST /api/invitations/{key}/decline Method declines the invitation to organization
InvitationsApi destroy DELETE /api/invitations/{key} Method deletes an invitation
InvitationsApi list GET /api/invitations Method returns a paginated list of invitations
InvitationsApi partial_update PATCH /api/invitations/{key} Methods does a partial update of chosen fields in an invitation
InvitationsApi resend POST /api/invitations/{key}/resend Method resends the invitation to organization
InvitationsApi retrieve GET /api/invitations/{key} Method returns details of an invitation
IssuesApi create POST /api/issues Method creates an issue
IssuesApi destroy DELETE /api/issues/{id} Method deletes an issue
IssuesApi list GET /api/issues Method returns a paginated list of issues
IssuesApi partial_update PATCH /api/issues/{id} Methods does a partial update of chosen fields in an issue
IssuesApi retrieve GET /api/issues/{id} Method returns details of an issue
JobsApi create POST /api/jobs Method creates a new job in the task
JobsApi create_annotations POST /api/jobs/{id}/annotations/ Method allows to initialize the process of the job annotation upload from a local file or a cloud storage
JobsApi destroy DELETE /api/jobs/{id} Method deletes a job and its related annotations
JobsApi destroy_annotations DELETE /api/jobs/{id}/annotations/ Method deletes all annotations for a specific job
JobsApi list GET /api/jobs Method returns a paginated list of jobs
JobsApi partial_update PATCH /api/jobs/{id} Methods does a partial update of chosen fields in a job
JobsApi partial_update_annotations PATCH /api/jobs/{id}/annotations/ Method performs a partial update of annotations in a specific job
JobsApi retrieve GET /api/jobs/{id} Method returns details of a job
JobsApi retrieve_annotations GET /api/jobs/{id}/annotations/ Method returns annotations for a specific job as a JSON document. If format is specified, a zip archive is returned.
JobsApi retrieve_data GET /api/jobs/{id}/data Method returns data for a specific job
JobsApi retrieve_data_meta GET /api/jobs/{id}/data/meta Method provides a meta information about media files which are related with the job
JobsApi retrieve_dataset GET /api/jobs/{id}/dataset Export job as a dataset in a specific format
JobsApi retrieve_preview GET /api/jobs/{id}/preview Method returns a preview image for the job
JobsApi update_annotations PUT /api/jobs/{id}/annotations/ Method performs an update of all annotations in a specific job or used for uploading annotations from a file
LabelsApi destroy DELETE /api/labels/{id} Method deletes a label. To delete a sublabel, please use the PATCH method of the parent label
LabelsApi list GET /api/labels Method returns a paginated list of labels
LabelsApi partial_update PATCH /api/labels/{id} Methods does a partial update of chosen fields in a labelTo modify a sublabel, please use the PATCH method of the parent label
LabelsApi retrieve GET /api/labels/{id} Method returns details of a label
LambdaApi create_functions POST /api/lambda/functions/{func_id}
LambdaApi create_requests POST /api/lambda/requests Method calls the function
LambdaApi delete_requests DELETE /api/lambda/requests/{id} Method cancels the request
LambdaApi list_functions GET /api/lambda/functions Method returns a list of functions
LambdaApi list_requests GET /api/lambda/requests Method returns a list of requests
LambdaApi retrieve_functions GET /api/lambda/functions/{func_id} Method returns the information about the function
LambdaApi retrieve_requests GET /api/lambda/requests/{id} Method returns the status of the request
MembershipsApi destroy DELETE /api/memberships/{id} Method deletes a membership
MembershipsApi list GET /api/memberships Method returns a paginated list of memberships
MembershipsApi partial_update PATCH /api/memberships/{id} Methods does a partial update of chosen fields in a membership
MembershipsApi retrieve GET /api/memberships/{id} Method returns details of a membership
OrganizationsApi create POST /api/organizations Method creates an organization
OrganizationsApi destroy DELETE /api/organizations/{id} Method deletes an organization
OrganizationsApi list GET /api/organizations Method returns a paginated list of organizations
OrganizationsApi partial_update PATCH /api/organizations/{id} Methods does a partial update of chosen fields in an organization
OrganizationsApi retrieve GET /api/organizations/{id} Method returns details of an organization
ProjectsApi create POST /api/projects Method creates a new project
ProjectsApi create_backup POST /api/projects/backup/ Methods create a project from a backup
ProjectsApi create_dataset POST /api/projects/{id}/dataset/ Import dataset in specific format as a project or check status of dataset import process
ProjectsApi destroy DELETE /api/projects/{id} Method deletes a specific project
ProjectsApi list GET /api/projects Returns a paginated list of projects
ProjectsApi partial_update PATCH /api/projects/{id} Methods does a partial update of chosen fields in a project
ProjectsApi retrieve GET /api/projects/{id} Method returns details of a specific project
ProjectsApi retrieve_annotations GET /api/projects/{id}/annotations Method allows to download project annotations
ProjectsApi retrieve_backup GET /api/projects/{id}/backup Methods creates a backup copy of a project
ProjectsApi retrieve_dataset GET /api/projects/{id}/dataset/ Export project as a dataset in a specific format
ProjectsApi retrieve_preview GET /api/projects/{id}/preview Method returns a preview image for the project
QualityApi create_report POST /api/quality/reports Creates a quality report asynchronously and allows to check request status
QualityApi list_conflicts GET /api/quality/conflicts Method returns a paginated list of annotation conflicts
QualityApi list_reports GET /api/quality/reports Method returns a paginated list of quality reports
QualityApi list_settings GET /api/quality/settings Method returns a paginated list of quality settings instances
QualityApi partial_update_settings PATCH /api/quality/settings/{id} Methods does a partial update of chosen fields in the quality settings instance
QualityApi retrieve_report GET /api/quality/reports/{id} Method returns details of a quality report
QualityApi retrieve_report_data GET /api/quality/reports/{id}/data Retrieve full contents of the report in JSON format
QualityApi retrieve_settings GET /api/quality/settings/{id} Method returns details of the quality settings instance
SchemaApi retrieve GET /api/schema/
ServerApi list_share GET /api/server/share Returns all files and folders that are on the server along specified path
ServerApi retrieve_about GET /api/server/about Method provides basic CVAT information
ServerApi retrieve_annotation_formats GET /api/server/annotation/formats Method provides the list of supported annotations formats
ServerApi retrieve_plugins GET /api/server/plugins Method provides allowed plugins
TasksApi jobs_partial_update_data_meta PATCH /api/jobs/{id}/data/meta Method provides a meta information about media files which are related with the job
TasksApi create POST /api/tasks Method creates a new task in a database without any attached images and videos
TasksApi create_annotations POST /api/tasks/{id}/annotations/ Method allows to initialize the process of upload task annotations from a local or a cloud storage file
TasksApi create_backup POST /api/tasks/backup/ Method recreates a task from an attached task backup file
TasksApi create_data POST /api/tasks/{id}/data/ Method permanently attaches data (images, video, etc.) to a task
TasksApi destroy DELETE /api/tasks/{id} Method deletes a specific task, all attached jobs, annotations, and data
TasksApi destroy_annotations DELETE /api/tasks/{id}/annotations/ Method deletes all annotations for a specific task
TasksApi list GET /api/tasks Returns a paginated list of tasks
TasksApi partial_update PATCH /api/tasks/{id} Methods does a partial update of chosen fields in a task
TasksApi partial_update_annotations PATCH /api/tasks/{id}/annotations/ Method performs a partial update of annotations in a specific task
TasksApi partial_update_data_meta PATCH /api/tasks/{id}/data/meta Method provides a meta information about media files which are related with the task
TasksApi retrieve GET /api/tasks/{id} Method returns details of a specific task
TasksApi retrieve_annotations GET /api/tasks/{id}/annotations/ Method allows to download task annotations
TasksApi retrieve_backup GET /api/tasks/{id}/backup Method backup a specified task
TasksApi retrieve_data GET /api/tasks/{id}/data/ Method returns data for a specific task
TasksApi retrieve_data_meta GET /api/tasks/{id}/data/meta Method provides a meta information about media files which are related with the task
TasksApi retrieve_dataset GET /api/tasks/{id}/dataset Export task as a dataset in a specific format
TasksApi retrieve_preview GET /api/tasks/{id}/preview Method returns a preview image for the task
TasksApi retrieve_status GET /api/tasks/{id}/status When task is being created the method returns information about a status of the creation process
TasksApi update_annotations PUT /api/tasks/{id}/annotations/ Method allows to upload task annotations or edit existing annotations
UsersApi destroy DELETE /api/users/{id} Method deletes a specific user from the server
UsersApi list GET /api/users Method returns a paginated list of users
UsersApi partial_update PATCH /api/users/{id} Method updates chosen fields of a user
UsersApi retrieve GET /api/users/{id} Method provides information of a specific user
UsersApi retrieve_self GET /api/users/self Method returns an instance of a user who is currently authorized
WebhooksApi create POST /api/webhooks Method creates a webhook
WebhooksApi create_deliveries_redelivery POST /api/webhooks/{id}/deliveries/{delivery_id}/redelivery Method redeliver a specific webhook delivery
WebhooksApi create_ping POST /api/webhooks/{id}/ping Method send ping webhook
WebhooksApi destroy DELETE /api/webhooks/{id} Method deletes a webhook
WebhooksApi list GET /api/webhooks Method returns a paginated list of webhook according to query parameters
WebhooksApi list_deliveries GET /api/webhooks/{id}/deliveries Method return a list of deliveries for a specific webhook
WebhooksApi partial_update PATCH /api/webhooks/{id} Methods does a partial update of chosen fields in a webhook
WebhooksApi retrieve GET /api/webhooks/{id} Method returns details of a webhook
WebhooksApi retrieve_deliveries GET /api/webhooks/{id}/deliveries/{delivery_id} Method return a specific delivery for a specific webhook
WebhooksApi retrieve_events GET /api/webhooks/events Method return a list of available webhook events
WebhooksApi update PUT /api/webhooks/{id} Method updates a webhook by id