API & SDK

• 1: Server API
• 2: CVAT Python SDK
• 2.1: SDK API Reference
• 2.1.1: APIs
• 2.1.1.1: AnalyticsApi class reference
• 2.1.1.2: AssetsApi class reference
• 2.1.1.3: AuthApi class reference
• 2.1.1.4: CloudstoragesApi class reference
• 2.1.1.5: CommentsApi class reference
• 2.1.1.6: EventsApi class reference
• 2.1.1.7: GuidesApi class reference
• 2.1.1.8: InvitationsApi class reference
• 2.1.1.9: IssuesApi class reference
• 2.1.1.10: JobsApi class reference
• 2.1.1.11: LabelsApi class reference
• 2.1.1.12: LambdaApi class reference
• 2.1.1.13: MembershipsApi class reference
• 2.1.1.14: OrganizationsApi class reference
• 2.1.1.15: ProjectsApi class reference
• 2.1.1.16: QualityApi class reference
• 2.1.1.17: RequestsApi class reference
• 2.1.1.18: SchemaApi class reference
• 2.1.1.19: ServerApi class reference
• 2.1.1.20: TasksApi class reference
• 2.1.1.21: UsersApi class reference
• 2.1.1.22: WebhooksApi class reference
• 2.1.2: Models
• 2.1.2.1: About class reference
• 2.1.2.2: AcceptInvitationRead class reference
• 2.1.2.3: AnalyticsReport class reference
• 2.1.2.4: AnalyticsReportCreateRequest class reference
• 2.1.2.5: AnalyticsReportTargetEnum class reference
• 2.1.2.6: AnnotationConflict class reference
• 2.1.2.7: AnnotationConflictTypeEnum class reference
• 2.1.2.8: AnnotationFileRequest class reference
• 2.1.2.9: AnnotationGuideRead class reference
• 2.1.2.10: AnnotationGuideWriteRequest class reference
• 2.1.2.11: AnnotationId class reference
• 2.1.2.12: AnnotationIdShapeType class reference
• 2.1.2.13: AnnotationIdTypeEnum class reference
• 2.1.2.14: AnnotationsRead class reference
• 2.1.2.15: AssetRead class reference
• 2.1.2.16: Attribute class reference
• 2.1.2.17: AttributeRequest class reference
• 2.1.2.18: AttributeVal class reference
• 2.1.2.19: AttributeValRequest class reference
• 2.1.2.20: BackupWriteRequest class reference
• 2.1.2.21: BasicOrganization class reference
• 2.1.2.22: BasicUser class reference
• 2.1.2.23: BasicUserRequest class reference
• 2.1.2.24: BinaryOperation class reference
• 2.1.2.25: ChunkType class reference
• 2.1.2.26: ClientEvents class reference
• 2.1.2.27: ClientEventsRequest class reference
• 2.1.2.28: ClientEventsRequestPreviousEvent class reference
• 2.1.2.29: CloudStorageContent class reference
• 2.1.2.30: CloudStorageRead class reference
• 2.1.2.31: CloudStorageReadOwner class reference
• 2.1.2.32: CloudStorageWriteRequest class reference
• 2.1.2.33: CommentRead class reference
• 2.1.2.34: CommentsSummary class reference
• 2.1.2.35: CommentWriteRequest class reference
• 2.1.2.36: CredentialsTypeEnum class reference
• 2.1.2.37: DataFrame class reference
• 2.1.2.38: DataMetaRead class reference
• 2.1.2.39: DataRequest class reference
• 2.1.2.40: DataRequestValidationParams class reference
• 2.1.2.41: DataResponse class reference
• 2.1.2.42: DatasetFileRequest class reference
• 2.1.2.43: DatasetFormat class reference
• 2.1.2.44: DatasetFormats class reference
• 2.1.2.45: DatasetWriteRequest class reference
• 2.1.2.46: DefaultViewEnum class reference
• 2.1.2.47: Event class reference
• 2.1.2.48: EventRequest class reference
• 2.1.2.49: Events class reference
• 2.1.2.50: EventsEnum class reference
• 2.1.2.51: FileInfo class reference
• 2.1.2.52: FileInfoTypeEnum class reference
• 2.1.2.53: FrameMeta class reference
• 2.1.2.54: FrameSelectionMethod class reference
• 2.1.2.55: FunctionCall class reference
• 2.1.2.56: FunctionCallParams class reference
• 2.1.2.57: FunctionCallRequest class reference
• 2.1.2.58: GranularityEnum class reference
• 2.1.2.59: InputTypeEnum class reference
• 2.1.2.60: InvitationRead class reference
• 2.1.2.61: InvitationWriteRequest class reference
• 2.1.2.62: IssueRead class reference
• 2.1.2.63: IssuesSummary class reference
• 2.1.2.64: IssueWriteRequest class reference
• 2.1.2.65: JobAnnotationsUpdateRequest class reference
• 2.1.2.66: JobRead class reference
• 2.1.2.67: JobReadAssignee class reference
• 2.1.2.68: JobReadTargetStorage class reference
• 2.1.2.69: JobsSummary class reference
• 2.1.2.70: JobStage class reference
• 2.1.2.71: JobStatus class reference
• 2.1.2.72: JobType class reference
• 2.1.2.73: JobValidationLayoutRead class reference
• 2.1.2.74: JobWriteRequest class reference
• 2.1.2.75: Label class reference
• 2.1.2.76: LabeledData class reference
• 2.1.2.77: LabeledDataRequest class reference
• 2.1.2.78: LabeledImage class reference
• 2.1.2.79: LabeledImageRequest class reference
• 2.1.2.80: LabeledShape class reference
• 2.1.2.81: LabeledShapeRequest class reference
• 2.1.2.82: LabeledTrack class reference
• 2.1.2.83: LabeledTrackRequest class reference
• 2.1.2.84: LabelMappingEntryRequest class reference
• 2.1.2.85: LabelsSummary class reference
• 2.1.2.86: LocationEnum class reference
• 2.1.2.87: LoginSerializerExRequest class reference
• 2.1.2.88: MembershipRead class reference
• 2.1.2.89: MetaUser class reference
• 2.1.2.90: Metric class reference
• 2.1.2.91: MetricGranularity class reference
• 2.1.2.92: NullEnum class reference
• 2.1.2.93: OnlineFunctionCallRequest class reference
• 2.1.2.94: OperationStatus class reference
• 2.1.2.95: OperatorEnum class reference
• 2.1.2.96: OrganizationRead class reference
• 2.1.2.97: OrganizationWriteRequest class reference
• 2.1.2.98: PaginatedAnnotationConflictList class reference
• 2.1.2.99: PaginatedCloudStorageReadList class reference
• 2.1.2.100: PaginatedCommentReadList class reference
• 2.1.2.101: PaginatedInvitationReadList class reference
• 2.1.2.102: PaginatedIssueReadList class reference
• 2.1.2.103: PaginatedJobReadList class reference
• 2.1.2.104: PaginatedLabelList class reference
• 2.1.2.105: PaginatedMembershipReadList class reference
• 2.1.2.106: PaginatedMetaUserList class reference
• 2.1.2.107: PaginatedOrganizationReadList class reference
• 2.1.2.108: PaginatedProjectReadList class reference
• 2.1.2.109: PaginatedQualityReportList class reference
• 2.1.2.110: PaginatedQualitySettingsList class reference
• 2.1.2.111: PaginatedRequestList class reference
• 2.1.2.112: PaginatedTaskReadList class reference
• 2.1.2.113: PaginatedWebhookDeliveryReadList class reference
• 2.1.2.114: PaginatedWebhookReadList class reference
• 2.1.2.115: PasswordChangeRequest class reference
• 2.1.2.116: PasswordResetConfirmRequest class reference
• 2.1.2.117: PasswordResetSerializerExRequest class reference
• 2.1.2.118: PatchedAnnotationGuideWriteRequest class reference
• 2.1.2.119: PatchedCloudStorageWriteRequest class reference
• 2.1.2.120: PatchedCommentWriteRequest class reference
• 2.1.2.121: PatchedDataMetaWriteRequest class reference
• 2.1.2.122: PatchedInvitationWriteRequest class reference
• 2.1.2.123: PatchedIssueWriteRequest class reference
• 2.1.2.124: PatchedJobDataMetaWriteRequest class reference
• 2.1.2.125: PatchedJobValidationLayoutWriteRequest class reference
• 2.1.2.126: PatchedJobWriteRequest class reference
• 2.1.2.127: PatchedLabeledDataRequest class reference
• 2.1.2.128: PatchedLabelRequest class reference
• 2.1.2.129: PatchedMembershipWriteRequest class reference
• 2.1.2.130: PatchedOrganizationWriteRequest class reference
• 2.1.2.131: PatchedProjectWriteRequest class reference
• 2.1.2.132: PatchedProjectWriteRequestTargetStorage class reference
• 2.1.2.133: PatchedQualitySettingsRequest class reference
• 2.1.2.134: PatchedTaskValidationLayoutWriteRequest class reference
• 2.1.2.135: PatchedTaskWriteRequest class reference
• 2.1.2.136: PatchedTaskWriteRequestTargetStorage class reference
• 2.1.2.137: PatchedUserRequest class reference
• 2.1.2.138: PatchedWebhookWriteRequest class reference
• 2.1.2.139: Plugins class reference
• 2.1.2.140: PointSizeBaseEnum class reference
• 2.1.2.141: ProjectFileRequest class reference
• 2.1.2.142: ProjectRead class reference
• 2.1.2.143: ProjectReadTargetStorage class reference
• 2.1.2.144: ProjectWriteRequest class reference
• 2.1.2.145: ProviderTypeEnum class reference
• 2.1.2.146: QualityReport class reference
• 2.1.2.147: QualityReportCreateRequest class reference
• 2.1.2.148: QualityReportSummary class reference
• 2.1.2.149: QualityReportTarget class reference
• 2.1.2.150: QualitySettings class reference
• 2.1.2.151: RegisterSerializerEx class reference
• 2.1.2.152: RegisterSerializerExRequest class reference
• 2.1.2.153: Request class reference
• 2.1.2.154: RequestDataOperation class reference
• 2.1.2.155: RequestDataOperationTargetEnum class reference
• 2.1.2.156: RequestOwner class reference
• 2.1.2.157: RequestStatus class reference
• 2.1.2.158: RestAuthDetail class reference
• 2.1.2.159: RoleEnum class reference
• 2.1.2.160: RqId class reference
• 2.1.2.161: RqStatus class reference
• 2.1.2.162: RqStatusStateEnum class reference
• 2.1.2.163: SeverityEnum class reference
• 2.1.2.164: ShapeType class reference
• 2.1.2.165: SigningRequest class reference
• 2.1.2.166: SortingMethod class reference
• 2.1.2.167: Storage class reference
• 2.1.2.168: StorageMethod class reference
• 2.1.2.169: StorageRequest class reference
• 2.1.2.170: StorageType class reference
• 2.1.2.171: Sublabel class reference
• 2.1.2.172: SubLabeledShape class reference
• 2.1.2.173: SubLabeledShapeRequest class reference
• 2.1.2.174: SubLabeledTrack class reference
• 2.1.2.175: SubLabeledTrackRequest class reference
• 2.1.2.176: SublabelMappingEntryRequest class reference
• 2.1.2.177: SublabelRequest class reference
• 2.1.2.178: TargetMetricEnum class reference
• 2.1.2.179: TaskAnnotationsUpdateRequest class reference
• 2.1.2.180: TaskAnnotationsWriteRequest class reference
• 2.1.2.181: TaskFileRequest class reference
• 2.1.2.182: TaskRead class reference
• 2.1.2.183: TasksSummary class reference
• 2.1.2.184: TaskValidationLayoutRead class reference
• 2.1.2.185: TaskValidationLayoutReadMode class reference
• 2.1.2.186: TaskWriteRequest class reference
• 2.1.2.187: Token class reference
• 2.1.2.188: TrackedShape class reference
• 2.1.2.189: TrackedShapeRequest class reference
• 2.1.2.190: Transformation class reference
• 2.1.2.191: TransformationBinary class reference
• 2.1.2.192: User class reference
• 2.1.2.193: UserIdentifiers class reference
• 2.1.2.194: ValidationMode class reference
• 2.1.2.195: ValidationParamsRequest class reference
• 2.1.2.196: WebhookContentType class reference
• 2.1.2.197: WebhookDeliveryRead class reference
• 2.1.2.198: WebhookRead class reference
• 2.1.2.199: WebhookType class reference
• 2.1.2.200: WebhookWriteRequest class reference
• 2.2: Low-level API
• 2.3: High-level API
• 2.4: PyTorch adapter
• 2.5: Auto-annotation API
• 2.6: Developer guide
• 3: Command line interface (CLI)

