Function TasksApiFactory

Returns {
    tasksCreate(
        requestParameters: TasksApiTasksCreateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TaskRead>;
    tasksCreateAnnotations(
        requestParameters: TasksApiTasksCreateAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    tasksCreateBackup(
        requestParameters?: TasksApiTasksCreateBackupRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    tasksCreateBackupExport(
        requestParameters: TasksApiTasksCreateBackupExportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RqId>;
    tasksCreateData(
        requestParameters: TasksApiTasksCreateDataRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DataResponse>;
    tasksCreateDatasetExport(
        requestParameters: TasksApiTasksCreateDatasetExportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RqId>;
    tasksDestroy(
        requestParameters: TasksApiTasksDestroyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    tasksDestroyAnnotations(
        requestParameters: TasksApiTasksDestroyAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    tasksList(
        requestParameters?: TasksApiTasksListRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PaginatedTaskReadList>;
    tasksPartialUpdate(
        requestParameters: TasksApiTasksPartialUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TaskRead>;
    tasksPartialUpdateAnnotations(
        requestParameters: TasksApiTasksPartialUpdateAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LabeledData>;
    tasksPartialUpdateDataMeta(
        requestParameters: TasksApiTasksPartialUpdateDataMetaRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DataMetaRead>;
    tasksPartialUpdateValidationLayout(
        requestParameters: TasksApiTasksPartialUpdateValidationLayoutRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TaskValidationLayoutRead>;
    tasksRetrieve(
        requestParameters: TasksApiTasksRetrieveRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TaskRead>;
    tasksRetrieveAnnotations(
        requestParameters: TasksApiTasksRetrieveAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AnnotationsRead>;
    tasksRetrieveBackup(
        requestParameters: TasksApiTasksRetrieveBackupRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    tasksRetrieveData(
        requestParameters: TasksApiTasksRetrieveDataRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    tasksRetrieveDataMeta(
        requestParameters: TasksApiTasksRetrieveDataMetaRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DataMetaRead>;
    tasksRetrieveDataset(
        requestParameters: TasksApiTasksRetrieveDatasetRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    tasksRetrievePreview(
        requestParameters: TasksApiTasksRetrievePreviewRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    tasksRetrieveStatus(
        requestParameters: TasksApiTasksRetrieveStatusRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RqStatus>;
    tasksRetrieveValidationLayout(
        requestParameters: TasksApiTasksRetrieveValidationLayoutRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TaskValidationLayoutRead>;
    tasksUpdateAnnotations(
        requestParameters: TasksApiTasksUpdateAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
}

• tasksCreate:function

  • tasksCreate(
        requestParameters: TasksApiTasksCreateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TaskRead>

    The new task will not have any attached images or videos. To attach them, use the /api/tasks//data endpoint.

    Parameters

    • requestParameters: TasksApiTasksCreateRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<TaskRead>

    Throws

• tasksCreateAnnotations:function

  • tasksCreateAnnotations(
        requestParameters: TasksApiTasksCreateAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    The request POST /api/tasks/id/annotations initiates a background process to import annotations into a task. Please, use the GET /api/requests/<rq_id> endpoint for checking status of the process. The rq_id parameter can be found in the response on initiating request.

    Parameters

    • requestParameters: TasksApiTasksCreateAnnotationsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• tasksCreateBackup:function

  • tasksCreateBackup(
        requestParameters?: TasksApiTasksCreateBackupRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    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.

    Parameters

    • requestParameters: TasksApiTasksCreateBackupRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• tasksCreateBackupExport:function

  • tasksCreateBackupExport(
        requestParameters: TasksApiTasksCreateBackupExportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RqId>

    The request POST /api/<projects|tasks>/id/backup/export will initialize a background process to backup a resource. To check status of the process please, use GET /api/requests/<rq_id> where rq_id is request ID returned in the response for this endpoint.

    Parameters

    • requestParameters: TasksApiTasksCreateBackupExportRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RqId>

    Throws

• tasksCreateData:function

  • tasksCreateData(
        requestParameters: TasksApiTasksCreateDataRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DataResponse>

    Allows to upload data (images, video, etc.) 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://docs.cvat.ai/docs/manual/advanced/dataset_manifest/ After all data is sent, the operation status can be retrieved via the GET /api/requests/<rq_id>, where rq_id is request ID returned for this request. Once data is attached to a task, it cannot be detached or replaced.

    Parameters

    • requestParameters: TasksApiTasksCreateDataRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<DataResponse>

    Throws

• tasksCreateDatasetExport:function

  • tasksCreateDatasetExport(
        requestParameters: TasksApiTasksCreateDatasetExportRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RqId>

    The request POST /api/<projects|tasks|jobs>/id/dataset/export will initialize a background process to export a dataset. To check status of the process please, use GET /api/requests/<rq_id> where rq_id is request ID returned in the response for this endpoint.

    Parameters

    • requestParameters: TasksApiTasksCreateDatasetExportRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RqId>

    Throws

• tasksDestroy:function

  • tasksDestroy(
        requestParameters: TasksApiTasksDestroyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    All attached jobs, annotations and data will be deleted as well.

    Parameters

    • requestParameters: TasksApiTasksDestroyRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• tasksDestroyAnnotations:function

  • tasksDestroyAnnotations(
        requestParameters: TasksApiTasksDestroyAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: TasksApiTasksDestroyAnnotationsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• tasksList:function

  • tasksList(
        requestParameters?: TasksApiTasksListRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PaginatedTaskReadList>

    Parameters

    • requestParameters: TasksApiTasksListRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PaginatedTaskReadList>

    Throws

• tasksPartialUpdate:function

  • tasksPartialUpdate(
        requestParameters: TasksApiTasksPartialUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TaskRead>

    Parameters

    • requestParameters: TasksApiTasksPartialUpdateRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<TaskRead>

    Throws

• tasksPartialUpdateAnnotations:function

  • tasksPartialUpdateAnnotations(
        requestParameters: TasksApiTasksPartialUpdateAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<LabeledData>

    Parameters

    • requestParameters: TasksApiTasksPartialUpdateAnnotationsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<LabeledData>

    Throws

• tasksPartialUpdateDataMeta:function

  • tasksPartialUpdateDataMeta(
        requestParameters: TasksApiTasksPartialUpdateDataMetaRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DataMetaRead>

    Parameters

    • requestParameters: TasksApiTasksPartialUpdateDataMetaRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<DataMetaRead>

    Throws

• tasksPartialUpdateValidationLayout:function

  • tasksPartialUpdateValidationLayout(
        requestParameters: TasksApiTasksPartialUpdateValidationLayoutRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TaskValidationLayoutRead>

    WARNING: this operation is not protected from race conditions. It's up to the user to ensure no parallel calls to this operation happen. It affects image access, including exports with images, backups, chunk downloading etc.

    Parameters

    • requestParameters: TasksApiTasksPartialUpdateValidationLayoutRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<TaskValidationLayoutRead>

    Throws

• tasksRetrieve:function

  • tasksRetrieve(
        requestParameters: TasksApiTasksRetrieveRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TaskRead>

    Parameters

    • requestParameters: TasksApiTasksRetrieveRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<TaskRead>

    Throws

• tasksRetrieveAnnotations:function

  • tasksRetrieveAnnotations(
        requestParameters: TasksApiTasksRetrieveAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AnnotationsRead>

    Deprecation warning: Utilizing this endpoint ot export annotations as a dataset in a specific format will be deprecated in one of the next releases. Consider using new API: - POST /api/tasks/<task_id>/dataset/export?save_images=False to initiate export process - GET /api/requests/<rq_id> to check process status, where rq_id is request id returned on initializing request

    Parameters

    • requestParameters: TasksApiTasksRetrieveAnnotationsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<AnnotationsRead>

    Throws

• tasksRetrieveBackup:function

  • tasksRetrieveBackup(
        requestParameters: TasksApiTasksRetrieveBackupRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Deprecation warning: This endpoint will be deprecated in one of the next releases. Consider using new API: - POST /api/tasks/<task_id>/backup/export to initiate backup process - GET /api/requests/<rq_id> to check process status, where rq_id is request id returned on initializing request'

    Parameters

    • requestParameters: TasksApiTasksRetrieveBackupRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• tasksRetrieveData:function

  • tasksRetrieveData(
        requestParameters: TasksApiTasksRetrieveDataRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: TasksApiTasksRetrieveDataRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• tasksRetrieveDataMeta:function

  • tasksRetrieveDataMeta(
        requestParameters: TasksApiTasksRetrieveDataMetaRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<DataMetaRead>

    Parameters

    • requestParameters: TasksApiTasksRetrieveDataMetaRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<DataMetaRead>

    Throws

• tasksRetrieveDataset:function

  • tasksRetrieveDataset(
        requestParameters: TasksApiTasksRetrieveDatasetRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>

    Deprecation warning: Utilizing this endpoint to export task dataset in a specific format will be deprecated in one of the next releases. Consider using new API: - POST /api/tasks/<task_id>/dataset/export?save_images=True to initiate export process - GET /api/requests/<rq_id> to check process status, where rq_id is request id returned on initializing request

    Parameters

    • requestParameters: TasksApiTasksRetrieveDatasetRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<File>

    Throws

• tasksRetrievePreview:function

  • tasksRetrievePreview(
        requestParameters: TasksApiTasksRetrievePreviewRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: TasksApiTasksRetrievePreviewRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• tasksRetrieveStatus:function

  • tasksRetrieveStatus(
        requestParameters: TasksApiTasksRetrieveStatusRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RqStatus>

    This method is deprecated and will be removed in one of the next releases. To check status of task creation, use new common API for managing background operations: GET /api/requests/?action=create&task_id=<task_id>

    Parameters

    • requestParameters: TasksApiTasksRetrieveStatusRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RqStatus>

    Deprecated

    Throws

• tasksRetrieveValidationLayout:function

  • tasksRetrieveValidationLayout(
        requestParameters: TasksApiTasksRetrieveValidationLayoutRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<TaskValidationLayoutRead>

    Parameters

    • requestParameters: TasksApiTasksRetrieveValidationLayoutRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<TaskValidationLayoutRead>

    Throws

• tasksUpdateAnnotations:function

  • tasksUpdateAnnotations(
        requestParameters: TasksApiTasksUpdateAnnotationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Utilizing this endpoint to check status of the import process is deprecated in favor of the new requests API: GET /api/requests/<rq_id>, where rq_id parameter is returned in the response on initializing request.

    Parameters

    • requestParameters: TasksApiTasksUpdateAnnotationsRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws