CVAT平台REST API文档 | Computer Vision Annotation Tool (CVAT) REST API (2.0)

cvat是一个非常好用的标注工具，同时支持以API的形式访问进行二次开发。本文简单介绍一下CVAT平台的API使用文档。

Computer Vision Annotation Tool (CVAT) REST API (2.0)

CVAT

v1.0.0

Base URLs:

Authentication

CVAT/assets

POST Method saves new asset on the server and attaches it to a corresponding guide

POST /api/assets

Body Parameters

file: string

Params

Name	Location	Type	Required	Description
body	body	object	no	none
» file	body	string(binary)	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

GET Method returns an asset file

GET /api/assets/{uuid}

Params

Name	Location	Type	Required	Description
uuid	path	string	yes	A UUID string identifying this asset.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Asset file	Inline

Responses Data Schema

DELETE Method deletes a specific asset from the server

DELETE /api/assets/{uuid}

Params

Name	Location	Type	Required	Description
uuid	path	string	yes	A UUID string identifying this asset.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The asset has been deleted	Inline

Responses Data Schema

CVAT/auth

POST /api/auth/login

POST /api/auth/login

Check the credentials and return the REST Token
if the credentials are valid and authenticated.
If email verification is enabled and the user has the unverified email,
an email with a confirmation link will be sent.
Calls Django Auth login method to register User ID
in Django session framework.

Accept the following POST parameters: username, email, password
Return the REST Framework Token Object’s key.

Body Parameters

{
  "username": "string",
  "email": "user@example.com",
  "password": "string"
}

Params

Name	Location	Type	Required	Description
body	body	LoginSerializerExRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST /api/auth/logout

POST /api/auth/logout

Calls Django logout method and delete the Token object
assigned to the current User object.

Accepts/Returns nothing.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST /api/auth/password/change

POST /api/auth/password/change

Calls Django Auth SetPasswordForm save method.

Accepts the following POST parameters: new_password1, new_password2
Returns the success/fail message.

Body Parameters

{
  "old_password": "string",
  "new_password1": "string",
  "new_password2": "string"
}

Params

Name	Location	Type	Required	Description
body	body	PasswordChangeRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST /api/auth/password/reset

POST /api/auth/password/reset

Calls Django Auth PasswordResetForm save method.

Accepts the following POST parameters: email
Returns the success/fail message.

Body Parameters

{
  "email": "user@example.com"
}

Params

Name	Location	Type	Required	Description
body	body	PasswordResetSerializerExRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST /api/auth/password/reset/confirm

POST /api/auth/password/reset/confirm

Password reset e-mail link is confirmed, therefore
this resets the user’s password.

Accepts the following POST parameters: token, uid,
new_password1, new_password2
Returns the success/fail message.

Body Parameters

{
  "new_password1": "string",
  "new_password2": "string",
  "uid": "string",
  "token": "string"
}

Params

Name	Location	Type	Required	Description
body	body	PasswordResetConfirmRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST /api/auth/register

POST /api/auth/register

Body Parameters

{
  "username": "string",
  "email": "user@example.com",
  "password1": "string",
  "password2": "string",
  "first_name": "string",
  "last_name": "string",
  "confirmations": [
    {
      "name": "string",
      "url_display_text": "",
      "url": "",
      "text_prefix": "",
      "required": false,
      "value": false
    }
  ]
}

Params

Name	Location	Type	Required	Description
body	body	RegisterSerializerWithSubscriptionsRequest	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

GET /api/auth/rules

GET /api/auth/rules

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	No response body	Inline

Responses Data Schema

POST This method signs URL for access to the server

POST /api/auth/signing

Signed URL contains a token which authenticates a user on the server.Signed URL is valid during 30 seconds since signing.

Body Parameters

{
  "url": "string"
}

Params

Name	Location	Type	Required	Description
body	body	SigningRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	text URL	Inline

Responses Data Schema

GET Method provides a list with integrated social accounts authentication.

GET /api/auth/social

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Redirects to provider authentication page

GET /api/auth/social/{id}/login/

Redirects to the specified provider authentication page. After successful authentication on the provider side, a redirect to the callback endpoint is performed

Params

Name	Location	Type	Required	Description
id	path	string	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	No response body	Inline

Responses Data Schema

GET Checks the authentication response from specified provider, redirects to the CVAT client if successful.

GET /api/auth/social/{id}/login/callback/

Accepts a request from provider with code and state query parameters. In case of successful authentication on the provider side, it will redirect to the CVAT client

Params

Name	Location	Type	Required	Description
id	path	string	yes	none
code	query	string	no	Returned by provider
state	query	string	no	Returned by provider

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	No response body	Inline

Responses Data Schema

POST Method returns an authentication token based on code parameter

POST /api/auth/social/{id}/login/token/

After successful authentication on the provider side, the provider returns the ‘code’ parameter used to receive an authentication token required for CVAT authentication.

Body Parameters

{
  "access_token": "string",
  "code": "string",
  "id_token": "string",
  "auth_params": "",
  "process": "login",
  "scope": ""
}

Params

Name	Location	Type	Required	Description
id	path	string	yes	none
auth_params	query	string	no	none
process	query	string	no	none
scope	query	string	no	none
body	body	SocialLoginSerializerExRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

CVAT/cloudstorages

GET Returns a paginated list of storages

GET /api/cloudstorages

Params

Name	Location	Type	Required	Description
credentials_type	query	string	no	A simple equality filter for the credentials_type field
filter	query	string	no	A filter term. Available filter_fields: [‘provider_type’, ‘name’, ‘resource’, ‘credentials_type’, ‘owner’, ‘description’, ‘id’]
name	query	string	no	A simple equality filter for the name field
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
owner	query	string	no	A simple equality filter for the owner field
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
provider_type	query	string	no	A simple equality filter for the provider_type field
resource	query	string	no	A simple equality filter for the resource field
search	query	string	no	A search term. Available search_fields: (‘provider_type’, ‘name’, ‘resource’, ‘credentials_type’, ‘owner’, ‘description’)
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘provider_type’, ‘name’, ‘resource’, ‘credentials_type’, ‘owner’, ‘description’, ‘id’]
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method creates a cloud storage with a specified characteristics

POST /api/cloudstorages

Body Parameters

provider_type: string
resource: string
display_name: string
owner: string
credentials_type: string
session_token: string
account_name: string
key: string
secret_key: string
connection_string: string
key_file: string
specific_attributes: string
description: string
manifests: []

Params

Name	Location	Type	Required	Description
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
X-Organization	header	string	no	Organization unique slug
body	body	object	no	none
» provider_type	body	string	yes	none
» resource	body	string	yes	none
» display_name	body	string	yes	none
» owner	body	string	no	none
» credentials_type	body	string	yes	none
» session_token	body	string	no	none
» account_name	body	string	no	none
» key	body	string	no	none
» secret_key	body	string	no	none
» connection_string	body	string	no	none
» key_file	body	string(binary)	no	none
» specific_attributes	body	string	no	none
» description	body	string	no	none
» manifests	body	array	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

GET Method returns details of a specific cloud storage

GET /api/cloudstorages/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this cloud storage.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Methods does a partial update of chosen fields in a cloud storage instance

PATCH /api/cloudstorages/{id}

Body Parameters

provider_type: string
resource: string
display_name: string
owner: string
credentials_type: string
session_token: string
account_name: string
key: string
secret_key: string
connection_string: string
key_file: string
specific_attributes: string
description: string
manifests: []

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this cloud storage.
body	body	object	no	none
» provider_type	body	string	no	none
» resource	body	string	no	none
» display_name	body	string	no	none
» owner	body	string	no	none
» credentials_type	body	string	no	none
» session_token	body	string	no	none
» account_name	body	string	no	none
» key	body	string	no	none
» secret_key	body	string	no	none
» connection_string	body	string	no	none
» key_file	body	string(binary)	no	none
» specific_attributes	body	string	no	none
» description	body	string	no	none
» manifests	body	array	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes a specific cloud storage

DELETE /api/cloudstorages/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this cloud storage.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The cloud storage has been removed	Inline

Responses Data Schema

GET Method returns allowed actions for the cloud storage

GET /api/cloudstorages/{id}/actions