1 - Server API

Overview

CVAT server provides HTTP REST API for interaction. Each client application - be it a command line tool, browser or a script - all interact with CVAT via HTTP requests and responses:

API schema

You can obtain schema for your server at <yourserver>/api/docs. For example, the official CVAT.ai application has API documentation here.

Examples

Here you can see how a task is created in CVAT:

1. At first, we have to login
2. Then we create a task from its configuration
3. Then we send task data (images, videos etc.)
4. We wait for data processing and finish

Design principles

Common pattern for our REST API is <VERB> [namespace] <objects> <id> <action>.

• VERB can be POST, GET, PATCH, PUT, DELETE.
• namespace should scope some specific functionality like auth, lambda. It is optional in the scheme.
• Typical objects are tasks, projects, jobs.
• When you want to extract a specific object from a collection, just specify its id.
• An action can be used to simplify REST API or provide an endpoint for entities without objects endpoint like annotations, data, data/meta. Note: action should not duplicate other endpoints without a reason.

When you’re developing new endpoints, follow these guidelines:

• Use nouns instead of verbs in endpoint paths. For example, POST /api/tasks instead of POST /api/tasks/create.
• Accept and respond with JSON whenever it is possible
• Name collections with plural nouns (e.g. /tasks, /projects)
• Try to keep the API structure flat. Prefer two separate endpoints for /projects and /tasks instead of /projects/:id1/tasks/:id2. Use filters to extract necessary information like /tasks/:id2?project=:id1. In some cases it is useful to get all tasks. If the structure is hierarchical, it cannot be done easily. Also you have to know both :id1 and :id2 to get information about the task. Note: for now we accept GET /tasks/:id2/jobs but it should be replaced by /jobs?task=:id2 in the future.
• Handle errors gracefully and return standard error codes (e.g. 201, 400)
• Allow filtering, sorting, and pagination
• Maintain good security practices
• Cache data to improve performance
• Versioning our APIs. It should be done when you delete an endpoint or modify its behaviors. Versioning uses a schema with Accept header with vendor media type.

