You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

73 KiB

Raw Blame History

cvat_sdk.JobsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
jobs_create_annotations	POST /api/jobs/{id}/annotations/	Method allows to upload job annotations
jobs_destroy_annotations	DELETE /api/jobs/{id}/annotations/	Method deletes all annotations for a specific job
jobs_list	GET /api/jobs	Method returns a paginated list of jobs according to query parameters
jobs_list_commits	GET /api/jobs/{id}/commits	The action returns the list of tracked changes for the job
jobs_list_issues	GET /api/jobs/{id}/issues	Method returns list of issues for the job
jobs_partial_update	PATCH /api/jobs/{id}	Methods does a partial update of chosen fields in a job
jobs_partial_update_annotations	PATCH /api/jobs/{id}/annotations/	Method performs a partial update of annotations in a specific job
jobs_partial_update_annotations_file	PATCH /api/jobs/{id}/annotations/{file_id}	Allows to upload an annotation file chunk. Implements TUS file uploading protocol.
jobs_retrieve	GET /api/jobs/{id}	Method returns details of a job
jobs_retrieve_annotations	GET /api/jobs/{id}/annotations/	Method returns annotations for a specific job
jobs_retrieve_data	GET /api/jobs/{id}/data	Method returns data for a specific job
jobs_retrieve_data_meta	GET /api/jobs/{id}/data/meta	Method provides a meta information about media files which are related with the job
jobs_retrieve_dataset	GET /api/jobs/{id}/dataset	Export job as a dataset in a specific format
jobs_update	PUT /api/jobs/{id}	Method updates a job by id
jobs_update_annotations	PUT /api/jobs/{id}/annotations/	Method performs an update of all annotations in a specific job

jobs_create_annotations

jobs_create_annotations(id)

Method allows to upload job annotations

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from cvat_sdk.model.job_write_request import JobWriteRequest
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    id = 1 # int | A unique integer value identifying this job.
    x_organization = "X-Organization_example" # str |  (optional)
    cloud_storage_id = 3.14 # float | Storage id (optional)
    filename = "filename_example" # str | Annotation file name (optional)
    format = "format_example" # str | Input format name You can get the list of supported formats at: /server/annotation/formats (optional)
    location = "cloud_storage" # str | where to import the annotation from (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    use_default_location = True # bool | Use the location that was configured in the task to import annotation (optional) if omitted the server will use the default value of True
    job_write_request = JobWriteRequest(
        assignee=1,
        stage=JobStage("annotation"),
        state=OperationStatus("new"),
    ) # JobWriteRequest |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Method allows to upload job annotations
        api_instance.jobs_create_annotations(id)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_create_annotations: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Method allows to upload job annotations
        api_instance.jobs_create_annotations(id, x_organization=x_organization, cloud_storage_id=cloud_storage_id, filename=filename, format=format, location=location, org=org, org_id=org_id, use_default_location=use_default_location, job_write_request=job_write_request)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_create_annotations: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.
x_organization	str		[optional]
cloud_storage_id	float	Storage id	[optional]
filename	str	Annotation file name	[optional]
format	str	Input format name You can get the list of supported formats at: /server/annotation/formats	[optional]
location	str	where to import the annotation from	[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]
use_default_location	bool	Use the location that was configured in the task to import annotation	[optional] if omitted the server will use the default value of True
job_write_request	JobWriteRequest		[optional]

Return type

void (empty response body)

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data, application/offset+octet-stream
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201	Uploading has finished	-
202	Uploading has been started	-
405	Format is not available	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobs_destroy_annotations

jobs_destroy_annotations(id)

Method deletes all annotations for a specific job

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    id = 1 # int | A unique integer value identifying this job.
    x_organization = "X-Organization_example" # str |  (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)

    # example passing only required values which don't have defaults set
    try:
        # Method deletes all annotations for a specific job
        api_instance.jobs_destroy_annotations(id)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_destroy_annotations: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Method deletes all annotations for a specific job
        api_instance.jobs_destroy_annotations(id, x_organization=x_organization, org=org, org_id=org_id)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_destroy_annotations: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.
x_organization	str		[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]

Return type

void (empty response body)

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	The annotation has been deleted	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobs_list

PaginatedJobReadList jobs_list()

Method returns a paginated list of jobs according to query parameters

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from cvat_sdk.model.paginated_job_read_list import PaginatedJobReadList
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    x_organization = "X-Organization_example" # str |  (optional)
    filter = "filter_example" # str | A filter term. Avaliable filter_fields: ['task_name', 'project_name', 'assignee', 'state', 'stage', 'id', 'task_id', 'project_id', 'updated_date'] (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (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. Avaliable search_fields: ('task_name', 'project_name', 'assignee', 'state', 'stage') (optional)
    sort = "sort_example" # str | Which field to use when ordering the results. Avaliable ordering_fields: ['task_name', 'project_name', 'assignee', 'state', 'stage', 'id', 'task_id', 'project_id', 'updated_date'] (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Method returns a paginated list of jobs according to query parameters
        api_response = api_instance.jobs_list(x_organization=x_organization, filter=filter, org=org, org_id=org_id, page=page, page_size=page_size, search=search, sort=sort)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
x_organization	str		[optional]
filter	str	A filter term. Avaliable filter_fields: ['task_name', 'project_name', 'assignee', 'state', 'stage', 'id', 'task_id', 'project_id', 'updated_date']	[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]
page	int	A page number within the paginated result set.	[optional]
page_size	int	Number of results to return per page.	[optional]
search	str	A search term. Avaliable search_fields: ('task_name', 'project_name', 'assignee', 'state', 'stage')	[optional]
sort	str	Which field to use when ordering the results. Avaliable ordering_fields: ['task_name', 'project_name', 'assignee', 'state', 'stage', 'id', 'task_id', 'project_id', 'updated_date']	[optional]

Return type

PaginatedJobReadList

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobs_list_commits

PaginatedJobCommitList jobs_list_commits(id)

The action returns the list of tracked changes for the job

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from cvat_sdk.model.paginated_job_commit_list import PaginatedJobCommitList
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    id = 1 # int | A unique integer value identifying this job.
    x_organization = "X-Organization_example" # str |  (optional)
    filter = "filter_example" # str | A filter term. Avaliable filter_fields: ['task_name', 'project_name', 'assignee', 'state', 'stage', 'id', 'task_id', 'project_id', 'updated_date'] (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (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. Avaliable search_fields: ('task_name', 'project_name', 'assignee', 'state', 'stage') (optional)
    sort = "sort_example" # str | Which field to use when ordering the results. Avaliable ordering_fields: ['task_name', 'project_name', 'assignee', 'state', 'stage', 'id', 'task_id', 'project_id', 'updated_date'] (optional)

    # example passing only required values which don't have defaults set
    try:
        # The action returns the list of tracked changes for the job
        api_response = api_instance.jobs_list_commits(id)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_list_commits: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # The action returns the list of tracked changes for the job
        api_response = api_instance.jobs_list_commits(id, x_organization=x_organization, filter=filter, org=org, org_id=org_id, page=page, page_size=page_size, search=search, sort=sort)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_list_commits: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.
x_organization	str		[optional]
filter	str	A filter term. Avaliable filter_fields: ['task_name', 'project_name', 'assignee', 'state', 'stage', 'id', 'task_id', 'project_id', 'updated_date']	[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]
page	int	A page number within the paginated result set.	[optional]
page_size	int	Number of results to return per page.	[optional]
search	str	A search term. Avaliable search_fields: ('task_name', 'project_name', 'assignee', 'state', 'stage')	[optional]
sort	str	Which field to use when ordering the results. Avaliable ordering_fields: ['task_name', 'project_name', 'assignee', 'state', 'stage', 'id', 'task_id', 'project_id', 'updated_date']	[optional]

Return type

PaginatedJobCommitList

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobs_list_issues

PaginatedIssueReadList jobs_list_issues(id)

Method returns list of issues for the job

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from cvat_sdk.model.paginated_issue_read_list import PaginatedIssueReadList
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    id = 1 # int | A unique integer value identifying this job.
    x_organization = "X-Organization_example" # str |  (optional)
    filter = "filter_example" # str | A filter term. Avaliable filter_fields: ['task_name', 'project_name', 'assignee', 'state', 'stage', 'id', 'task_id', 'project_id', 'updated_date'] (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (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. Avaliable search_fields: ('task_name', 'project_name', 'assignee', 'state', 'stage') (optional)
    sort = "sort_example" # str | Which field to use when ordering the results. Avaliable ordering_fields: ['task_name', 'project_name', 'assignee', 'state', 'stage', 'id', 'task_id', 'project_id', 'updated_date'] (optional)

    # example passing only required values which don't have defaults set
    try:
        # Method returns list of issues for the job
        api_response = api_instance.jobs_list_issues(id)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_list_issues: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Method returns list of issues for the job
        api_response = api_instance.jobs_list_issues(id, x_organization=x_organization, filter=filter, org=org, org_id=org_id, page=page, page_size=page_size, search=search, sort=sort)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_list_issues: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.