Method return allowed actions for cloud storage. It’s required for reading/writing

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this cloud storage.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Cloud Storage actions (GET	PUT

Responses Data Schema

GET Method returns a manifest content

GET /api/cloudstorages/{id}/content

This method is deprecated and will be removed in version 2.6.0. Please use the new version of API: /cloudstorages/id/content-v2/

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this cloud storage.
manifest_path	query	string	no	Path to the manifest file in a cloud storage

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	A manifest content	Inline

Responses Data Schema

GET Method returns the content of the cloud storage

GET /api/cloudstorages/{id}/content-v2

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this cloud storage.
manifest_path	query	string	no	Path to the manifest file in a cloud storage
next_token	query	string	no	Used to continue listing files in the bucket
page_size	query	integer	no	none
prefix	query	string	no	Prefix to filter data

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	A manifest content	Inline

Responses Data Schema

GET Method returns a preview image from a cloud storage

GET /api/cloudstorages/{id}/preview

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this cloud storage.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Cloud Storage preview	Inline
400	Bad Request	Failed to get cloud storage preview	Inline
404	Not Found	Cloud Storage preview not found	Inline

Responses Data Schema

GET Method returns a cloud storage status

GET /api/cloudstorages/{id}/status

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this cloud storage.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Cloud Storage status (AVAILABLE	NOT_FOUND

Responses Data Schema

CVAT/comments

GET Method returns a paginated list of comments

GET /api/comments

Params

Name	Location	Type	Required	Description
filter	query	string	no	A filter term. Available filter_fields: [‘owner’, ‘id’, ‘issue_id’, ‘frame_id’, ‘job_id’]
frame_id	query	integer	no	A simple equality filter for the frame_id field
issue_id	query	integer	no	A simple equality filter for the issue_id field
job_id	query	integer	no	A simple equality filter for the job_id field
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
owner	query	string	no	A simple equality filter for the owner field
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
search	query	string	no	A search term. Available search_fields: (‘owner’,)
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘owner’, ‘id’, ‘issue_id’, ‘frame_id’, ‘job_id’]
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method creates a comment

POST /api/comments

Body Parameters

{
  "issue": 0,
  "message": "string"
}

Params

Name	Location	Type	Required	Description
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
X-Organization	header	string	no	Organization unique slug
body	body	CommentWriteRequest	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

GET Method returns details of a comment

GET /api/comments/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this comment.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Methods does a partial update of chosen fields in a comment

PATCH /api/comments/{id}

Body Parameters

{
  "message": "string"
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this comment.
body	body	PatchedCommentWriteRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes a comment

DELETE /api/comments/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this comment.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The comment has been deleted	Inline

Responses Data Schema

CVAT/events

GET Method returns csv log file

GET /api/events

Receive logs from the server

Params

Name	Location	Type	Required	Description
action	query	string	no	Used to start downloading process after annotation file had been created
filename	query	string	no	Desired output file name
from	query	string	no	Filter events after the datetime. If no ‘from’ or ‘to’ parameters are passed, the last 30 days will be set.
job_id	query	integer	no	Filter events by job ID
org_id	query	integer	no	Filter events by organization ID
project_id	query	integer	no	Filter events by project ID
query_id	query	string	no	ID of query request that need to check or download
task_id	query	integer	no	Filter events by task ID
to	query	string	no	Filter events before the datetime. If no ‘from’ or ‘to’ parameters are passed, the last 30 days will be set.
user_id	query	integer	no	Filter events by user ID

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Download of file started	Inline
201	Created	CSV log file is ready for downloading	Inline
202	Accepted	Creating a CSV log file has been started	Inline

Responses Data Schema

POST Method saves logs from a client on the server

POST /api/events

Sends logs to the Clickhouse if it is connected

Body Parameters

{
  "events": [],
  "timestamp": "2019-08-24T14:15:22Z"
}

Params

Name	Location	Type	Required	Description
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
X-Organization	header	string	no	Organization unique slug
body	body	ClientEventsRequest	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

CVAT/functions

GET Method returns a paginated list of functions

GET /api/functions

Params

Name	Location	Type	Required	Description
filter	query	string	no	A filter term. Available filter_fields: [‘name’, ‘owner’, ‘provider’, ‘type’, ‘labels’, ‘id’, ‘updated_date’]
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
search	query	string	no	A search term. Available search_fields: (‘name’, ‘owner’, ‘provider’, ‘type’, ‘labels’)
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘name’, ‘owner’, ‘provider’, ‘type’, ‘labels’, ‘id’, ‘updated_date’]
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method creates a function

POST /api/functions

Body Parameters

{
  "provider": "string",
  "url": "string",
  "api_key": "string"
}

Params

Name	Location	Type	Required	Description
body	body	FunctionRequest	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

GET Method returns details of a function

GET /api/functions/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this function.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes a function

DELETE /api/functions/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this function.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The function has been deleted	Inline

Responses Data Schema

GET Method returns a preview image for the function

GET /api/functions/{id}/preview

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this function.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Function image preview	Inline
404	Not Found	Function image preview not found	Inline

Responses Data Schema

POST Method runs a function

POST /api/functions/{id}/run

Body Parameters

{
  "provider": "string",
  "url": "string",
  "api_key": "string"
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this function.
body	body	FunctionRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method returns information about the required function arguments

GET /api/functions/info

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method returns a list of requests

GET /api/functions/requests/

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method calls a function

POST /api/functions/requests/

Body Parameters

{
  "provider": "string",
  "url": "string",
  "api_key": "string"
}

Params

Name	Location	Type	Required	Description
body	body	FunctionRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method returns the status of the request

GET /api/functions/requests/{request_id}

Params

Name	Location	Type	Required	Description
request_id	path	string	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method cancels the request

DELETE /api/functions/requests/{request_id}

Params

Name	Location	Type	Required	Description
request_id	path	string	yes	none

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	No response body	Inline

Responses Data Schema

CVAT/guides

POST Method creates a new annotation guide binded to a project or to a task

POST /api/guides

Body Parameters

{
  "task_id": 0,
  "project_id": 0,
  "markdown": "string"
}

Params

Name	Location	Type	Required	Description
body	body	AnnotationGuideWriteRequest	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

GET Method returns details of a specific annotation guide

GET /api/guides/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this annotation guide.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Methods does a partial update of chosen fields in an annotation guide

PATCH /api/guides/{id}

Body Parameters

{
  "task_id": 0,
  "project_id": 0,
  "markdown": "string"
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this annotation guide.
body	body	PatchedAnnotationGuideWriteRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes a specific annotation guide and all attached assets

DELETE /api/guides/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this annotation guide.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The annotation guide has been deleted	Inline

Responses Data Schema

CVAT/invitations

GET Method returns a paginated list of invitations

GET /api/invitations

Params

Name	Location	Type	Required	Description
filter	query	string	no	A filter term. Available filter_fields: [‘owner’]
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
owner	query	string	no	A simple equality filter for the owner field
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
search	query	string	no	A search term. Available search_fields: (‘owner’,)
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘owner’, ‘created_date’]
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method creates an invitation

POST /api/invitations

Body Parameters

{
  "role": "worker",
  "email": "user@example.com"
}

Params

Name	Location	Type	Required	Description
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
X-Organization	header	string	no	Organization unique slug
body	body	InvitationWriteRequest	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

GET Method returns details of an invitation

GET /api/invitations/{key}

Params

Name	Location	Type	Required	Description
key	path	string	yes	A unique value identifying this invitation.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Methods does a partial update of chosen fields in an invitation

PATCH /api/invitations/{key}

Body Parameters

{
  "role": "worker",
  "email": "user@example.com"
}

Params

Name	Location	Type	Required	Description
key	path	string	yes	A unique value identifying this invitation.
body	body	PatchedInvitationWriteRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes an invitation

DELETE /api/invitations/{key}

Params

Name	Location	Type	Required	Description
key	path	string	yes	A unique value identifying this invitation.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The invitation has been deleted	Inline

Responses Data Schema

CVAT/issues

GET Method returns a paginated list of issues

GET /api/issues

Params

Name	Location	Type	Required	Description
assignee	query	string	no	A simple equality filter for the assignee field
filter	query	string	no	A filter term. Available filter_fields: [‘owner’, ‘assignee’, ‘id’, ‘job_id’, ‘task_id’, ‘resolved’, ‘frame_id’]
frame_id	query	integer	no	A simple equality filter for the frame_id field
job_id	query	integer	no	A simple equality filter for the job_id field
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
owner	query	string	no	A simple equality filter for the owner field
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
resolved	query	string	no	A simple equality filter for the resolved field
search	query	string	no	A search term. Available search_fields: (‘owner’, ‘assignee’)
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘owner’, ‘assignee’, ‘id’, ‘job_id’, ‘task_id’, ‘resolved’, ‘frame_id’]
task_id	query	integer	no	A simple equality filter for the task_id field
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method creates an issue

POST /api/issues

Body Parameters

{
  "frame": 2147483647,
  "position": [
    0
  ],
  "job": 0,
  "assignee": 0,
  "message": "string",
  "resolved": true
}

Params

Name	Location	Type	Required	Description
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
X-Organization	header	string	no	Organization unique slug
body	body	IssueWriteRequest	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

GET Method returns details of an issue

GET /api/issues/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this issue.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Methods does a partial update of chosen fields in an issue

PATCH /api/issues/{id}

Body Parameters

{
  "position": [
    0
  ],
  "assignee": 0,
  "resolved": true
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this issue.
body	body	PatchedIssueWriteRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes an issue

DELETE /api/issues/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this issue.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The issue has been deleted	Inline

Responses Data Schema

CVAT/jobs

GET Method returns a paginated list of jobs

GET /api/jobs

Params

Name	Location	Type	Required	Description
assignee	query	string	no	A simple equality filter for the assignee field
dimension	query	string	no	A simple equality filter for the dimension field
filter	query	string	no	A filter term. Available filter_fields: [‘task_name’, ‘project_name’, ‘assignee’, ‘state’, ‘stage’, ‘id’, ‘task_id’, ‘project_id’, ‘updated_date’, ‘dimension’, ‘type’]
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
project_id	query	integer	no	A simple equality filter for the project_id field
project_name	query	string	no	A simple equality filter for the project_name field
search	query	string	no	A search term. Available search_fields: (‘task_name’, ‘project_name’, ‘assignee’, ‘state’, ‘stage’)
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘task_name’, ‘project_name’, ‘assignee’, ‘state’, ‘stage’, ‘id’, ‘task_id’, ‘project_id’, ‘updated_date’, ‘dimension’, ‘type’]
stage	query	string	no	A simple equality filter for the stage field
state	query	string	no	A simple equality filter for the state field
task_id	query	integer	no	A simple equality filter for the task_id field
task_name	query	string	no	A simple equality filter for the task_name field
type	query	string	no	A simple equality filter for the type field
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method creates a new job in the task

POST /api/jobs

Body Parameters

{
  "assignee": 0,
  "stage": "annotation",
  "state": "new",
  "type": "annotation",
  "task_id": 0,
  "frame_selection_method": "random_uniform",
  "frame_count": 0,
  "seed": 0,
  "frames": [
    0
  ]
}

Params

Name	Location	Type	Required	Description
body	body	JobWriteRequest	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

GET Method provides a meta information about media files which are related with the job

GET /api/jobs/{id}/data/meta

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this job.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method returns details of a job

GET /api/jobs/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this job.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Methods does a partial update of chosen fields in a job

PATCH /api/jobs/{id}

Body Parameters

{
  "assignee": 0,
  "stage": "annotation",
  "state": "new"
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this job.
body	body	PatchedJobWriteRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes a job and its related annotations

DELETE /api/jobs/{id}

Please note, that not every job can be removed. Currently,
it is only available for Ground Truth jobs.

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this job.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The job has been deleted	Inline

Responses Data Schema

GET Method returns annotations for a specific job as a JSON document. If format is specified, a zip archive is returned.

GET /api/jobs/{id}/annotations/

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this job.
action	query	string	no	Used to start downloading process after annotation file had been created
cloud_storage_id	query	number	no	Storage id
filename	query	string	no	Desired output file name
format	query	string	no	Desired output format name
location	query	string	no	Where need to save downloaded annotation
use_default_location	query	string	no	Use the location that was configured in the task to export annotation

Description

format: Desired output format name
You can get the list of supported formats at:
/server/annotation/formats

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Download of file started	Inline
201	Created	Output file is ready for downloading	Inline
202	Accepted	Exporting has been started	Inline
405	Method Not Allowed	Format is not available	Inline

Responses Data Schema

POST Method allows to initialize the process of the job annotation upload from a local file or a cloud storage

POST /api/jobs/{id}/annotations/

The request POST /api/jobs/id/annotations will initiate file upload and will create
the rq job on the server in which the process of annotations uploading from file
will be carried out. Please, use the PUT /api/jobs/id/annotations endpoint for checking status of the process.

Body Parameters

annotation_file: string

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this job.
cloud_storage_id	query	number	no	Storage id
filename	query	string	no	Annotation file name
format	query	string	no	Input format name
location	query	string	no	where to import the annotation from
use_default_location	query	string	no	Use the location that was configured in the task to import annotation
body	body	object	no	none
» annotation_file	body	string(binary)	yes	none

Description

format: Input format name
You can get the list of supported formats at:
/server/annotation/formats

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	Uploading has finished	Inline
202	Accepted	Uploading has been started	Inline
405	Method Not Allowed	Format is not available	Inline

Responses Data Schema

PUT Method performs an update of all annotations in a specific job or used for uploading annotations from a file

PUT /api/jobs/{id}/annotations/

To check the status of the process of uploading a job annotations from a file:

After initiating the annotations upload, you will receive an rq_id parameter.
Make sure to include this parameter as a query parameter in your subsequent
PUT /api/jobs/id/annotations requests to track the status of the annotations upload.

Body Parameters

{}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this job.
cloud_storage_id	query	number	no	Storage id
filename	query	string	no	Annotation file name
format	query	string	no	Input format name
location	query	string	no	where to import the annotation from
rq_id	query	string	no	rq id
use_default_location	query	string	no	Use the location that was configured in the task to import annotation
body	body	object	no	none

Description

format: Input format name
You can get the list of supported formats at:
/server/annotation/formats

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	Uploading has finished	Inline
202	Accepted	Uploading has been started	Inline
405	Method Not Allowed	Format is not available	Inline

Responses Data Schema

PATCH Method performs a partial update of annotations in a specific job

PATCH /api/jobs/{id}/annotations/

Body Parameters

version: 0
tags: []
shapes: []
tracks: []

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this job.
action	query	string	yes	none
body	body	object	no	none
» version	body	integer	no	none
» tags	body	array	no	none
» shapes	body	array	no	none
» tracks	body	array	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Annotations successfully uploaded	Inline

Responses Data Schema

DELETE Method deletes all annotations for a specific job

DELETE /api/jobs/{id}/annotations/

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this job.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The annotation has been deleted	Inline

Responses Data Schema

GET Method returns data for a specific job

GET /api/jobs/{id}/data

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this job.
number	query	integer	no	A unique number value identifying chunk or frame
quality	query	string	no	Specifies the quality level of the requested data
type	query	string	no	Specifies the type of the requested data

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Data of a specific type	Inline

Responses Data Schema

GET Export job as a dataset in a specific format

GET /api/jobs/{id}/dataset

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this job.
action	query	string	no	Used to start downloading process after annotation file had been created
cloud_storage_id	query	number	no	Storage id
filename	query	string	no	Desired output file name
format	query	string	yes	Desired output format name
location	query	string	no	Where need to save downloaded dataset
use_default_location	query	string	no	Use the location that was configured in the task to export dataset

Description

format: Desired output format name
You can get the list of supported formats at:
/server/annotation/formats

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Download of file started	Inline
201	Created	Output file is ready for downloading	Inline
202	Accepted	Exporting has been started	Inline
405	Method Not Allowed	Format is not available	Inline

Responses Data Schema

GET Method returns a preview image for the job

GET /api/jobs/{id}/preview

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this job.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Job image preview	Inline

Responses Data Schema

CVAT/tasks

PATCH Method provides a meta information about media files which are related with the job

PATCH /api/jobs/{id}/data/meta

Body Parameters

{
  "deleted_frames": [
    0
  ]
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this job.
body	body	PatchedDataMetaWriteRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Returns a paginated list of tasks

GET /api/tasks

Params

Name	Location	Type	Required	Description
assignee	query	string	no	A simple equality filter for the assignee field
dimension	query	string	no	A simple equality filter for the dimension field
filter	query	string	no	A filter term. Available filter_fields: [‘project_name’, ‘name’, ‘owner’, ‘status’, ‘assignee’, ‘subset’, ‘mode’, ‘dimension’, ‘tracker_link’, ‘id’, ‘project_id’, ‘updated_date’]
mode	query	string	no	A simple equality filter for the mode field
name	query	string	no	A simple equality filter for the name field
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
owner	query	string	no	A simple equality filter for the owner field
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
project_id	query	integer	no	A simple equality filter for the project_id field
project_name	query	string	no	A simple equality filter for the project_name field
search	query	string	no	A search term. Available search_fields: (‘project_name’, ‘name’, ‘owner’, ‘status’, ‘assignee’, ‘subset’, ‘mode’, ‘dimension’, ‘tracker_link’)
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘project_name’, ‘name’, ‘owner’, ‘status’, ‘assignee’, ‘subset’, ‘mode’, ‘dimension’, ‘tracker_link’, ‘id’, ‘project_id’, ‘updated_date’]
status	query	string	no	A simple equality filter for the status field
subset	query	string	no	A simple equality filter for the subset field
tracker_link	query	string	no	A simple equality filter for the tracker_link field
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method creates a new task in a database without any attached images and videos

POST /api/tasks

Body Parameters

{
  "name": "string",
  "project_id": 0,
  "owner_id": 0,
  "assignee_id": 0,
  "bug_tracker": "string",
  "overlap": 2147483647,
  "segment_size": 2147483647,
  "labels": [
    {
      "id": 0,
      "name": "string",
      "color": "string",
      "attributes": [],
      "deleted": true,
      "type": "string",
      "svg": "string",
      "sublabels": [
        {
          "id": 0,
          "name": "string",
          "color": "string",
          "attributes": [],
          "type": "string",
          "has_parent": true
        }
      ]
    }
  ],
  "subset": "string",
  "target_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  },
  "source_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  }
}

Params

Name	Location	Type	Required	Description
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
X-Organization	header	string	no	Organization unique slug
body	body	TaskWriteRequest	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

GET Method returns details of a specific task

GET /api/tasks/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Methods does a partial update of chosen fields in a task

PATCH /api/tasks/{id}

Body Parameters

{
  "name": "string",
  "project_id": 0,
  "owner_id": 0,
  "assignee_id": 0,
  "bug_tracker": "string",
  "labels": [
    {
      "id": 0,
      "name": "string",
      "color": "string",
      "attributes": [],
      "deleted": true,
      "type": "string",
      "svg": "string",
      "sublabels": [
        {
          "id": 0,
          "name": "string",
          "color": "string",
          "attributes": [],
          "type": "string",
          "has_parent": true
        }
      ]
    }
  ],
  "subset": "string",
  "target_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  },
  "source_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  }
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.
body	body	PatchedTaskWriteRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes a specific task, all attached jobs, annotations, and data

DELETE /api/tasks/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The task has been deleted	Inline

Responses Data Schema

GET Method allows to download task annotations

GET /api/tasks/{id}/annotations/

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.
action	query	string	no	Used to start downloading process after annotation file had been created
cloud_storage_id	query	number	no	Storage id
filename	query	string	no	Desired output file name
format	query	string	no	Desired output format name
location	query	string	no	Where need to save downloaded dataset
use_default_location	query	string	no	Use the location that was configured in the task to export annotation

Description

format: Desired output format name
You can get the list of supported formats at:
/server/annotation/formats

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Download of file started	Inline
201	Created	Annotations file is ready to download	Inline
202	Accepted	Dump of annotations has been started	Inline
400	Bad Request	Exporting without data is not allowed	Inline
405	Method Not Allowed	Format is not available	Inline

Responses Data Schema

POST Method allows to initialize the process of upload task annotations from a local or a cloud storage file

POST /api/tasks/{id}/annotations/

The request POST /api/tasks/id/annotations will initiate file upload and will create
the rq job on the server in which the process of annotations uploading from file
will be carried out. Please, use the PUT /api/tasks/id/annotations endpoint for checking status of the process.

Body Parameters

{}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.
cloud_storage_id	query	number	no	Storage id
filename	query	string	no	Annotation file name
format	query	string	no	Input format name
location	query	string	no	where to import the annotation from
use_default_location	query	string	no	Use the location that was configured in task to import annotations
body	body	object	no	none

Description

format: Input format name
You can get the list of supported formats at:
/server/annotation/formats

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	Uploading has finished	Inline
202	Accepted	Uploading has been started	Inline
405	Method Not Allowed	Format is not available	Inline

Responses Data Schema

PUT Method allows to upload task annotations or edit existing annotations

PUT /api/tasks/{id}/annotations/

To check the status of the process of uploading a task annotations from a file:

After initiating the annotations upload, you will receive an rq_id parameter.
Make sure to include this parameter as a query parameter in your subsequent
PUT /api/tasks/id/annotations requests to track the status of the annotations upload.

Body Parameters

{}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.
format	query	string	no	Input format name
rq_id	query	string	no	rq id
body	body	object	no	none

Description

format: Input format name
You can get the list of supported formats at:
/server/annotation/formats

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	Uploading has finished	Inline
202	Accepted	Uploading has been started	Inline
405	Method Not Allowed	Format is not available	Inline

Responses Data Schema

PATCH Method performs a partial update of annotations in a specific task

PATCH /api/tasks/{id}/annotations/

Body Parameters

version: 0
tags: []
shapes: []
tracks: []

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.
action	query	string	yes	none
body	body	object	no	none
» version	body	integer	no	none
» tags	body	array	no	none
» shapes	body	array	no	none
» tracks	body	array	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes all annotations for a specific task

DELETE /api/tasks/{id}/annotations/

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The annotation has been deleted	Inline

Responses Data Schema

GET Method backup a specified task

GET /api/tasks/{id}/backup

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.
action	query	string	no	Used to start downloading process after backup file had been created
cloud_storage_id	query	number	no	Storage id
filename	query	string	no	Backup file name
location	query	string	no	Where need to save downloaded backup
use_default_location	query	string	no	Use the location that was configured in the task to export backup

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Download of file started	Inline
201	Created	Output backup file is ready for downloading	Inline
202	Accepted	Creating a backup file has been started	Inline

Responses Data Schema

GET Method returns data for a specific task

GET /api/tasks/{id}/data/

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.
number	query	integer	no	A unique number value identifying chunk or frame
quality	query	string	no	Specifies the quality level of the requested data
type	query	string	no	Specifies the type of the requested data

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Data of a specific type	Inline

Responses Data Schema

POST Method permanently attaches data (images, video, etc.) to a task

POST /api/tasks/{id}/data/

Allows to upload data to a task.
Supports the TUS open file uploading protocol (https://tus.io/).

Supports the following protocols:

1. A single Data request

and

2.1. An Upload-Start request
2.2.a. Regular TUS protocol requests (Upload-Length + Chunks)
2.2.b. Upload-Multiple requests
2.3. An Upload-Finish request

Requests:

• Data - POST, no extra headers or ‘Upload-Start’ + ‘Upload-Finish’ headers.
  Contains data in the body.
• Upload-Start - POST, has an ‘Upload-Start’ header. No body is expected.
• Upload-Length - POST, has an ‘Upload-Length’ header (see the TUS specification)
• Chunk - HEAD/PATCH (see the TUS specification). Sent to /data/ endpoints.
• Upload-Finish - POST, has an ‘Upload-Finish’ header. Can contain data in the body.
• Upload-Multiple - POST, has an ‘Upload-Multiple’ header. Contains data in the body.

The ‘Upload-Finish’ request allows to specify the uploaded files should be ordered.
This may be needed if the files can be sent unordered. To state that the input files
are sent ordered, pass an empty list of files in the ‘upload_file_order’ field.
If the files are sent unordered, the ordered file list is expected
in the ‘upload_file_order’ field. It must be a list of string file paths,
relative to the dataset root.

Example:
files = [
“cats/cat_1.jpg”,
“dogs/dog2.jpg”,
“image_3.png”,
…
]

Independently of the file declaration field used
(‘client_files’, ‘server_files’, etc.), when the ‘predefined’
sorting method is selected, the uploaded files will be ordered according
to the ‘.jsonl’ manifest file, if it is found in the list of files.
For archives (e.g. ‘.zip’), a manifest file (‘*.jsonl’) is required when using
the ‘predefined’ file ordering. Such file must be provided next to the archive
in the list of files. Read more about manifest files here:
https://opencv.github.io/cvat/docs/manual/advanced/dataset_manifest/

After all data is sent, the operation status can be retrieved via
the /status endpoint.

Body Parameters

chunk_size: 0
size: 0
image_quality: 0
start_frame: 0
stop_frame: 0
frame_filter: string
compressed_chunk_type: string
original_chunk_type: string
client_files: []
server_files: []
remote_files: []
use_zip_chunks: string
server_files_exclude: []
cloud_storage_id: 0
use_cache: string
copy_data: string
storage_method: string
storage: string
sorting_method: string
filename_pattern: string
job_file_mapping: []
upload_file_order: []

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.
Upload-Finish	header	string	no	Finishes data upload. Can be combined with Upload-Start header to create task data with one request
Upload-Multiple	header	string	no	Indicates that data with this request are single or multiple files that should be attached to a task
Upload-Start	header	string	no	Initializes data upload. Optionally, can include upload metadata in the request body.
body	body	object	no	none
» chunk_size	body	integer	no	Maximum number of frames per chunk
» size	body	integer	no	The number of frames
» image_quality	body	integer	yes	Image quality to use during annotation
» start_frame	body	integer	no	First frame index
» stop_frame	body	integer	no	Last frame index
» frame_filter	body	string	no	Frame filter. The only supported syntax is: ‘step=N’
» compressed_chunk_type	body	string	no	none
» original_chunk_type	body	string	no	none
» client_files	body	string(binary)	no	Uploaded files
» server_files	body	array	no	Paths to files from a file share mounted on the server, or from a cloud storage
» remote_files	body	array	no	Direct download URLs for files
» use_zip_chunks	body	string	no	When true, video chunks will be represented as zip archives with decoded video frames.
» server_files_exclude	body	array	no	Paths to files and directories from a file share mounted on the server, or from a cloud storage
» cloud_storage_id	body	integer	no	If not null, the files referenced by server_files will be retrieved
» use_cache	body	string	no	Enable or disable task data chunk caching for the task.
» copy_data	body	string	no	Copy data from the server file share to CVAT during the task creation.
» storage_method	body	string	no	none
» storage	body	string	no	none
» sorting_method	body	string	no	none
» filename_pattern	body	string	no	A filename filter for cloud storage files
» job_file_mapping	body	array	no	Represents a file-to-job mapping. Useful to specify a custom job
» upload_file_order	body	array	no	Allows to specify file order for client_file uploads.

Description

» use_zip_chunks: When true, video chunks will be represented as zip archives with decoded video frames.
When false, video chunks are represented as video segments

» server_files_exclude: Paths to files and directories from a file share mounted on the server, or from a cloud storage
that should be excluded from the directories specified in server_files.
This option cannot be used together with filename_pattern.
The server_files_exclude parameter cannot be used to exclude a part of dataset from an archive.

Examples:

Exclude all files from subfolder 'sub/sub_1/sub_2’and single file ‘sub/image.jpg’ from specified folder:
server_files = [‘sub/’], server_files_exclude = [‘sub/sub_1/sub_2/’, ‘sub/image.jpg’]

Exclude all cloud storage files with prefix ‘sub’ from the content of manifest file:
server_files = [‘manifest.jsonl’], server_files_exclude = [‘sub/’]

» cloud_storage_id: If not null, the files referenced by server_files will be retrieved
from the cloud storage with the specified ID.
The cloud storages applicable depend on the context.
In the user sandbox, only the user sandbox cloud storages can be used.
In an organization, only the organization cloud storages can be used.

» use_cache: Enable or disable task data chunk caching for the task.
Read more: https://opencv.github.io/cvat/docs/manual/advanced/data_on_fly/

» copy_data: Copy data from the server file share to CVAT during the task creation.
This will create a copy of the data, making the server independent from
the file share availability

» filename_pattern: A filename filter for cloud storage files
listed in the manifest. Supports fnmatch wildcards.
Read more: https://docs.python.org/3/library/fnmatch.html

» job_file_mapping: Represents a file-to-job mapping. Useful to specify a custom job
configuration during task creation. This option is not compatible with
most other job split-related options. Files in the jobs must not overlap or repeat.

Example:
[
[“file1.jpg”, “file2.jpg”], # job #1 files
[“file3.png”], # job #2 files
[“file4.jpg”, “file5.png”, “file6.bmp”], # job #3 files
]

» upload_file_order: Allows to specify file order for client_file uploads.
Only valid with the “predefined” sorting method selected.

To state that the input files are sent in the correct order,
pass an empty list.

If you want to send files in an arbitrary order
and reorder them afterwards on the server,
pass the list of file names in the required order.

Response Examples

202 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
202	Accepted	No response body	Inline

Responses Data Schema

GET Method provides a meta information about media files which are related with the task

GET /api/tasks/{id}/data/meta

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Method provides a meta information about media files which are related with the task

PATCH /api/tasks/{id}/data/meta

Body Parameters

{
  "deleted_frames": [
    0
  ]
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.
body	body	PatchedDataMetaWriteRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Export task as a dataset in a specific format

GET /api/tasks/{id}/dataset

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.
action	query	string	no	Used to start downloading process after annotation file had been created
cloud_storage_id	query	number	no	Storage id
filename	query	string	no	Desired output file name
format	query	string	yes	Desired output format name
location	query	string	no	Where need to save downloaded dataset
use_default_location	query	string	no	Use the location that was configured in task to export annotations

Description

format: Desired output format name
You can get the list of supported formats at:
/server/annotation/formats

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Download of file started	Inline
201	Created	Output file is ready for downloading	Inline
202	Accepted	Exporting has been started	Inline
400	Bad Request	Exporting without data is not allowed	Inline
405	Method Not Allowed	Format is not available	Inline

Responses Data Schema

GET Method returns a preview image for the task

GET /api/tasks/{id}/preview

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Task image preview	Inline
404	Not Found	Task image preview not found	Inline

Responses Data Schema

GET When task is being created the method returns information about a status of the creation process

GET /api/tasks/{id}/status

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this task.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method recreates a task from an attached task backup file

POST /api/tasks/backup/

The backup import process is as follows:

The first request POST /api/tasks/backup will initiate file upload and will create
the rq job on the server in which the process of a task creating from an uploaded backup
will be carried out.

After initiating the backup upload, you will receive an rq_id parameter.
Make sure to include this parameter as a query parameter in your subsequent requests
to track the status of the task creation.
Once the task has been successfully created, the server will return the id of the newly created task.

Body Parameters

task_file: string

Params

Name	Location	Type	Required	Description
cloud_storage_id	query	number	no	Storage id
filename	query	string	no	Backup file name
location	query	string	no	Where to import the backup file from
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
rq_id	query	string	no	rq id
X-Organization	header	string	no	Organization unique slug
body	body	object	no	none
» task_file	body	string(binary)	yes	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	The task has been imported	Inline
202	Accepted	Importing a backup file has been started	Inline

Responses Data Schema

CVAT/labels

GET Method returns a paginated list of labels

GET /api/labels

Params

Name	Location	Type	Required	Description
color	query	string	no	A simple equality filter for the color field
filter	query	string	no	A filter term. Available filter_fields: [‘name’, ‘parent’, ‘id’, ‘type’, ‘color’, ‘parent_id’]
job_id	query	integer	no	A simple equality filter for job id
name	query	string	no	A simple equality filter for the name field
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
parent	query	string	no	A simple equality filter for the parent field
parent_id	query	integer	no	A simple equality filter for the parent_id field
project_id	query	integer	no	A simple equality filter for project id
search	query	string	no	A search term. Available search_fields: (‘name’, ‘parent’)
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘name’, ‘parent’, ‘id’, ‘type’, ‘color’, ‘parent_id’]
task_id	query	integer	no	A simple equality filter for task id
type	query	string	no	A simple equality filter for the type field
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method returns details of a label

GET /api/labels/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this label.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Methods does a partial update of chosen fields in a labelTo modify a sublabel, please use the PATCH method of the parent label

PATCH /api/labels/{id}

Body Parameters

{
  "id": 0,
  "name": "string",
  "color": "string",
  "attributes": [],
  "deleted": true,
  "type": "string",
  "svg": "string",
  "sublabels": [
    {
      "id": 0,
      "name": "string",
      "color": "string",
      "attributes": [],
      "type": "string",
      "has_parent": true
    }
  ]
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this label.
body	body	PatchedLabelRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes a label. To delete a sublabel, please use the PATCH method of the parent label

DELETE /api/labels/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this label.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The label has been deleted	Inline

Responses Data Schema

CVAT/lambda

GET Method returns a list of functions

GET /api/lambda/functions

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	No response body	Inline

Responses Data Schema

GET Method returns the information about the function

GET /api/lambda/functions/{func_id}

Params

Name	Location	Type	Required	Description
func_id	path	string	yes	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Information about the function	Inline

Responses Data Schema

POST /api/lambda/functions/{func_id}

POST /api/lambda/functions/{func_id}

Allows to execute a function for immediate computation.

Intended for short-lived executions, useful for interactive calls.

When executed for interactive annotation, the job id must be specified
in the ‘job’ input field. The task id is not required in this case,
but if it is specified, it must match the job task id.

Body Parameters

{
  "job": 0,
  "task": 0
}

Params

Name	Location	Type	Required	Description
func_id	path	string	yes	none
body	body	OnlineFunctionCallRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Returns function invocation results	Inline

Responses Data Schema

GET Method returns a list of requests

GET /api/lambda/requests

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method calls the function

POST /api/lambda/requests

Body Parameters

{
  "function": "string",
  "task": 0,
  "job": 0,
  "quality": "original",
  "cleanup": false,
  "convMaskToPoly": false,
  "threshold": 0,
  "mapping": {
    "property1": {
      "property1": "string",
      "property2": "string"
    },
    "property2": {
      "property1": "string",
      "property2": "string"
    }
  },
  "max_distance": 0
}

Params

Name	Location	Type	Required	Description
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
X-Organization	header	string	no	Organization unique slug
body	body	FunctionCallRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method returns the status of the request

GET /api/lambda/requests/{id}

Params

Name	Location	Type	Required	Description
id	path	string	yes	Request id

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

CVAT/limits

GET Method returns a paginated list of limits according to query parameters

GET /api/limits

Params

Name	Location	Type	Required	Description
filter	query	string	no	A filter term. Available filter_fields: [‘user_id’, ‘user’, ‘id’]
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘user_id’, ‘user’, ‘id’]
user	query	string	no	A simple equality filter for the user field
user_id	query	integer	no	A simple equality filter for the user_id field
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method creates a limit

POST /api/limits

Body Parameters

{
  "user": 0,
  "org": 0,
  "type": "default",
  "limits": {
    "tasks": 0,
    "projects": 0,
    "cloud_storages": 0,
    "tasks_per_project": 0,
    "webhooks_per_project": 0,
    "function_calls": 0,
    "automatic_annotation": true,
    "job_export_dataset": true,
    "task_export_dataset": true,
    "project_export_dataset": true,
    "webhooks_per_organization": 0,
    "memberships": 0,
    "organizations": 0
  }
}

Params

Name	Location	Type	Required	Description
body	body	LimitRequest	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

GET /api/limits/{id}

GET /api/limits/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this limit.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PUT /api/limits/{id}

PUT /api/limits/{id}

Body Parameters

{
  "user": 0,
  "org": 0,
  "type": "default",
  "limits": {
    "tasks": 0,
    "projects": 0,
    "cloud_storages": 0,
    "tasks_per_project": 0,
    "webhooks_per_project": 0,
    "function_calls": 0,
    "automatic_annotation": true,
    "job_export_dataset": true,
    "task_export_dataset": true,
    "project_export_dataset": true,
    "webhooks_per_organization": 0,
    "memberships": 0,
    "organizations": 0
  }
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this limit.
body	body	LimitRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Method updates a limit

PATCH /api/limits/{id}

Body Parameters

{
  "user": 0,
  "org": 0,
  "type": "default",
  "limits": {
    "tasks": 0,
    "projects": 0,
    "cloud_storages": 0,
    "tasks_per_project": 0,
    "webhooks_per_project": 0,
    "function_calls": 0,
    "automatic_annotation": true,
    "job_export_dataset": true,
    "task_export_dataset": true,
    "project_export_dataset": true,
    "webhooks_per_organization": 0,
    "memberships": 0,
    "organizations": 0
  }
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this limit.
body	body	PatchedLimitRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes a limit

DELETE /api/limits/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this limit.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The limit has been deleted	Inline

Responses Data Schema

GET /api/limits/default

GET /api/limits/default

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

CVAT/memberships

GET Method returns a paginated list of memberships

GET /api/memberships

Params

Name	Location	Type	Required	Description
filter	query	string	no	A filter term. Available filter_fields: [‘user’, ‘role’, ‘id’]
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
role	query	string	no	A simple equality filter for the role field
search	query	string	no	A search term. Available search_fields: (‘user’, ‘role’)
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘user’, ‘role’, ‘id’]
user	query	string	no	A simple equality filter for the user field
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method returns details of a membership

GET /api/memberships/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this membership.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Methods does a partial update of chosen fields in a membership

PATCH /api/memberships/{id}

Body Parameters

{
  "role": "worker"
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this membership.
body	body	PatchedMembershipWriteRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes a membership

DELETE /api/memberships/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this membership.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The membership has been deleted	Inline

Responses Data Schema

CVAT/organizations

GET Method returns a paginated list of organizations

GET /api/organizations

Params

Name	Location	Type	Required	Description
filter	query	string	no	A filter term. Available filter_fields: [‘name’, ‘owner’, ‘id’, ‘slug’]
name	query	string	no	A simple equality filter for the name field
owner	query	string	no	A simple equality filter for the owner field
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
search	query	string	no	A search term. Available search_fields: (‘name’, ‘owner’)
slug	query	string	no	A simple equality filter for the slug field
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘name’, ‘owner’, ‘id’, ‘slug’]

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method creates an organization

POST /api/organizations

Body Parameters

{
  "slug": "string",
  "name": "string",
  "description": "string",
  "contact": {
    "property1": "string",
    "property2": "string"
  }
}

Params

Name	Location	Type	Required	Description
body	body	OrganizationWriteRequest	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

GET Method returns details of an organization

GET /api/organizations/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this organization.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Methods does a partial update of chosen fields in an organization

PATCH /api/organizations/{id}

Body Parameters

{
  "slug": "string",
  "name": "string",
  "description": "string",
  "contact": {
    "property1": "string",
    "property2": "string"
  }
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this organization.
body	body	PatchedOrganizationWriteRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes an organization

DELETE /api/organizations/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this organization.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The organization has been deleted	Inline

Responses Data Schema

CVAT/projects

GET Returns a paginated list of projects

GET /api/projects

Params

Name	Location	Type	Required	Description
assignee	query	string	no	A simple equality filter for the assignee field
filter	query	string	no	A filter term. Available filter_fields: [‘name’, ‘owner’, ‘assignee’, ‘status’, ‘id’, ‘updated_date’]
name	query	string	no	A simple equality filter for the name field
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
owner	query	string	no	A simple equality filter for the owner field
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
search	query	string	no	A search term. Available search_fields: (‘name’, ‘owner’, ‘assignee’, ‘status’)
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘name’, ‘owner’, ‘assignee’, ‘status’, ‘id’, ‘updated_date’]
status	query	string	no	A simple equality filter for the status field
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method creates a new project

POST /api/projects

Body Parameters

{
  "name": "string",
  "labels": [],
  "owner_id": 0,
  "assignee_id": 0,
  "bug_tracker": "string",
  "target_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  },
  "source_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  },
  "task_subsets": [
    "string"
  ]
}

Params

Name	Location	Type	Required	Description
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
X-Organization	header	string	no	Organization unique slug
body	body	ProjectWriteRequest	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

GET Method returns details of a specific project

GET /api/projects/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this project.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Methods does a partial update of chosen fields in a project

PATCH /api/projects/{id}

Body Parameters

{
  "name": "string",
  "labels": [],
  "owner_id": 0,
  "assignee_id": 0,
  "bug_tracker": "string",
  "target_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  },
  "source_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  },
  "task_subsets": [
    "string"
  ]
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this project.
body	body	PatchedProjectWriteRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes a specific project

DELETE /api/projects/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this project.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The project has been deleted	Inline

Responses Data Schema

GET Method allows to download project annotations

GET /api/projects/{id}/annotations

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this project.
action	query	string	no	Used to start downloading process after annotation file had been created
cloud_storage_id	query	number	no	Storage id
filename	query	string	no	Desired output file name
format	query	string	yes	Desired output format name
location	query	string	no	Where need to save downloaded dataset
use_default_location	query	string	no	Use the location that was configured in project to export annotation

Description

format: Desired output format name
You can get the list of supported formats at:
/server/annotation/formats

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Download of file started	Inline
201	Created	Annotations file is ready to download	Inline
202	Accepted	Dump of annotations has been started	Inline
401	Unauthorized	Format is not specified	Inline
405	Method Not Allowed	Format is not available	Inline

Responses Data Schema

GET Methods creates a backup copy of a project

GET /api/projects/{id}/backup

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this project.
action	query	string	no	Used to start downloading process after backup file had been created
cloud_storage_id	query	number	no	Storage id
filename	query	string	no	Backup file name
location	query	string	no	Where need to save downloaded backup
use_default_location	query	string	no	Use the location that was configured in project to export backup

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Download of file started	Inline
201	Created	Output backup file is ready for downloading	Inline
202	Accepted	Creating a backup file has been started	Inline

Responses Data Schema

GET Export project as a dataset in a specific format

GET /api/projects/{id}/dataset/

To check the status of the process of importing a project dataset from a file:

After initiating the dataset upload, you will receive an rq_id parameter.
Make sure to include this parameter as a query parameter in your subsequent
GET /api/projects/id/dataset requests to track the status of the dataset import.
Also you should specify action parameter: action=import_status.

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this project.
action	query	string	no	Used to start downloading process after annotation file had been created
cloud_storage_id	query	number	no	Storage id
filename	query	string	no	Desired output file name
format	query	string	no	Desired output format name
location	query	string	no	Where need to save downloaded dataset
rq_id	query	string	no	rq id
use_default_location	query	string	no	Use the location that was configured in project to import dataset

Description

format: Desired output format name
You can get the list of supported formats at:
/server/annotation/formats

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Download of file started	Inline
201	Created	Output file is ready for downloading	Inline
202	Accepted	Exporting has been started	Inline
405	Method Not Allowed	Format is not available	Inline

Responses Data Schema

POST Import dataset in specific format as a project or check status of dataset import process

POST /api/projects/{id}/dataset/

The request POST /api/projects/id/dataset will initiate file upload and will create
the rq job on the server in which the process of dataset import from a file
will be carried out. Please, use the GET /api/projects/id/dataset endpoint for checking status of the process.

Body Parameters

{}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this project.
cloud_storage_id	query	number	no	Storage id
filename	query	string	no	Dataset file name
format	query	string	no	Desired dataset format name
location	query	string	no	Where to import the dataset from
use_default_location	query	string	no	Use the location that was configured in the project to import annotations
body	body	object	no	none

Description

format: Desired dataset format name
You can get the list of supported formats at:
/server/annotation/formats

Response Examples

202 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
202	Accepted	Importing has been started	Inline
400	Bad Request	Failed to import dataset	Inline
405	Method Not Allowed	Format is not available	Inline

Responses Data Schema

GET Method returns a preview image for the project

GET /api/projects/{id}/preview

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this project.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	Project image preview	Inline
404	Not Found	Project image preview not found	Inline

Responses Data Schema

POST Methods create a project from a backup

POST /api/projects/backup/

The backup import process is as follows:

The first request POST /api/projects/backup will initiate file upload and will create
the rq job on the server in which the process of a project creating from an uploaded backup
will be carried out.

After initiating the backup upload, you will receive an rq_id parameter.
Make sure to include this parameter as a query parameter in your subsequent requests
to track the status of the project creation.
Once the project has been successfully created, the server will return the id of the newly created project.

Body Parameters

{}

Params

Name	Location	Type	Required	Description
cloud_storage_id	query	number	no	Storage id
filename	query	string	no	Backup file name
location	query	string	no	Where to import the backup file from
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
rq_id	query	string	no	rq id
X-Organization	header	string	no	Organization unique slug
body	body	object	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	The project has been imported	Inline
202	Accepted	Importing a backup file has been started	Inline

Responses Data Schema

CVAT/quality

GET Method returns a paginated list of annotation conflicts

GET /api/quality/conflicts

Params

Name	Location	Type	Required	Description
filter	query	string	no	A filter term. Available filter_fields: [‘id’, ‘frame’, ‘type’, ‘job_id’, ‘task_id’, ‘severity’]
frame	query	integer	no	A simple equality filter for the frame field
job_id	query	integer	no	A simple equality filter for the job_id field
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
report_id	query	integer	no	A simple equality filter for report id
severity	query	string	no	A simple equality filter for the severity field
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘id’, ‘frame’, ‘type’, ‘job_id’, ‘task_id’, ‘severity’]
task_id	query	integer	no	A simple equality filter for the task_id field
type	query	string	no	A simple equality filter for the type field
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method returns a paginated list of quality reports

GET /api/quality/reports

Params

Name	Location	Type	Required	Description
filter	query	string	no	A filter term. Available filter_fields: [‘id’, ‘job_id’, ‘created_date’, ‘gt_last_updated’, ‘target_last_updated’, ‘parent_id’]
job_id	query	integer	no	A simple equality filter for the job_id field
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
parent_id	query	integer	no	A simple equality filter for the parent_id field
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘id’, ‘job_id’, ‘created_date’, ‘gt_last_updated’, ‘target_last_updated’, ‘parent_id’]
target	query	string	no	A simple equality filter for target
task_id	query	integer	no	A simple equality filter for task id
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Creates a quality report asynchronously and allows to check request status

POST /api/quality/reports

Body Parameters

{
  "task_id": 0
}

Params

Name	Location	Type	Required	Description
rq_id	query	string	no	The report creation request id. Can be specified to check the report
body	body	QualityReportCreateRequest	no	none

Description

rq_id: The report creation request id. Can be specified to check the report
creation status.

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline
202	Accepted	A quality report request has been enqueued, the request id is returned.
The request status can be checked at this endpoint by passing the rq_id
as the query parameter. If the request id is specified, this response
means the quality report request is queue	Inline
400	Bad Request	Invalid or failed request, check the response data for details	Inline

Responses Data Schema

GET Method returns details of a quality report

GET /api/quality/reports/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this quality report.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Retrieve full contents of the report in JSON format

GET /api/quality/reports/{id}/data

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this quality report.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method returns a paginated list of quality settings instances

GET /api/quality/settings

Params

Name	Location	Type	Required	Description
filter	query	string	no	A filter term. Available filter_fields: [‘id’, ‘task_id’]
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘id’]
task_id	query	integer	no	A simple equality filter for the task_id field
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method returns details of the quality settings instance

GET /api/quality/settings/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	An id of a quality settings instance

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Methods does a partial update of chosen fields in the quality settings instance

PATCH /api/quality/settings/{id}

Body Parameters

{
  "iou_threshold": 0,
  "oks_sigma": 0,
  "line_thickness": 0,
  "low_overlap_threshold": 0,
  "compare_line_orientation": true,
  "line_orientation_threshold": 0,
  "compare_groups": true,
  "group_match_threshold": 0,
  "check_covered_annotations": true,
  "object_visibility_threshold": 0,
  "panoptic_comparison": true,
  "compare_attributes": true
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	An id of a quality settings instance
body	body	PatchedQualitySettingsRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

CVAT/schema

GET /api/schema/

GET /api/schema/

OpenApi3 schema for this API. Format can be selected via content negotiation.

• YAML: application/vnd.oai.openapi
• JSON: application/vnd.oai.openapi+json

Params

Name	Location	Type	Required	Description
lang	query	string	no	none
scheme	query	string	no	none

Response Examples

200 Response

{
  "property1": "string",
  "property2": "string"
}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

HTTP Status Code 200

Name	Type	Required	Restrictions	Title	description
» additionalProperties	string	false	none		none

CVAT/server

GET Method provides basic CVAT information

GET /api/server/about

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method provides the list of supported annotations formats

GET /api/server/annotation/formats

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method provides allowed plugins

GET /api/server/plugins

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Returns all files and folders that are on the server along specified path

GET /api/server/share

Params

Name	Location	Type	Required	Description
directory	query	string	no	Directory to browse

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

CVAT/usage

GET Method returns a paginated list of usage according to query parameters

GET /api/usage

Params

Name	Location	Type	Required	Description
filter	query	string	no	A filter term. Available filter_fields: [‘user_id’, ‘user’]
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘user_id’, ‘user’]
user	query	string	no	A simple equality filter for the user field
user_id	query	integer	no	A simple equality filter for the user_id field
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

CVAT/subscriptions

GET Method provides user agreements that the user must accept to register

GET /api/user-agreements

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

CVAT/users

GET Method returns a paginated list of users

GET /api/users

Params

Name	Location	Type	Required	Description
filter	query	string	no	A filter term. Available filter_fields: [‘username’, ‘first_name’, ‘last_name’, ‘id’, ‘is_active’]
first_name	query	string	no	A simple equality filter for the first_name field
is_active	query	string	no	A simple equality filter for the is_active field
last_name	query	string	no	A simple equality filter for the last_name field
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
search	query	string	no	A search term. Available search_fields: (‘username’, ‘first_name’, ‘last_name’)
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘username’, ‘first_name’, ‘last_name’, ‘id’, ‘is_active’]
username	query	string	no	A simple equality filter for the username field
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method provides information of a specific user

GET /api/users/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this user.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Method updates chosen fields of a user

PATCH /api/users/{id}

Body Parameters

{
  "username": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "groups": [
    "string"
  ],
  "is_staff": true,
  "is_superuser": true,
  "is_active": true
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this user.
body	body	PatchedUserRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes a specific user from the server

DELETE /api/users/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this user.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The user has been deleted	Inline

Responses Data Schema

GET Method returns an instance of a user who is currently authorized

GET /api/users/self

Method returns an instance of a user who is currently authorized

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

CVAT/webhooks

GET Method returns a paginated list of webhook according to query parameters

GET /api/webhooks

Params

Name	Location	Type	Required	Description
filter	query	string	no	A filter term. Available filter_fields: [‘target_url’, ‘owner’, ‘type’, ‘description’, ‘id’, ‘project_id’, ‘updated_date’]
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
owner	query	string	no	A simple equality filter for the owner field
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.
project_id	query	integer	no	A simple equality filter for the project_id field
search	query	string	no	A search term. Available search_fields: (‘target_url’, ‘owner’, ‘type’, ‘description’)
sort	query	string	no	Which field to use when ordering the results. Available ordering_fields: [‘target_url’, ‘owner’, ‘type’, ‘description’, ‘id’, ‘project_id’, ‘updated_date’]
target_url	query	string	no	A simple equality filter for the target_url field
type	query	string	no	A simple equality filter for the type field
X-Organization	header	string	no	Organization unique slug

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method creates a webhook

POST /api/webhooks

Body Parameters

{
  "target_url": "http://example.com",
  "description": "string",
  "type": "organization",
  "content_type": "application/json",
  "secret": "string",
  "is_active": true,
  "enable_ssl": true,
  "project_id": 0,
  "events": [
    {}
  ]
}

Params

Name	Location	Type	Required	Description
org	query	string	no	Organization unique slug
org_id	query	integer	no	Organization identifier
X-Organization	header	string	no	Organization unique slug
body	body	WebhookWriteRequest	no	none

Response Examples

201 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
201	Created	成功	Inline

Responses Data Schema

GET Method returns details of a webhook

GET /api/webhooks/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this webhook.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PUT Method updates a webhook by id

PUT /api/webhooks/{id}

Body Parameters

{
  "target_url": "http://example.com",
  "description": "string",
  "type": "organization",
  "content_type": "application/json",
  "secret": "string",
  "is_active": true,
  "enable_ssl": true,
  "project_id": 0,
  "events": [
    {}
  ]
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this webhook.
body	body	WebhookWriteRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

PATCH Methods does a partial update of chosen fields in a webhook

PATCH /api/webhooks/{id}

Body Parameters

{
  "target_url": "http://example.com",
  "description": "string",
  "content_type": "application/json",
  "secret": "string",
  "is_active": true,
  "enable_ssl": true,
  "events": [
    {}
  ]
}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this webhook.
body	body	PatchedWebhookWriteRequest	no	none

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

DELETE Method deletes a webhook

DELETE /api/webhooks/{id}

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this webhook.

Response Examples

204 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
204	No Content	The webhook has been deleted	Inline

Responses Data Schema

GET Method return a list of deliveries for a specific webhook

GET /api/webhooks/{id}/deliveries

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this webhook.
page	query	integer	no	A page number within the paginated result set.
page_size	query	integer	no	Number of results to return per page.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method return a specific delivery for a specific webhook

GET /api/webhooks/{id}/deliveries/{delivery_id}

Params

Name	Location	Type	Required	Description
delivery_id	path	string	yes	none
id	path	integer	yes	A unique integer value identifying this webhook.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

POST Method redeliver a specific webhook delivery

POST /api/webhooks/{id}/deliveries/{delivery_id}/redelivery

Params

Name	Location	Type	Required	Description
delivery_id	path	string	yes	none
id	path	integer	yes	A unique integer value identifying this webhook.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	No response body	Inline

Responses Data Schema

POST Method send ping webhook

POST /api/webhooks/{id}/ping

Params

Name	Location	Type	Required	Description
id	path	integer	yes	A unique integer value identifying this webhook.

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

GET Method return a list of available webhook events

GET /api/webhooks/events

Params

Name	Location	Type	Required	Description
type	query	string	no	Type of webhook

Response Examples

200 Response

{}

Responses

HTTP Status Code	Meaning	Description	Data schema
200	OK	成功	Inline

Responses Data Schema

Data Schema

SocialLoginSerializerExRequest

{
  "access_token": "string",
  "code": "string",
  "id_token": "string",
  "auth_params": "",
  "process": "login",
  "scope": ""
}

Attribute

Name	Type	Required	Restrictions	Title	Description
access_token	string	false	none		none
code	string	false	none		none
id_token	string	false	none		none
auth_params	string	false	none		none
process	string	false	none		none
scope	string	false	none		none

PatchedQualitySettingsRequest

{
  "iou_threshold": 0,
  "oks_sigma": 0,
  "line_thickness": 0,
  "low_overlap_threshold": 0,
  "compare_line_orientation": true,
  "line_orientation_threshold": 0,
  "compare_groups": true,
  "group_match_threshold": 0,
  "check_covered_annotations": true,
  "object_visibility_threshold": 0,
  "panoptic_comparison": true,
  "compare_attributes": true
}

Attribute

Name	Type	Required	Restrictions	Title	Description
iou_threshold	number(double)	false	none		Used for distinction between matched / unmatched shapes
oks_sigma	number(double)	false	none		Like IoU threshold, but for points. The percent of the bbox area, used as the radius of the circle around the GT point, where the checked point is expected to be. Read more: https://cocodataset.org/#keypoints-eval
line_thickness	number(double)	false	none		Thickness of polylines, relatively to the (image area) ^ 0.5. The distance to the boundary around the GT line, inside of which the checked line points should be
low_overlap_threshold	number(double)	false	none		Used for distinction between strong / weak (low_overlap) matches
compare_line_orientation	boolean	false	none		Enables or disables polyline orientation comparison
line_orientation_threshold	number(double)	false	none		The minimal gain in the GT IoU between the given and reversed line directions to consider the line inverted. Only used when the ‘compare_line_orientation’ parameter is true
compare_groups	boolean	false	none		Enables or disables annotation group checks
group_match_threshold	number(double)	false	none		Minimal IoU for groups to be considered matching. Only used when the ‘compare_groups’ parameter is true
check_covered_annotations	boolean	false	none		Check for partially-covered annotations, useful in segmentation tasks
object_visibility_threshold	number(double)	false	none		Minimal visible area percent of the spatial annotations (polygons, masks) for reporting covered annotations. Only used when the ‘object_visibility_threshold’ parameter is true
panoptic_comparison	boolean	false	none		Use only the visible part of the masks and polygons in comparisons
compare_attributes	boolean	false	none		Enables or disables annotation attribute comparison

SigningRequest

{
  "url": "string"
}

Attribute

Name	Type	Required	Restrictions	Title	Description
url	string	true	none		none

RegisterSerializerWithSubscriptionsRequest

{
  "username": "string",
  "email": "user@example.com",
  "password1": "string",
  "password2": "string",
  "first_name": "string",
  "last_name": "string",
  "confirmations": [
    {
      "name": "string",
      "url_display_text": "",
      "url": "",
      "text_prefix": "",
      "required": false,
      "value": false
    }
  ]
}

Attribute

Name	Type	Required	Restrictions	Title	Description
username	string	true	none		none
email	string(email)	true	none		none
password1	string	true	write-only		none
password2	string	true	write-only		none
first_name	string	false	none		none
last_name	string	false	none		none
confirmations	[UserAgreementRequest]	false	none		none

UserAgreementRequest

{
  "name": "string",
  "url_display_text": "",
  "url": "",
  "text_prefix": "",
  "required": false,
  "value": false
}

Attribute

Name	Type	Required	Restrictions	Title	Description
name	string	true	none		none
url_display_text	string	false	none		none
url	string	false	none		none
text_prefix	string	false	none		none
required	boolean	false	none		none
value	boolean	false	none		none

PatchedWebhookWriteRequest

{
  "target_url": "http://example.com",
  "description": "string",
  "content_type": "application/json",
  "secret": "string",
  "is_active": true,
  "enable_ssl": true,
  "events": [
    {}
  ]
}

Attribute

Name	Type	Required	Restrictions	Title	Description
target_url	string(uri)	false	none		none
description	string	false	none		none
content_type	WebhookContentType	false	none		* application/json - JSON
secret	string	false	none		none
is_active	boolean	false	none		none
enable_ssl	boolean	false	none		none
events	[object]	false	write-only		none

WebhookContentType

"application/json"

• application/json - JSON

Attribute

Name	Type	Required	Restrictions	Title	Description
anonymous	string	false	none		* application/json - JSON

Enum

Name	Value
anonymous	application/json

PatchedLimitRequest

{
  "user": 0,
  "org": 0,
  "type": "default",
  "limits": {
    "tasks": 0,
    "projects": 0,
    "cloud_storages": 0,
    "tasks_per_project": 0,
    "webhooks_per_project": 0,
    "function_calls": 0,
    "automatic_annotation": true,
    "job_export_dataset": true,
    "task_export_dataset": true,
    "project_export_dataset": true,
    "webhooks_per_organization": 0,
    "memberships": 0,
    "organizations": 0
  }
}

Attribute

Name	Type	Required	Restrictions	Title	Description
user	integer¦null	false	none		none
org	integer¦null	false	none		none
type	LimitTypeEnum	false	none		* default - DEFAULT * paid - PAID * custom - CUSTOM
limits	LimitsFieldRequest	false	none		The serializer validates limits field names and their value types. Null allowed in order to indicate unlimited value.

LimitsFieldRequest

{
  "tasks": 0,
  "projects": 0,
  "cloud_storages": 0,
  "tasks_per_project": 0,
  "webhooks_per_project": 0,
  "function_calls": 0,
  "automatic_annotation": true,
  "job_export_dataset": true,
  "task_export_dataset": true,
  "project_export_dataset": true,
  "webhooks_per_organization": 0,
  "memberships": 0,
  "organizations": 0
}

The serializer validates limits field names and their value types.
Null allowed in order to indicate unlimited value.

Attribute

Name	Type	Required	Restrictions	Title	Description
tasks	integer¦null	true	none		none
projects	integer¦null	true	none		none
cloud_storages	integer¦null	true	none		none
tasks_per_project	integer¦null	true	none		none
webhooks_per_project	integer¦null	true	none		none
function_calls	integer¦null	true	none		none
automatic_annotation	boolean¦null	true	none		none
job_export_dataset	boolean¦null	true	none		none
task_export_dataset	boolean¦null	true	none		none
project_export_dataset	boolean¦null	true	none		none
webhooks_per_organization	integer¦null	false	none		none
memberships	integer¦null	false	none		none
organizations	integer¦null	false	none		none

LimitTypeEnum

"default"

• default - DEFAULT
• paid - PAID
• custom - CUSTOM

Attribute

Name	Type	Required	Restrictions	Title	Description
anonymous	string	false	none		* default - DEFAULT * paid - PAID * custom - CUSTOM

Enum

Name	Value
anonymous	default
anonymous	paid
anonymous	custom

FunctionCallRequest

{
  "function": "string",
  "task": 0,
  "job": 0,
  "quality": "original",
  "cleanup": false,
  "convMaskToPoly": false,
  "threshold": 0,
  "mapping": {
    "property1": {
      "property1": "string",
      "property2": "string"
    },
    "property2": {
      "property1": "string",
      "property2": "string"
    }
  },
  "max_distance": 0
}

Attribute

Name	Type	Required	Restrictions	Title	Description
function	string	true	none		The name of the function to execute
task	integer	true	none		The id of the task to annotate
job	integer	false	none		The id of the job to annotate
quality	QualityEnum	false	none		The quality of the images to use in the model run * compressed - compressed * original - original
cleanup	boolean	false	none		none
convMaskToPoly	boolean	false	none		none
threshold	number(double)	false	none		none
mapping	object	false	none		Label mapping from the model to the task labels
» additionalProperties	object	false	none		none
»» additionalProperties	string	false	none		none
max_distance	integer	false	none		none

QualityEnum

"compressed"

• compressed - compressed
• original - original

Attribute

Name	Type	Required	Restrictions	Title	Description
anonymous	string	false	none		* compressed - compressed * original - original

Enum

Name	Value
anonymous	compressed
anonymous	original

PatchedTaskWriteRequest

{
  "name": "string",
  "project_id": 0,
  "owner_id": 0,
  "assignee_id": 0,
  "bug_tracker": "string",
  "labels": [
    {
      "id": 0,
      "name": "string",
      "color": "string",
      "attributes": [],
      "deleted": true,
      "type": "string",
      "svg": "string",
      "sublabels": [
        {
          "id": 0,
          "name": "string",
          "color": "string",
          "attributes": [],
          "type": "string",
          "has_parent": true
        }
      ]
    }
  ],
  "subset": "string",
  "target_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  },
  "source_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  }
}

Attribute

Name	Type	Required	Restrictions	Title	Description
name	string	false	none		none
project_id	integer¦null	false	none		none
owner_id	integer¦null	false	write-only		none
assignee_id	integer¦null	false	write-only		none
bug_tracker	string	false	none		none
labels	[PatchedLabelRequest]	false	none		none
subset	string	false	none		none
target_storage	StorageRequest	false	none		none
source_storage	StorageRequest	false	none		none

StorageRequest

{
  "location": "cloud_storage",
  "cloud_storage_id": -2147483648
}

Attribute

Name	Type	Required	Restrictions	Title	Description
location	LocationEnum	false	none		* cloud_storage - CLOUD_STORAGE * local - LOCAL
cloud_storage_id	integer¦null	false	none		none

LocationEnum

"cloud_storage"

• cloud_storage - CLOUD_STORAGE
• local - LOCAL

Attribute

Name	Type	Required	Restrictions	Title	Description
anonymous	string	false	none		* cloud_storage - CLOUD_STORAGE * local - LOCAL

Enum

Name	Value
anonymous	cloud_storage
anonymous	local

PatchedLabelRequest

{
  "id": 0,
  "name": "string",
  "color": "string",
  "attributes": [],
  "deleted": true,
  "type": "string",
  "svg": "string",
  "sublabels": [
    {
      "id": 0,
      "name": "string",
      "color": "string",
      "attributes": [],
      "type": "string",
      "has_parent": true
    }
  ]
}

Attribute

Name	Type	Required	Restrictions	Title	Description
id	integer	false	none		none
name	string	false	none		none
color	string	false	none		The hex value for the RGB color. Will be generated automatically, unless specified explicitly.
attributes	[AttributeRequest]	false	none		The list of attributes. If you want to remove an attribute, you need to recreate the label and specify the remaining attributes.
deleted	boolean	false	write-only		Delete the label. Only applicable in the PATCH methods of a project or a task.
type	string	false	none		Associated annotation type for this label
svg	string	false	none		none
sublabels	[SublabelRequest]	false	none		none

SublabelRequest

{
  "id": 0,
  "name": "string",
  "color": "string",
  "attributes": [],
  "type": "string",
  "has_parent": true
}

Attribute

Name	Type	Required	Restrictions	Title	Description
id	integer	false	none		none
name	string	true	none		none
color	string	false	none		The hex value for the RGB color. Will be generated automatically, unless specified explicitly.
attributes	[AttributeRequest]	false	none		The list of attributes. If you want to remove an attribute, you need to recreate the label and specify the remaining attributes.
type	string	false	none		Associated annotation type for this label
has_parent	boolean	false	none		none

AttributeRequest

{
  "name": "string",
  "mutable": true,
  "input_type": "checkbox",
  "default_value": "string",
  "values": [
    "string"
  ]
}

Attribute

Name	Type	Required	Restrictions	Title	Description
name	string	true	none		none
mutable	boolean	true	none		none
input_type	InputTypeEnum	true	none		* checkbox - CHECKBOX * radio - RADIO * number - NUMBER * text - TEXT * select - SELECT
default_value	string	true	none		none
values	[string]	true	none		none

InputTypeEnum

"checkbox"

• checkbox - CHECKBOX
• radio - RADIO
• number - NUMBER
• text - TEXT
• select - SELECT

Attribute

Name	Type	Required	Restrictions	Title	Description
anonymous	string	false	none		* checkbox - CHECKBOX * radio - RADIO * number - NUMBER * text - TEXT * select - SELECT

Enum

Name	Value
anonymous	checkbox
anonymous	radio
anonymous	number
anonymous	text
anonymous	select

PasswordResetConfirmRequest

{
  "new_password1": "string",
  "new_password2": "string",
  "uid": "string",
  "token": "string"
}

Serializer for confirming a password reset attempt.

Attribute

Name	Type	Required	Restrictions	Title	Description
new_password1	string	true	none		none
new_password2	string	true	none		none
uid	string	true	none		none
token	string	true	none		none

PatchedProjectWriteRequest

{
  "name": "string",
  "labels": [],
  "owner_id": 0,
  "assignee_id": 0,
  "bug_tracker": "string",
  "target_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  },
  "source_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  },
  "task_subsets": [
    "string"
  ]
}

Attribute

Name	Type	Required	Restrictions	Title	Description
name	string	false	none		none
labels	[PatchedLabelRequest]	false	write-only		none
owner_id	integer¦null	false	write-only		none
assignee_id	integer¦null	false	write-only		none
bug_tracker	string	false	none		none
target_storage	StorageRequest	false	write-only		none
source_storage	StorageRequest	false	write-only		none
task_subsets	[string]	false	write-only		none

PatchedOrganizationWriteRequest

{
  "slug": "string",
  "name": "string",
  "description": "string",
  "contact": {
    "property1": "string",
    "property2": "string"
  }
}

Attribute

Name	Type	Required	Restrictions	Title	Description
slug	string	false	none		none
name	string	false	none		none
description	string	false	none		none
contact	object	false	none		none
» additionalProperties	string	false	none		none

PatchedJobWriteRequest

{
  "assignee": 0,
  "stage": "annotation",
  "state": "new"
}

Attribute

Name	Type	Required	Restrictions	Title	Description
assignee	integer¦null	false	none		none
stage	JobStage	false	none		* annotation - ANNOTATION * validation - VALIDATION * acceptance - ACCEPTANCE
state	OperationStatus	false	none		* new - NEW * in progress - IN_PROGRESS * completed - COMPLETED * rejected - REJECTED

OperationStatus

"new"

• new - NEW
• in progress - IN_PROGRESS
• completed - COMPLETED
• rejected - REJECTED

Attribute

Name	Type	Required	Restrictions	Title	Description
anonymous	string	false	none		* new - NEW * in progress - IN_PROGRESS * completed - COMPLETED * rejected - REJECTED

Enum

Name	Value
anonymous	new
anonymous	in progress
anonymous	completed
anonymous	rejected

JobStage

"annotation"

• annotation - ANNOTATION
• validation - VALIDATION
• acceptance - ACCEPTANCE

Attribute

Name	Type	Required	Restrictions	Title	Description
anonymous	string	false	none		* annotation - ANNOTATION * validation - VALIDATION * acceptance - ACCEPTANCE

Enum

Name	Value
anonymous	annotation
anonymous	validation
anonymous	acceptance

PatchedIssueWriteRequest

{
  "position": [
    0
  ],
  "assignee": 0,
  "resolved": true
}

Attribute

Name	Type	Required	Restrictions	Title	Description
position	[number]	false	none		none
assignee	integer¦null	false	none		none
resolved	boolean	false	none		none

PatchedInvitationWriteRequest

{
  "role": "worker",
  "email": "user@example.com"
}

Attribute

Name	Type	Required	Restrictions	Title	Description
role	RoleEnum	false	none		* worker - Worker * supervisor - Supervisor * maintainer - Maintainer * owner - Owner
email	string(email)	false	none		none

RoleEnum

"worker"

• worker - Worker
• supervisor - Supervisor
• maintainer - Maintainer
• owner - Owner

Attribute

Name	Type	Required	Restrictions	Title	Description
anonymous	string	false	none		* worker - Worker * supervisor - Supervisor * maintainer - Maintainer * owner - Owner

Enum

Name	Value
anonymous	worker
anonymous	supervisor
anonymous	maintainer
anonymous	owner

PatchedCommentWriteRequest

{
  "message": "string"
}

Attribute

Name	Type	Required	Restrictions	Title	Description
message	string	false	none		none

PasswordResetSerializerExRequest

{
  "email": "user@example.com"
}

Serializer for requesting a password reset e-mail.

Attribute

Name	Type	Required	Restrictions	Title	Description
email	string(email)	true	none		none

PatchedUserRequest

{
  "username": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "groups": [
    "string"
  ],
  "is_staff": true,
  "is_superuser": true,
  "is_active": true
}

Attribute

Name	Type	Required	Restrictions	Title	Description
username	string	false	none		Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
first_name	string	false	none		none
last_name	string	false	none		none
email	string(email)	false	none	Email address	none
groups	[string]	false	none		none
is_staff	boolean	false	none	Staff status	Designates whether the user can log into this admin site.
is_superuser	boolean	false	none	Superuser status	Designates that this user has all permissions without explicitly assigning them.
is_active	boolean	false	none	Active	Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

QualityReportCreateRequest

{
  "task_id": 0
}

Attribute

Name	Type	Required	Restrictions	Title	Description
task_id	integer	true	write-only		none

PatchedMembershipWriteRequest

{
  "role": "worker"
}

Attribute

Name	Type	Required	Restrictions	Title	Description
role	RoleEnum	false	none		* worker - Worker * supervisor - Supervisor * maintainer - Maintainer * owner - Owner

OnlineFunctionCallRequest

{
  "job": 0,
  "task": 0
}

Attribute

Name	Type	Required	Restrictions	Title	Description
job	integer	false	none		none
task	integer	false	none		none

TaskWriteRequest

{
  "name": "string",
  "project_id": 0,
  "owner_id": 0,
  "assignee_id": 0,
  "bug_tracker": "string",
  "overlap": 2147483647,
  "segment_size": 2147483647,
  "labels": [
    {
      "id": 0,
      "name": "string",
      "color": "string",
      "attributes": [],
      "deleted": true,
      "type": "string",
      "svg": "string",
      "sublabels": [
        {
          "id": 0,
          "name": "string",
          "color": "string",
          "attributes": [],
          "type": "string",
          "has_parent": true
        }
      ]
    }
  ],
  "subset": "string",
  "target_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  },
  "source_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  }
}

Attribute

Name	Type	Required	Restrictions	Title	Description
name	string	true	none		none
project_id	integer¦null	false	none		none
owner_id	integer¦null	false	write-only		none
assignee_id	integer¦null	false	write-only		none
bug_tracker	string	false	none		none
overlap	integer¦null	false	none		none
segment_size	integer	false	none		none
labels	[PatchedLabelRequest]	false	none		none
subset	string	false	none		none
target_storage	StorageRequest	false	none		none
source_storage	StorageRequest	false	none		none

PatchedAnnotationGuideWriteRequest

{
  "task_id": 0,
  "project_id": 0,
  "markdown": "string"
}

Attribute

Name	Type	Required	Restrictions	Title	Description
task_id	integer¦null	false	none		none
project_id	integer¦null	false	none		none
markdown	string	false	none		none

PasswordChangeRequest

{
  "old_password": "string",
  "new_password1": "string",
  "new_password2": "string"
}

Attribute

Name	Type	Required	Restrictions	Title	Description
old_password	string	true	none		none
new_password1	string	true	none		none
new_password2	string	true	none		none

WebhookWriteRequest

{
  "target_url": "http://example.com",
  "description": "string",
  "type": "organization",
  "content_type": "application/json",
  "secret": "string",
  "is_active": true,
  "enable_ssl": true,
  "project_id": 0,
  "events": [
    {}
  ]
}

Attribute

Name	Type	Required	Restrictions	Title	Description
target_url	string(uri)	true	none		none
description	string	false	none		none
type	WebhookType	true	none		* organization - ORGANIZATION * project - PROJECT
content_type	WebhookContentType	false	none		* application/json - JSON
secret	string	false	none		none
is_active	boolean	false	none		none
enable_ssl	boolean	false	none		none
project_id	integer¦null	false	write-only		none
events	[object]	true	write-only		none

WebhookType

"organization"

• organization - ORGANIZATION
• project - PROJECT

Attribute

Name	Type	Required	Restrictions	Title	Description
anonymous	string	false	none		* organization - ORGANIZATION * project - PROJECT

Enum

Name	Value
anonymous	organization
anonymous	project

ProjectWriteRequest

{
  "name": "string",
  "labels": [],
  "owner_id": 0,
  "assignee_id": 0,
  "bug_tracker": "string",
  "target_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  },
  "source_storage": {
    "location": "cloud_storage",
    "cloud_storage_id": -2147483648
  },
  "task_subsets": [
    "string"
  ]
}

Attribute

Name	Type	Required	Restrictions	Title	Description
name	string	true	none		none
labels	[PatchedLabelRequest]	false	write-only		none
owner_id	integer¦null	false	write-only		none
assignee_id	integer¦null	false	write-only		none
bug_tracker	string	false	none		none
target_storage	StorageRequest	false	write-only		none
source_storage	StorageRequest	false	write-only		none
task_subsets	[string]	false	write-only		none

OrganizationWriteRequest

{
  "slug": "string",
  "name": "string",
  "description": "string",
  "contact": {
    "property1": "string",
    "property2": "string"
  }
}

Attribute

Name	Type	Required	Restrictions	Title	Description
slug	string	true	none		none
name	string	false	none		none
description	string	false	none		none
contact	object	false	none		none
» additionalProperties	string	false	none		none

LimitRequest

{
  "user": 0,
  "org": 0,
  "type": "default",
  "limits": {
    "tasks": 0,
    "projects": 0,
    "cloud_storages": 0,
    "tasks_per_project": 0,
    "webhooks_per_project": 0,
    "function_calls": 0,
    "automatic_annotation": true,
    "job_export_dataset": true,
    "task_export_dataset": true,
    "project_export_dataset": true,
    "webhooks_per_organization": 0,
    "memberships": 0,
    "organizations": 0
  }
}

Attribute

Name	Type	Required	Restrictions	Title	Description
user	integer¦null	false	none		none
org	integer¦null	false	none		none
type	LimitTypeEnum	true	none		* default - DEFAULT * paid - PAID * custom - CUSTOM
limits	LimitsFieldRequest	true	none		The serializer validates limits field names and their value types. Null allowed in order to indicate unlimited value.

JobWriteRequest

{
  "assignee": 0,
  "stage": "annotation",
  "state": "new",
  "type": "annotation",
  "task_id": 0,
  "frame_selection_method": "random_uniform",
  "frame_count": 0,
  "seed": 0,
  "frames": [
    0
  ]
}

Attribute

Name	Type	Required	Restrictions	Title	Description
assignee	integer¦null	false	none		none
stage	JobStage	false	none		* annotation - ANNOTATION * validation - VALIDATION * acceptance - ACCEPTANCE
state	OperationStatus	false	none		* new - NEW * in progress - IN_PROGRESS * completed - COMPLETED * rejected - REJECTED
type	JobType	true	none		* annotation - ANNOTATION * ground_truth - GROUND_TRUTH
task_id	integer	true	none		none
frame_selection_method	FrameSelectionMethodEnum	false	none		* random_uniform - RANDOM_UNIFORM * manual - MANUAL
frame_count	integer	false	none		The number of frames included in the job. Applicable only to the random frame selection
seed	integer	false	none		The seed value for the random number generator. The same value will produce the same frame sets. Applicable only to the random frame selection. By default, a random value is used.
frames	[integer]	false	none		The list of frame ids. Applicable only to the manual frame selection

FrameSelectionMethodEnum

"random_uniform"

• random_uniform - RANDOM_UNIFORM
• manual - MANUAL

Attribute

Name	Type	Required	Restrictions	Title	Description
anonymous	string	false	none		* random_uniform - RANDOM_UNIFORM * manual - MANUAL

Enum

Name	Value
anonymous	random_uniform
anonymous	manual

JobType

"annotation"

• annotation - ANNOTATION
• ground_truth - GROUND_TRUTH

Attribute

Name	Type	Required	Restrictions	Title	Description
anonymous	string	false	none		* annotation - ANNOTATION * ground_truth - GROUND_TRUTH

Enum

Name	Value
anonymous	annotation
anonymous	ground_truth

IssueWriteRequest

{
  "frame": 2147483647,
  "position": [
    0
  ],
  "job": 0,
  "assignee": 0,
  "message": "string",
  "resolved": true
}

Attribute

Name	Type	Required	Restrictions	Title	Description
frame	integer	true	none		none
position	[number]	true	none		none
job	integer	true	none		none
assignee	integer¦null	false	none		none
message	string	true	none		none
resolved	boolean	false	none		none

InvitationWriteRequest

{
  "role": "worker",
  "email": "user@example.com"
}

Attribute

Name	Type	Required	Restrictions	Title	Description
role	RoleEnum	true	none		* worker - Worker * supervisor - Supervisor * maintainer - Maintainer * owner - Owner
email	string(email)	true	none		none

FunctionRequest

{
  "provider": "string",
  "url": "string",
  "api_key": "string"
}

Attribute

Name	Type	Required	Restrictions	Title	Description
provider	string	false	none		none
url	string	false	none		none
api_key	string	false	write-only		none

ClientEventsRequest

{
  "events": [],
  "timestamp": "2019-08-24T14:15:22Z"
}

Attribute

Name	Type	Required	Restrictions	Title	Description
events	[EventRequest]	false	none		none
timestamp	string(date-time)	true	none		none

EventRequest

{
  "scope": "string",
  "obj_name": "string",
  "obj_id": 0,
  "obj_val": "string",
  "source": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "count": 0,
  "duration": 0,
  "project_id": 0,
  "task_id": 0,
  "job_id": 0,
  "user_id": 0,
  "user_name": "string",
  "user_email": "string",
  "org_id": 0,
  "org_slug": "string",
  "payload": "string"
}

Attribute

Name	Type	Required	Restrictions	Title	Description
scope	string	true	none		none
obj_name	string¦null	false	none		none
obj_id	integer¦null	false	none		none
obj_val	string¦null	false	none		none
source	string¦null	false	none		none
timestamp	string(date-time)	true	none		none
count	integer¦null	false	none		none
duration	integer	false	none		none
project_id	integer¦null	false	none		none
task_id	integer¦null	false	none		none
job_id	integer¦null	false	none		none
user_id	integer¦null	false	none		none
user_name	string¦null	false	none		none
user_email	string¦null	false	none		none
org_id	integer¦null	false	none		none
org_slug	string¦null	false	none		none
payload	string¦null	false	none		none

CommentWriteRequest

{
  "issue": 0,
  "message": "string"
}

Attribute

Name	Type	Required	Restrictions	Title	Description
issue	integer	true	none		none
message	string	false	none		none

PatchedDataMetaWriteRequest

{
  "deleted_frames": [
    0
  ]
}

Attribute

Name	Type	Required	Restrictions	Title	Description
deleted_frames	[integer]	false	none		none

AnnotationGuideWriteRequest

{
  "task_id": 0,
  "project_id": 0,
  "markdown": "string"
}

Attribute

Name	Type	Required	Restrictions	Title	Description
task_id	integer¦null	false	none		none
project_id	integer¦null	false	none		none
markdown	string	false	none		none

LoginSerializerExRequest

{
  "username": "string",
  "email": "user@example.com",
  "password": "string"
}

Attribute

Name	Type	Required	Restrictions	Title	Description
username	string	false	none		none
email	string(email)	false	none		none
password	string	true	none		none