Links

• Best practices for REST API design
• Flat vs. nested resources
• REST API Design Best Practices for Sub and Nested Resources
• A specification for building APIs in JSON

2 - CVAT Python SDK

Overview

CVAT SDK is a Python library. It provides you access to Python functions and objects that simplify server interaction and provide additional functionality like data validation and serialization.

SDK API includes several layers:

• Low-level API with REST API wrappers. Located at cvat_sdk.api_client. Read more
• High-level API. Located at cvat_sdk.core. Read more
• PyTorch adapter. Located at cvat_sdk.pytorch. Read more
• Auto-annotation API. Located at cvat_sdk.auto_annotation. Read more

In general, the low-level API provides single-request operations, while the high-level one implements composite, multi-request operations, and provides local proxies for server objects. For most uses, the high-level API should be good enough, and it should be the right point to start your integration with CVAT.

The PyTorch adapter is a specialized layer that represents datasets stored in CVAT as PyTorch Dataset objects. This enables direct use of such datasets in PyTorch-based machine learning pipelines.

The auto-annotation API is a specialized layer that lets you automatically annotate CVAT datasets by running a custom function on the local machine. See also the auto-annotate command in the CLI.

Installation

To install an official release of CVAT SDK use this command:

pip install cvat-sdk

To use the cvat_sdk.masks module, request the masks extra:

pip install "cvat-sdk[masks]"

To use the PyTorch adapter or the built-in PyTorch-based auto-annotation functions, request the pytorch extra:

pip install "cvat-sdk[pytorch]"

We support Python versions 3.9 and higher.

Usage

To import package components, use the following code:

For the high-level API:

import cvat_sdk
# or
import cvat_sdk.core

For the low-level API:

import cvat_sdk.api_client

For the PyTorch adapter:

import cvat_sdk.pytorch

2.1 - SDK API Reference

2.1.1 - APIs

All URIs are relative to http://localhost

2.1.1.1 - AnalyticsApi class reference

All URIs are relative to http://localhost

create_report

create_report( rq_id=None, analytics_report_create_request=None, **kwargs )

Create an analytics report

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    rq_id = "rq_id_example" # str | The report creation request id. Can be specified to check the report creation status.  (optional)
    analytics_report_create_request = AnalyticsReportCreateRequest(
        job_id=1,
        task_id=1,
        project_id=1,
    ) # AnalyticsReportCreateRequest |  (optional)

    try:
        api_client.analytics_api.create_report(
            rq_id=rq_id,
            analytics_report_create_request=analytics_report_create_request,
        )
    except exceptions.ApiException as e:
        print("Exception when calling AnalyticsApi.create_report(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[None, urllib3.HTTPResponse].

Returns a tuple with 2 values: (None, raw_response).

This endpoint does not have any return value, so None is always returned as the first value. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/vnd.cvat+json

HTTP response details

get_reports

get_reports( end_date=None, job_id=None, project_id=None, start_date=None, task_id=None, **kwargs )

Get an analytics report

Receive analytics report

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    end_date = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Specify the end date for filtering report data. (optional)
    job_id = 1 # int | Specify job ID (optional)
    project_id = 1 # int | Specify project ID (optional)
    start_date = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Specify a start date for filtering report data. (optional)
    task_id = 1 # int | Specify task ID (optional)

    try:
        (data, response) = api_client.analytics_api.get_reports(
            end_date=end_date,
            job_id=job_id,
            project_id=project_id,
            start_date=start_date,
            task_id=task_id,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling AnalyticsApi.get_reports(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[AnalyticsReport, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.cvat+json

HTTP response details

2.1.1.2 - AssetsApi class reference

All URIs are relative to http://localhost

create

create( file=None, **kwargs )

Create an asset

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    file = open('/path/to/file', 'rb') # file_type |  (optional)

    try:
        (data, response) = api_client.assets_api.create(
            file=file,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling AssetsApi.create(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[AssetRead, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/vnd.cvat+json

HTTP response details

destroy

destroy( uuid, **kwargs )

Delete an asset

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    uuid = "uuid_example" # str | A UUID string identifying this asset.

    try:
        api_client.assets_api.destroy(
            uuid,)
    except exceptions.ApiException as e:
        print("Exception when calling AssetsApi.destroy(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[None, urllib3.HTTPResponse].

Returns a tuple with 2 values: (None, raw_response).

This endpoint does not have any return value, so None is always returned as the first value. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

retrieve

retrieve( uuid, **kwargs )

Get an asset

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    uuid = "uuid_example" # str | A UUID string identifying this asset.

    try:
        api_client.assets_api.retrieve(
            uuid,)
    except exceptions.ApiException as e:
        print("Exception when calling AssetsApi.retrieve(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[None, urllib3.HTTPResponse].

Returns a tuple with 2 values: (None, raw_response).

This endpoint does not have any return value, so None is always returned as the first value. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

2.1.1.3 - AuthApi class reference

All URIs are relative to http://localhost

create_login

create_login( login_serializer_ex_request, **kwargs )

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.

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    login_serializer_ex_request = LoginSerializerExRequest(
        username="username_example",
        email="email_example",
        password="password_example",
    ) # LoginSerializerExRequest | 

    try:
        (data, response) = api_client.auth_api.create_login(
            login_serializer_ex_request,)
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling AuthApi.create_login(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[Token, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/vnd.cvat+json

HTTP response details

create_logout

create_logout( **kwargs )

Calls Django logout method and delete the Token object assigned to the current User object. Accepts/Returns nothing.

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:

    try:
        (data, response) = api_client.auth_api.create_logout()
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling AuthApi.create_logout(): %s\n" % e)

Parameters

This endpoint does not need any parameter.

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[RestAuthDetail, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.cvat+json

HTTP response details

create_password_change

create_password_change( password_change_request, **kwargs )

Calls Django Auth SetPasswordForm save method. Accepts the following POST parameters: new_password1, new_password2 Returns the success/fail message.

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    password_change_request = PasswordChangeRequest(
        old_password="old_password_example",
        new_password1="new_password1_example",
        new_password2="new_password2_example",
    ) # PasswordChangeRequest | 

    try:
        (data, response) = api_client.auth_api.create_password_change(
            password_change_request,)
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling AuthApi.create_password_change(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[RestAuthDetail, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/vnd.cvat+json

HTTP response details

create_password_reset

create_password_reset( password_reset_serializer_ex_request, **kwargs )

Calls Django Auth PasswordResetForm save method. Accepts the following POST parameters: email Returns the success/fail message.

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    password_reset_serializer_ex_request = PasswordResetSerializerExRequest(
        email="email_example",
    ) # PasswordResetSerializerExRequest | 

    try:
        (data, response) = api_client.auth_api.create_password_reset(
            password_reset_serializer_ex_request,)
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling AuthApi.create_password_reset(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[RestAuthDetail, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/vnd.cvat+json

HTTP response details

create_password_reset_confirm

create_password_reset_confirm( password_reset_confirm_request, **kwargs )

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.

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    password_reset_confirm_request = PasswordResetConfirmRequest(
        new_password1="new_password1_example",
        new_password2="new_password2_example",
        uid="uid_example",
        token="token_example",
    ) # PasswordResetConfirmRequest | 

    try:
        (data, response) = api_client.auth_api.create_password_reset_confirm(
            password_reset_confirm_request,)
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling AuthApi.create_password_reset_confirm(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[RestAuthDetail, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/vnd.cvat+json

HTTP response details

create_register

create_register( register_serializer_ex_request, **kwargs )

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    register_serializer_ex_request = RegisterSerializerExRequest(
        username="username_example",
        email="email_example",
        password1="password1_example",
        password2="password2_example",
        first_name="first_name_example",
        last_name="last_name_example",
    ) # RegisterSerializerExRequest | 

    try:
        (data, response) = api_client.auth_api.create_register(
            register_serializer_ex_request,)
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling AuthApi.create_register(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[RegisterSerializerEx, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/vnd.cvat+json

HTTP response details

create_signing

create_signing( signing_request, **kwargs )

This method signs URL for access to the server

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

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    signing_request = SigningRequest(
        url="url_example",
    ) # SigningRequest | 

    try:
        (data, response) = api_client.auth_api.create_signing(
            signing_request,)
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling AuthApi.create_signing(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[str, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/vnd.cvat+json

HTTP response details

retrieve_rules

retrieve_rules( **kwargs )

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",)

with ApiClient(configuration) as api_client:

    try:
        api_client.auth_api.retrieve_rules()
    except exceptions.ApiException as e:
        print("Exception when calling AuthApi.retrieve_rules(): %s\n" % e)

Parameters

This endpoint does not need any parameter.

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[None, urllib3.HTTPResponse].

Returns a tuple with 2 values: (None, raw_response).

This endpoint does not have any return value, so None is always returned as the first value. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

No authentication required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

2.1.1.4 - CloudstoragesApi class reference

All URIs are relative to http://localhost

create

create( cloud_storage_write_request, x_organization=None, org=None, org_id=None, **kwargs )

Create a cloud storage

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    cloud_storage_write_request = CloudStorageWriteRequest(
        provider_type=ProviderTypeEnum("AWS_S3_BUCKET"),
        resource="resource_example",
        display_name="display_name_example",
        owner=BasicUserRequest(
            username="A",
            first_name="first_name_example",
            last_name="last_name_example",
        ),
        credentials_type=CredentialsTypeEnum("KEY_SECRET_KEY_PAIR"),
        session_token="session_token_example",
        account_name="account_name_example",
        key="key_example",
        secret_key="secret_key_example",
        connection_string="connection_string_example",
        key_file=open('/path/to/file', 'rb'),
        specific_attributes="specific_attributes_example",
        description="description_example",
        manifests=[],
    ) # CloudStorageWriteRequest | 
    x_organization = "X-Organization_example" # str | Organization unique slug (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)

    try:
        (data, response) = api_client.cloudstorages_api.create(
            cloud_storage_write_request,
            x_organization=x_organization,
            org=org,
            org_id=org_id,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling CloudstoragesApi.create(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[CloudStorageRead, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: application/json, multipart/form-data
• Accept: application/vnd.cvat+json

HTTP response details

destroy

destroy( id, **kwargs )

Delete a cloud storage

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this cloud storage.

    try:
        api_client.cloudstorages_api.destroy(
            id,)
    except exceptions.ApiException as e:
        print("Exception when calling CloudstoragesApi.destroy(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[None, urllib3.HTTPResponse].

Returns a tuple with 2 values: (None, raw_response).

This endpoint does not have any return value, so None is always returned as the first value. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

list

list( x_organization=None, credentials_type=None, filter=None, name=None, org=None, org_id=None, owner=None, page=None, page_size=None, provider_type=None, resource=None, search=None, sort=None, **kwargs )

List cloud storages

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    x_organization = "X-Organization_example" # str | Organization unique slug (optional)
    credentials_type = "KEY_SECRET_KEY_PAIR" # str | A simple equality filter for the credentials_type field (optional)
    filter = "filter_example" # str |  JSON Logic filter. This filter can be used to perform complex filtering by grouping rules.  For example, using such a filter you can get all resources created by you:      - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]}  Details about the syntax used can be found at the link: https://jsonlogic.com/   Available filter_fields: ['provider_type', 'name', 'resource', 'credentials_type', 'owner', 'description', 'id']. (optional)
    name = "name_example" # str | A simple equality filter for the name field (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    owner = "owner_example" # str | A simple equality filter for the owner field (optional)
    page = 1 # int | A page number within the paginated result set. (optional)
    page_size = 1 # int | Number of results to return per page. (optional)
    provider_type = "AWS_S3_BUCKET" # str | A simple equality filter for the provider_type field (optional)
    resource = "resource_example" # str | A simple equality filter for the resource field (optional)
    search = "search_example" # str | A search term. Available search_fields: ('provider_type', 'name', 'resource', 'credentials_type', 'owner', 'description') (optional)
    sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['provider_type', 'name', 'resource', 'credentials_type', 'owner', 'description', 'id'] (optional)

    try:
        (data, response) = api_client.cloudstorages_api.list(
            x_organization=x_organization,
            credentials_type=credentials_type,
            filter=filter,
            name=name,
            org=org,
            org_id=org_id,
            owner=owner,
            page=page,
            page_size=page_size,
            provider_type=provider_type,
            resource=resource,
            search=search,
            sort=sort,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling CloudstoragesApi.list(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[PaginatedCloudStorageReadList, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.cvat+json

HTTP response details

partial_update

partial_update( id, patched_cloud_storage_write_request=None, **kwargs )

Update a cloud storage

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this cloud storage.
    patched_cloud_storage_write_request = PatchedCloudStorageWriteRequest(
        provider_type=ProviderTypeEnum("AWS_S3_BUCKET"),
        resource="resource_example",
        display_name="display_name_example",
        owner=BasicUserRequest(
            username="A",
            first_name="first_name_example",
            last_name="last_name_example",
        ),
        credentials_type=CredentialsTypeEnum("KEY_SECRET_KEY_PAIR"),
        session_token="session_token_example",
        account_name="account_name_example",
        key="key_example",
        secret_key="secret_key_example",
        connection_string="connection_string_example",
        key_file=open('/path/to/file', 'rb'),
        specific_attributes="specific_attributes_example",
        description="description_example",
        manifests=[],
    ) # PatchedCloudStorageWriteRequest |  (optional)

    try:
        (data, response) = api_client.cloudstorages_api.partial_update(
            id,
            patched_cloud_storage_write_request=patched_cloud_storage_write_request,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling CloudstoragesApi.partial_update(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[CloudStorageRead, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: application/json, multipart/form-data
• Accept: application/vnd.cvat+json

HTTP response details

retrieve

retrieve( id, **kwargs )

Get cloud storage details

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this cloud storage.

    try:
        (data, response) = api_client.cloudstorages_api.retrieve(
            id,)
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling CloudstoragesApi.retrieve(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[CloudStorageRead, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.cvat+json

HTTP response details

retrieve_actions

retrieve_actions( id, **kwargs )

Get allowed actions for a cloud storage

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

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this cloud storage.

    try:
        (data, response) = api_client.cloudstorages_api.retrieve_actions(
            id,)
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling CloudstoragesApi.retrieve_actions(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[str, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.cvat+json

HTTP response details

retrieve_content_v2

retrieve_content_v2( id, manifest_path=None, next_token=None, page_size=None, prefix=None, **kwargs )

Get cloud storage content

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this cloud storage.
    manifest_path = "manifest_path_example" # str | Path to the manifest file in a cloud storage (optional)
    next_token = "next_token_example" # str | Used to continue listing files in the bucket (optional)
    page_size = 1 # int |  (optional)
    prefix = "prefix_example" # str | Prefix to filter data (optional)

    try:
        (data, response) = api_client.cloudstorages_api.retrieve_content_v2(
            id,
            manifest_path=manifest_path,
            next_token=next_token,
            page_size=page_size,
            prefix=prefix,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling CloudstoragesApi.retrieve_content_v2(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[CloudStorageContent, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.cvat+json

HTTP response details

retrieve_preview

retrieve_preview( id, **kwargs )

Get a preview image for a cloud storage

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this cloud storage.

    try:
        api_client.cloudstorages_api.retrieve_preview(
            id,)
    except exceptions.ApiException as e:
        print("Exception when calling CloudstoragesApi.retrieve_preview(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[None, urllib3.HTTPResponse].

Returns a tuple with 2 values: (None, raw_response).

This endpoint does not have any return value, so None is always returned as the first value. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

retrieve_status

retrieve_status( id, **kwargs )

Get the status of a cloud storage

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this cloud storage.

    try:
        (data, response) = api_client.cloudstorages_api.retrieve_status(
            id,)
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling CloudstoragesApi.retrieve_status(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[str, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.cvat+json

HTTP response details

2.1.1.5 - CommentsApi class reference

All URIs are relative to http://localhost

create

create( comment_write_request, x_organization=None, org=None, org_id=None, **kwargs )

Create a comment

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    comment_write_request = CommentWriteRequest(
        issue=1,
        message="message_example",
    ) # CommentWriteRequest | 
    x_organization = "X-Organization_example" # str | Organization unique slug (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)

    try:
        (data, response) = api_client.comments_api.create(
            comment_write_request,
            x_organization=x_organization,
            org=org,
            org_id=org_id,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling CommentsApi.create(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[CommentRead, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/vnd.cvat+json

HTTP response details

destroy

destroy( id, **kwargs )

Delete a comment

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this comment.

    try:
        api_client.comments_api.destroy(
            id,)
    except exceptions.ApiException as e:
        print("Exception when calling CommentsApi.destroy(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[None, urllib3.HTTPResponse].

Returns a tuple with 2 values: (None, raw_response).

This endpoint does not have any return value, so None is always returned as the first value. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

list

list( x_organization=None, filter=None, frame_id=None, issue_id=None, job_id=None, org=None, org_id=None, owner=None, page=None, page_size=None, search=None, sort=None, **kwargs )

List comments

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    x_organization = "X-Organization_example" # str | Organization unique slug (optional)
    filter = "filter_example" # str |  JSON Logic filter. This filter can be used to perform complex filtering by grouping rules.  For example, using such a filter you can get all resources created by you:      - {\"and\":[{\"==\":[{\"var\":\"owner\"},\"<user>\"]}]}  Details about the syntax used can be found at the link: https://jsonlogic.com/   Available filter_fields: ['owner', 'id', 'issue_id', 'frame_id', 'job_id']. (optional)
    frame_id = 1 # int | A simple equality filter for the frame_id field (optional)
    issue_id = 1 # int | A simple equality filter for the issue_id field (optional)
    job_id = 1 # int | A simple equality filter for the job_id field (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    owner = "owner_example" # str | A simple equality filter for the owner field (optional)
    page = 1 # int | A page number within the paginated result set. (optional)
    page_size = 1 # int | Number of results to return per page. (optional)
    search = "search_example" # str | A search term. Available search_fields: ('owner',) (optional)
    sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['owner', 'id', 'issue_id', 'frame_id', 'job_id'] (optional)

    try:
        (data, response) = api_client.comments_api.list(
            x_organization=x_organization,
            filter=filter,
            frame_id=frame_id,
            issue_id=issue_id,
            job_id=job_id,
            org=org,
            org_id=org_id,
            owner=owner,
            page=page,
            page_size=page_size,
            search=search,
            sort=sort,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling CommentsApi.list(): %s\n" % e)

Parameters

There are also optional kwargs that control the function invocation behavior. Read more here.

Returned values

Returned type: Tuple[PaginatedCommentReadList, urllib3.HTTPResponse].

Returns a tuple with 2 values: (parsed_response, raw_response).

The first value is a model parsed from the response data. The second value is the raw response, which can be useful to get response parameters, such as status code, headers, or raw response data. Read more about invocation parameters and returned values here.

Authentication

basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/vnd.cvat+json

HTTP response details

partial_update

partial_update( id, patched_comment_write_request=None, **kwargs )

Update a comment

Example

from pprint import pprint

from cvat_sdk.api_client import Configuration, ApiClient, exceptions
from cvat_sdk.api_client.models import *

# Set up an API client
# Read Configuration class docs for more info about parameters and authentication methods
configuration = Configuration(
    host = "http://localhost",
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD',
)

with ApiClient(configuration) as api_client:
    id = 1 # int | A unique integer value identifying this comment.
    patched_comment_write_request = PatchedCommentWriteRequest(
        message="message_example",
    ) # PatchedCommentWriteRequest |  (optional)

    try:
        (data, response) = api_client.comments_api.partial_update(
            id,
            patched_comment_write_request=patched_comment_write_request,
        )
        pprint(data)
    except exceptions.ApiException as e:
        print("Exception when calling CommentsApi.partial_update(): %s\n" % e)