x_organization	str		[optional]
filter	str	A filter term. Avaliable filter_fields: ['task_name', 'project_name', 'assignee', 'state', 'stage', 'id', 'task_id', 'project_id', 'updated_date']	[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]
page	int	A page number within the paginated result set.	[optional]
page_size	int	Number of results to return per page.	[optional]
search	str	A search term. Avaliable search_fields: ('task_name', 'project_name', 'assignee', 'state', 'stage')	[optional]
sort	str	Which field to use when ordering the results. Avaliable ordering_fields: ['task_name', 'project_name', 'assignee', 'state', 'stage', 'id', 'task_id', 'project_id', 'updated_date']	[optional]

Return type

PaginatedIssueReadList

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobs_partial_update

JobWrite jobs_partial_update(id)

Methods does a partial update of chosen fields in a job

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from cvat_sdk.model.patched_job_write_request import PatchedJobWriteRequest
from cvat_sdk.model.job_write import JobWrite
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    id = 1 # int | A unique integer value identifying this job.
    x_organization = "X-Organization_example" # str |  (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    patched_job_write_request = PatchedJobWriteRequest(
        assignee=1,
        stage=JobStage("annotation"),
        state=OperationStatus("new"),
    ) # PatchedJobWriteRequest |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Methods does a partial update of chosen fields in a job
        api_response = api_instance.jobs_partial_update(id)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_partial_update: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Methods does a partial update of chosen fields in a job
        api_response = api_instance.jobs_partial_update(id, x_organization=x_organization, org=org, org_id=org_id, patched_job_write_request=patched_job_write_request)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.
x_organization	str		[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]
patched_job_write_request	PatchedJobWriteRequest		[optional]

Return type

JobWrite

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data, application/offset+octet-stream
Accept: application/vnd.cvat+json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobs_partial_update_annotations

jobs_partial_update_annotations(action, id)

Method performs a partial update of annotations in a specific job

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from cvat_sdk.model.patched_job_write_request import PatchedJobWriteRequest
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    action = "create" # str | 
    id = 1 # int | A unique integer value identifying this job.
    x_organization = "X-Organization_example" # str |  (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    patched_job_write_request = PatchedJobWriteRequest(
        assignee=1,
        stage=JobStage("annotation"),
        state=OperationStatus("new"),
    ) # PatchedJobWriteRequest |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Method performs a partial update of annotations in a specific job
        api_instance.jobs_partial_update_annotations(action, id)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_partial_update_annotations: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Method performs a partial update of annotations in a specific job
        api_instance.jobs_partial_update_annotations(action, id, x_organization=x_organization, org=org, org_id=org_id, patched_job_write_request=patched_job_write_request)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_partial_update_annotations: %s\n" % e)

Parameters

Name	Type	Description	Notes
action	str
id	int	A unique integer value identifying this job.
x_organization	str		[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]
patched_job_write_request	PatchedJobWriteRequest		[optional]

Return type

void (empty response body)

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data, application/offset+octet-stream
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobs_partial_update_annotations_file

jobs_partial_update_annotations_file(file_id, id)

Allows to upload an annotation file chunk. Implements TUS file uploading protocol.

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    file_id = "bf325375-e030-fccb-a009-17317c574773" # str | 
    id = 1 # int | A unique integer value identifying this job.
    x_organization = "X-Organization_example" # str |  (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    body = open('/path/to/file', 'rb') # file_type |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Allows to upload an annotation file chunk. Implements TUS file uploading protocol.
        api_instance.jobs_partial_update_annotations_file(file_id, id)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_partial_update_annotations_file: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Allows to upload an annotation file chunk. Implements TUS file uploading protocol.
        api_instance.jobs_partial_update_annotations_file(file_id, id, x_organization=x_organization, org=org, org_id=org_id, body=body)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_partial_update_annotations_file: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_id	str
id	int	A unique integer value identifying this job.
x_organization	str		[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]
body	file_type		[optional]

Return type

void (empty response body)

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data, application/offset+octet-stream
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobs_retrieve

JobRead jobs_retrieve(id)

Method returns details of a job

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from cvat_sdk.model.job_read import JobRead
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    id = 1 # int | A unique integer value identifying this job.
    x_organization = "X-Organization_example" # str |  (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)

    # example passing only required values which don't have defaults set
    try:
        # Method returns details of a job
        api_response = api_instance.jobs_retrieve(id)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_retrieve: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Method returns details of a job
        api_response = api_instance.jobs_retrieve(id, x_organization=x_organization, org=org, org_id=org_id)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.
x_organization	str		[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]

Return type

JobRead

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobs_retrieve_annotations

LabeledData jobs_retrieve_annotations(id)

Method returns annotations for a specific job

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from cvat_sdk.model.labeled_data import LabeledData
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    id = 1 # int | A unique integer value identifying this job.
    x_organization = "X-Organization_example" # str |  (optional)
    action = "download" # str | Used to start downloading process after annotation file had been created (optional) if omitted the server will use the default value of "download"
    cloud_storage_id = 3.14 # float | Storage id (optional)
    filename = "filename_example" # str | Desired output file name (optional)
    format = "format_example" # str | Desired output format name You can get the list of supported formats at: /server/annotation/formats (optional)
    location = "cloud_storage" # str | Where need to save downloaded annotation (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    use_default_location = True # bool | Use the location that was configured in the task to export annotation (optional) if omitted the server will use the default value of True

    # example passing only required values which don't have defaults set
    try:
        # Method returns annotations for a specific job
        api_response = api_instance.jobs_retrieve_annotations(id)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_retrieve_annotations: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Method returns annotations for a specific job
        api_response = api_instance.jobs_retrieve_annotations(id, x_organization=x_organization, action=action, cloud_storage_id=cloud_storage_id, filename=filename, format=format, location=location, org=org, org_id=org_id, use_default_location=use_default_location)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_retrieve_annotations: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.
x_organization	str		[optional]
action	str	Used to start downloading process after annotation file had been created	[optional] if omitted the server will use the default value of "download"
cloud_storage_id	float	Storage id	[optional]
filename	str	Desired output file name	[optional]
format	str	Desired output format name You can get the list of supported formats at: /server/annotation/formats	[optional]
location	str	Where need to save downloaded annotation	[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]
use_default_location	bool	Use the location that was configured in the task to export annotation	[optional] if omitted the server will use the default value of True

Return type

LabeledData

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-
201	Output file is ready for downloading	-
202	Exporting has been started	-
405	Format is not available	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobs_retrieve_data

jobs_retrieve_data(id, number, quality, type)

Method returns data for a specific job

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    id = 1 # int | A unique integer value identifying this job.
    number = 3.14 # float | A unique number value identifying chunk or frame, doesn't matter for 'preview' type
    quality = "compressed" # str | Specifies the quality level of the requested data, doesn't matter for 'preview' type
    type = "chunk" # str | Specifies the type of the requested data
    x_organization = "X-Organization_example" # str |  (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)

    # example passing only required values which don't have defaults set
    try:
        # Method returns data for a specific job
        api_instance.jobs_retrieve_data(id, number, quality, type)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_retrieve_data: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Method returns data for a specific job
        api_instance.jobs_retrieve_data(id, number, quality, type, x_organization=x_organization, org=org, org_id=org_id)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_retrieve_data: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.
number	float	A unique number value identifying chunk or frame, doesn't matter for 'preview' type
quality	str	Specifies the quality level of the requested data, doesn't matter for 'preview' type
type	str	Specifies the type of the requested data
x_organization	str		[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]

Return type

void (empty response body)

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Data of a specific type	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobs_retrieve_data_meta

DataMetaRead jobs_retrieve_data_meta(id)

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

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from cvat_sdk.model.data_meta_read import DataMetaRead
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    id = 1 # int | A unique integer value identifying this job.
    x_organization = "X-Organization_example" # str |  (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)

    # example passing only required values which don't have defaults set
    try:
        # Method provides a meta information about media files which are related with the job
        api_response = api_instance.jobs_retrieve_data_meta(id)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_retrieve_data_meta: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Method provides a meta information about media files which are related with the job
        api_response = api_instance.jobs_retrieve_data_meta(id, x_organization=x_organization, org=org, org_id=org_id)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_retrieve_data_meta: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.
x_organization	str		[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]

Return type

DataMetaRead

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobs_retrieve_dataset

jobs_retrieve_dataset(format, id)

Export job as a dataset in a specific format

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    format = "format_example" # str | Desired output format name You can get the list of supported formats at: /server/annotation/formats
    id = 1 # int | A unique integer value identifying this job.
    x_organization = "X-Organization_example" # str |  (optional)
    action = "download" # str | Used to start downloading process after annotation file had been created (optional) if omitted the server will use the default value of "download"
    cloud_storage_id = 3.14 # float | Storage id (optional)
    filename = "filename_example" # str | Desired output file name (optional)
    location = "cloud_storage" # str | Where need to save downloaded dataset (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    use_default_location = True # bool | Use the location that was configured in the task to export dataset (optional) if omitted the server will use the default value of True

    # example passing only required values which don't have defaults set
    try:
        # Export job as a dataset in a specific format
        api_instance.jobs_retrieve_dataset(format, id)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_retrieve_dataset: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Export job as a dataset in a specific format
        api_instance.jobs_retrieve_dataset(format, id, x_organization=x_organization, action=action, cloud_storage_id=cloud_storage_id, filename=filename, location=location, org=org, org_id=org_id, use_default_location=use_default_location)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_retrieve_dataset: %s\n" % e)

Parameters

Name	Type	Description	Notes
format	str	Desired output format name You can get the list of supported formats at: /server/annotation/formats
id	int	A unique integer value identifying this job.
x_organization	str		[optional]
action	str	Used to start downloading process after annotation file had been created	[optional] if omitted the server will use the default value of "download"
cloud_storage_id	float	Storage id	[optional]
filename	str	Desired output file name	[optional]
location	str	Where need to save downloaded dataset	[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]
use_default_location	bool	Use the location that was configured in the task to export dataset	[optional] if omitted the server will use the default value of True

Return type

void (empty response body)

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Download of file started	-
201	Output file is ready for downloading	-
202	Exporting has been started	-
405	Format is not available	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobs_update

JobWrite jobs_update(id)

Method updates a job by id

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from cvat_sdk.model.job_write import JobWrite
from cvat_sdk.model.job_write_request import JobWriteRequest
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    id = 1 # int | A unique integer value identifying this job.
    x_organization = "X-Organization_example" # str |  (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)
    job_write_request = JobWriteRequest(
        assignee=1,
        stage=JobStage("annotation"),
        state=OperationStatus("new"),
    ) # JobWriteRequest |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Method updates a job by id
        api_response = api_instance.jobs_update(id)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_update: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Method updates a job by id
        api_response = api_instance.jobs_update(id, x_organization=x_organization, org=org, org_id=org_id, job_write_request=job_write_request)
        pprint(api_response)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.
x_organization	str		[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]
job_write_request	JobWriteRequest		[optional]

Return type

JobWrite

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data, application/offset+octet-stream
Accept: application/vnd.cvat+json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

jobs_update_annotations

jobs_update_annotations(id, annotation_file_request)

Method performs an update of all annotations in a specific job

Example

Api Key Authentication (SignatureAuthentication):
Basic Authentication (basicAuth):
Api Key Authentication (cookieAuth):
Api Key Authentication (tokenAuth):

import time
import cvat_sdk
from cvat_sdk.api import jobs_api
from cvat_sdk.model.annotation_file_request import AnnotationFileRequest
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cvat_sdk.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: SignatureAuthentication
configuration.api_key['SignatureAuthentication'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SignatureAuthentication'] = 'Bearer'

# Configure HTTP basic authorization: basicAuth
configuration = cvat_sdk.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with cvat_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = jobs_api.JobsApi(api_client)
    id = 1 # int | A unique integer value identifying this job.
    annotation_file_request = AnnotationFileRequest(
        annotation_file=open('/path/to/file', 'rb'),
    ) # AnnotationFileRequest | 
    x_organization = "X-Organization_example" # str |  (optional)
    org = "org_example" # str | Organization unique slug (optional)
    org_id = 1 # int | Organization identifier (optional)

    # example passing only required values which don't have defaults set
    try:
        # Method performs an update of all annotations in a specific job
        api_instance.jobs_update_annotations(id, annotation_file_request)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_update_annotations: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Method performs an update of all annotations in a specific job
        api_instance.jobs_update_annotations(id, annotation_file_request, x_organization=x_organization, org=org, org_id=org_id)
    except cvat_sdk.ApiException as e:
        print("Exception when calling JobsApi->jobs_update_annotations: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this job.
annotation_file_request	AnnotationFileRequest
x_organization	str		[optional]
org	str	Organization unique slug	[optional]
org_id	int	Organization identifier	[optional]

Return type

void (empty response body)

Authorization

SignatureAuthentication, basicAuth, cookieAuth, tokenAuth

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data, application/offset+octet-stream
Accept: Not defined

HTTP response details

Status code	Description	Response headers
201	Uploading has finished	-
202	Uploading has been started	-
405	Format is not available	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

73 KiB Raw Blame History

cvat_sdk.JobsApi

jobs_create_annotations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jobs_destroy_annotations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jobs_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jobs_list_commits

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jobs_list_issues

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jobs_partial_update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jobs_partial_update_annotations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jobs_partial_update_annotations_file

Example

Parameters

Return type

Authorization

HTTP request headers

jobs_retrieve

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jobs_retrieve_annotations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jobs_retrieve_data

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

jobs_retrieve_data_meta

Example

73 KiB

Raw Blame History