This is the multi-page printable view of this section.
Click here to print.
Return to the regular view of this page.
APIs
All URIs are relative to http://localhost
Class |
Method |
HTTP request |
Description |
AnalyticsApi |
create_report |
POST /api/analytics/reports |
Create an analytics report |
AnalyticsApi |
get_reports |
GET /api/analytics/reports |
Get an analytics report |
AssetsApi |
create |
POST /api/assets |
Create an asset |
AssetsApi |
destroy |
DELETE /api/assets/{uuid} |
Delete an asset |
AssetsApi |
retrieve |
GET /api/assets/{uuid} |
Get an asset |
AuthApi |
create_login |
POST /api/auth/login |
|
AuthApi |
create_logout |
POST /api/auth/logout |
|
AuthApi |
create_password_change |
POST /api/auth/password/change |
|
AuthApi |
create_password_reset |
POST /api/auth/password/reset |
|
AuthApi |
create_password_reset_confirm |
POST /api/auth/password/reset/confirm |
|
AuthApi |
create_register |
POST /api/auth/register |
|
AuthApi |
create_signing |
POST /api/auth/signing |
This method signs URL for access to the server |
AuthApi |
retrieve_rules |
GET /api/auth/rules |
|
CloudstoragesApi |
create |
POST /api/cloudstorages |
Create a cloud storage |
CloudstoragesApi |
destroy |
DELETE /api/cloudstorages/{id} |
Delete a cloud storage |
CloudstoragesApi |
list |
GET /api/cloudstorages |
List cloud storages |
CloudstoragesApi |
partial_update |
PATCH /api/cloudstorages/{id} |
Update a cloud storage |
CloudstoragesApi |
retrieve |
GET /api/cloudstorages/{id} |
Get cloud storage details |
CloudstoragesApi |
retrieve_actions |
GET /api/cloudstorages/{id}/actions |
Get allowed actions for a cloud storage |
CloudstoragesApi |
retrieve_content_v2 |
GET /api/cloudstorages/{id}/content-v2 |
Get cloud storage content |
CloudstoragesApi |
retrieve_preview |
GET /api/cloudstorages/{id}/preview |
Get a preview image for a cloud storage |
CloudstoragesApi |
retrieve_status |
GET /api/cloudstorages/{id}/status |
Get the status of a cloud storage |
CommentsApi |
create |
POST /api/comments |
Create a comment |
CommentsApi |
destroy |
DELETE /api/comments/{id} |
Delete a comment |
CommentsApi |
list |
GET /api/comments |
List comments |
CommentsApi |
partial_update |
PATCH /api/comments/{id} |
Update a comment |
CommentsApi |
retrieve |
GET /api/comments/{id} |
Get comment details |
EventsApi |
create |
POST /api/events |
Log client events |
EventsApi |
list |
GET /api/events |
Get an event log |
GuidesApi |
create |
POST /api/guides |
Create an annotation guide |
GuidesApi |
destroy |
DELETE /api/guides/{id} |
Delete an annotation guide |
GuidesApi |
partial_update |
PATCH /api/guides/{id} |
Update an annotation guide |
GuidesApi |
retrieve |
GET /api/guides/{id} |
Get annotation guide details |
InvitationsApi |
accept |
POST /api/invitations/{key}/accept |
Accept an invitation |
InvitationsApi |
create |
POST /api/invitations |
Create an invitation |
InvitationsApi |
decline |
POST /api/invitations/{key}/decline |
Decline an invitation |
InvitationsApi |
destroy |
DELETE /api/invitations/{key} |
Delete an invitation |
InvitationsApi |
list |
GET /api/invitations |
List invitations |
InvitationsApi |
partial_update |
PATCH /api/invitations/{key} |
Update an invitation |
InvitationsApi |
resend |
POST /api/invitations/{key}/resend |
Resend an invitation |
InvitationsApi |
retrieve |
GET /api/invitations/{key} |
Get invitation details |
IssuesApi |
create |
POST /api/issues |
Create an issue |
IssuesApi |
destroy |
DELETE /api/issues/{id} |
Delete an issue |
IssuesApi |
list |
GET /api/issues |
List issues |
IssuesApi |
partial_update |
PATCH /api/issues/{id} |
Update an issue |
IssuesApi |
retrieve |
GET /api/issues/{id} |
Get issue details |
JobsApi |
create |
POST /api/jobs |
Create a job |
JobsApi |
create_annotations |
POST /api/jobs/{id}/annotations/ |
Import annotations into a job |
JobsApi |
create_dataset_export |
POST /api/jobs/{id}/dataset/export |
Initialize process to export resource as a dataset in a specific format |
JobsApi |
destroy |
DELETE /api/jobs/{id} |
Delete a job |
JobsApi |
destroy_annotations |
DELETE /api/jobs/{id}/annotations/ |
Delete job annotations |
JobsApi |
list |
GET /api/jobs |
List jobs |
JobsApi |
partial_update |
PATCH /api/jobs/{id} |
Update a job |
JobsApi |
partial_update_annotations |
PATCH /api/jobs/{id}/annotations/ |
Update job annotations |
JobsApi |
partial_update_data_meta |
PATCH /api/jobs/{id}/data/meta |
Update metainformation for media files in a job |
JobsApi |
partial_update_validation_layout |
PATCH /api/jobs/{id}/validation_layout |
Allows updating current validation configuration |
JobsApi |
retrieve |
GET /api/jobs/{id} |
Get job details |
JobsApi |
retrieve_annotations |
GET /api/jobs/{id}/annotations/ |
Get job annotations or export job annotations as a dataset in a specific format |
JobsApi |
retrieve_data |
GET /api/jobs/{id}/data |
Get data of a job |
JobsApi |
retrieve_data_meta |
GET /api/jobs/{id}/data/meta |
Get metainformation for media files in a job |
JobsApi |
retrieve_dataset |
GET /api/jobs/{id}/dataset |
Export job as a dataset in a specific format |
JobsApi |
retrieve_preview |
GET /api/jobs/{id}/preview |
Get a preview image for a job |
JobsApi |
retrieve_validation_layout |
GET /api/jobs/{id}/validation_layout |
Allows getting current validation configuration |
JobsApi |
update_annotations |
PUT /api/jobs/{id}/annotations/ |
Replace job annotations / Get annotation import status |
LabelsApi |
destroy |
DELETE /api/labels/{id} |
Delete a label |
LabelsApi |
list |
GET /api/labels |
List labels |
LabelsApi |
partial_update |
PATCH /api/labels/{id} |
Update a label |
LabelsApi |
retrieve |
GET /api/labels/{id} |
Get label details |
LambdaApi |
create_functions |
POST /api/lambda/functions/{func_id} |
|
LambdaApi |
create_requests |
POST /api/lambda/requests |
Method calls the function |
LambdaApi |
delete_requests |
DELETE /api/lambda/requests/{id} |
Method cancels the request |
LambdaApi |
list_functions |
GET /api/lambda/functions |
Method returns a list of functions |
LambdaApi |
list_requests |
GET /api/lambda/requests |
Method returns a list of requests |
LambdaApi |
retrieve_functions |
GET /api/lambda/functions/{func_id} |
Method returns the information about the function |
LambdaApi |
retrieve_requests |
GET /api/lambda/requests/{id} |
Method returns the status of the request |
MembershipsApi |
destroy |
DELETE /api/memberships/{id} |
Delete a membership |
MembershipsApi |
list |
GET /api/memberships |
List memberships |
MembershipsApi |
partial_update |
PATCH /api/memberships/{id} |
Update a membership |
MembershipsApi |
retrieve |
GET /api/memberships/{id} |
Get membership details |
OrganizationsApi |
create |
POST /api/organizations |
Create an organization |
OrganizationsApi |
destroy |
DELETE /api/organizations/{id} |
Delete an organization |
OrganizationsApi |
list |
GET /api/organizations |
List organizations |
OrganizationsApi |
partial_update |
PATCH /api/organizations/{id} |
Update an organization |
OrganizationsApi |
retrieve |
GET /api/organizations/{id} |
Get organization details |
ProjectsApi |
create |
POST /api/projects |
Create a project |
ProjectsApi |
create_backup |
POST /api/projects/backup/ |
Recreate a project from a backup |
ProjectsApi |
create_backup_export |
POST /api/projects/{id}/backup/export |
Initiate process to backup resource |
ProjectsApi |
create_dataset |
POST /api/projects/{id}/dataset/ |
Import a dataset into a project |
ProjectsApi |
create_dataset_export |
POST /api/projects/{id}/dataset/export |
Initialize process to export resource as a dataset in a specific format |
ProjectsApi |
destroy |
DELETE /api/projects/{id} |
Delete a project |
ProjectsApi |
list |
GET /api/projects |
List projects |
ProjectsApi |
partial_update |
PATCH /api/projects/{id} |
Update a project |
ProjectsApi |
retrieve |
GET /api/projects/{id} |
Get project details |
ProjectsApi |
retrieve_annotations |
GET /api/projects/{id}/annotations |
Export project annotations as a dataset |
ProjectsApi |
retrieve_backup |
GET /api/projects/{id}/backup |
Back up a project |
ProjectsApi |
retrieve_dataset |
GET /api/projects/{id}/dataset/ |
Export a project as a dataset / Check dataset import status |
ProjectsApi |
retrieve_preview |
GET /api/projects/{id}/preview |
Get a preview image for a project |
QualityApi |
create_report |
POST /api/quality/reports |
Create a quality report |
QualityApi |
list_conflicts |
GET /api/quality/conflicts |
List annotation conflicts in a quality report |
QualityApi |
list_reports |
GET /api/quality/reports |
List quality reports |
QualityApi |
list_settings |
GET /api/quality/settings |
List quality settings instances |
QualityApi |
partial_update_settings |
PATCH /api/quality/settings/{id} |
Update a quality settings instance |
QualityApi |
retrieve_report |
GET /api/quality/reports/{id} |
Get quality report details |
QualityApi |
retrieve_report_data |
GET /api/quality/reports/{id}/data |
Get quality report contents |
QualityApi |
retrieve_settings |
GET /api/quality/settings/{id} |
Get quality settings instance details |
RequestsApi |
create_cancel |
POST /api/requests/{id}/cancel |
Cancel request |
RequestsApi |
list |
GET /api/requests |
List requests |
RequestsApi |
retrieve |
GET /api/requests/{id} |
Get request details |
SchemaApi |
retrieve |
GET /api/schema/ |
|
ServerApi |
list_share |
GET /api/server/share |
List files/directories in the mounted share |
ServerApi |
retrieve_about |
GET /api/server/about |
Get basic CVAT information |
ServerApi |
retrieve_annotation_formats |
GET /api/server/annotation/formats |
Get supported annotation formats |
ServerApi |
retrieve_plugins |
GET /api/server/plugins |
Get enabled plugins |
TasksApi |
create |
POST /api/tasks |
Create a task |
TasksApi |
create_annotations |
POST /api/tasks/{id}/annotations/ |
Import annotations into a task |
TasksApi |
create_backup |
POST /api/tasks/backup/ |
Recreate a task from a backup |
TasksApi |
create_backup_export |
POST /api/tasks/{id}/backup/export |
Initiate process to backup resource |
TasksApi |
create_data |
POST /api/tasks/{id}/data/ |
Attach data to a task |
TasksApi |
create_dataset_export |
POST /api/tasks/{id}/dataset/export |
Initialize process to export resource as a dataset in a specific format |
TasksApi |
destroy |
DELETE /api/tasks/{id} |
Delete a task |
TasksApi |
destroy_annotations |
DELETE /api/tasks/{id}/annotations/ |
Delete task annotations |
TasksApi |
list |
GET /api/tasks |
List tasks |
TasksApi |
partial_update |
PATCH /api/tasks/{id} |
Update a task |
TasksApi |
partial_update_annotations |
PATCH /api/tasks/{id}/annotations/ |
Update task annotations |
TasksApi |
partial_update_data_meta |
PATCH /api/tasks/{id}/data/meta |
Update metainformation for media files in a task |
TasksApi |
partial_update_validation_layout |
PATCH /api/tasks/{id}/validation_layout |
Allows updating current validation configuration |
TasksApi |
retrieve |
GET /api/tasks/{id} |
Get task details |
TasksApi |
retrieve_annotations |
GET /api/tasks/{id}/annotations/ |
Get task annotations or export them as a dataset in a specific format |
TasksApi |
retrieve_backup |
GET /api/tasks/{id}/backup |
Back up a task |
TasksApi |
retrieve_data |
GET /api/tasks/{id}/data/ |
Get data of a task |
TasksApi |
retrieve_data_meta |
GET /api/tasks/{id}/data/meta |
Get metainformation for media files in a task |
TasksApi |
retrieve_dataset |
GET /api/tasks/{id}/dataset |
Export task as a dataset in a specific format |
TasksApi |
retrieve_preview |
GET /api/tasks/{id}/preview |
Get a preview image for a task |
TasksApi |
retrieve_status |
GET /api/tasks/{id}/status |
Get the creation status of a task |
TasksApi |
retrieve_validation_layout |
GET /api/tasks/{id}/validation_layout |
Allows getting current validation configuration |
TasksApi |
update_annotations |
PUT /api/tasks/{id}/annotations/ |
Replace task annotations / Get annotation import status |
UsersApi |
destroy |
DELETE /api/users/{id} |
Delete a user |
UsersApi |
list |
GET /api/users |
List users |
UsersApi |
partial_update |
PATCH /api/users/{id} |
Update a user |
UsersApi |
retrieve |
GET /api/users/{id} |
Get user details |
UsersApi |
retrieve_self |
GET /api/users/self |
Get details of the current user |
WebhooksApi |
create |
POST /api/webhooks |
Create a webhook |
WebhooksApi |
create_deliveries_redelivery |
POST /api/webhooks/{id}/deliveries/{delivery_id}/redelivery |
Redeliver a webhook delivery |
WebhooksApi |
create_ping |
POST /api/webhooks/{id}/ping |
Send a ping webhook |
WebhooksApi |
destroy |
DELETE /api/webhooks/{id} |
Delete a webhook |
WebhooksApi |
list |
GET /api/webhooks |
List webhooks |
WebhooksApi |
list_deliveries |
GET /api/webhooks/{id}/deliveries |
List deliveries for a webhook |
WebhooksApi |
partial_update |
PATCH /api/webhooks/{id} |
Update a webhook |
WebhooksApi |
retrieve |
GET /api/webhooks/{id} |
Get webhook details |
WebhooksApi |
retrieve_deliveries |
GET /api/webhooks/{id}/deliveries/{delivery_id} |
Get details of a webhook delivery |
WebhooksApi |
retrieve_events |
GET /api/webhooks/events |
List available webhook events |
WebhooksApi |
update |
PUT /api/webhooks/{id} |
Replace a webhook |
1 - AnalyticsApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
create_report |
POST /api/analytics/reports |
Create an analytics report |
get_reports |
GET /api/analytics/reports |
Get an analytics report |
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
Name |
Type |
Description |
Notes |
rq_id |
str |
The report creation request id. Can be specified to check the report creation status. |
[optional] |
analytics_report_create_request |
AnalyticsReportCreateRequest |
|
[optional] |
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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
A analytics report request has been computed |
- |
202 |
A analytics report request has been enqueued, the request id is returned. The request status can be checked at this endpoint by passing the rq_id as the query parameter. If the request id is specified, this response means the analytics report request is queued or is being processed. |
- |
400 |
Invalid or failed request, check the response data for 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
Name |
Type |
Description |
Notes |
end_date |
datetime |
Specify the end date for filtering report data. |
[optional] |
job_id |
int |
Specify job ID |
[optional] |
project_id |
int |
Specify project ID |
[optional] |
start_date |
datetime |
Specify a start date for filtering report data. |
[optional] |
task_id |
int |
Specify task ID |
[optional] |
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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
404 |
Not found |
- |
2 - AssetsApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
create |
POST /api/assets |
Create an asset |
destroy |
DELETE /api/assets/{uuid} |
Delete an asset |
retrieve |
GET /api/assets/{uuid} |
Get an asset |
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
Name |
Type |
Description |
Notes |
file |
file_type |
|
[optional] |
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
- Content-Type: multipart/form-data
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
|
- |
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
Name |
Type |
Description |
Notes |
uuid |
str |
A UUID string identifying this asset. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The asset has been deleted |
- |
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
Name |
Type |
Description |
Notes |
uuid |
str |
A UUID string identifying this asset. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
Asset file |
- |
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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
|
- |
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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
text URL |
- |
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
No response body |
- |
4 - CloudstoragesApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
create |
POST /api/cloudstorages |
Create a cloud storage |
destroy |
DELETE /api/cloudstorages/{id} |
Delete a cloud storage |
list |
GET /api/cloudstorages |
List cloud storages |
partial_update |
PATCH /api/cloudstorages/{id} |
Update a cloud storage |
retrieve |
GET /api/cloudstorages/{id} |
Get cloud storage details |
retrieve_actions |
GET /api/cloudstorages/{id}/actions |
Get allowed actions for a cloud storage |
retrieve_content_v2 |
GET /api/cloudstorages/{id}/content-v2 |
Get cloud storage content |
retrieve_preview |
GET /api/cloudstorages/{id}/preview |
Get a preview image for a cloud storage |
retrieve_status |
GET /api/cloudstorages/{id}/status |
Get the status of a cloud storage |
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
Name |
Type |
Description |
Notes |
cloud_storage_write_request |
CloudStorageWriteRequest |
|
|
x_organization |
str |
Organization unique slug |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
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
- Content-Type: application/json, multipart/form-data
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
|
- |
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
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this cloud storage. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The cloud storage has been removed |
- |
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
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
credentials_type |
str |
A simple equality filter for the credentials_type field |
[optional] |
filter |
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"},""]}]} 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 |
str |
A simple equality filter for the name field |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
owner |
str |
A simple equality filter for the owner field |
[optional] |
page |
int |
A page number within the paginated result set. |
[optional] |
page_size |
int |
Number of results to return per page. |
[optional] |
provider_type |
str |
A simple equality filter for the provider_type field |
[optional] |
resource |
str |
A simple equality filter for the resource field |
[optional] |
search |
str |
A search term. Available search_fields: (‘provider_type’, ’name’, ‘resource’, ‘credentials_type’, ‘owner’, ‘description’) |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [‘provider_type’, ’name’, ‘resource’, ‘credentials_type’, ‘owner’, ‘description’, ‘id’] |
[optional] |
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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
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
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this cloud storage. |
|
patched_cloud_storage_write_request |
PatchedCloudStorageWriteRequest |
|
[optional] |
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
- Content-Type: application/json, multipart/form-data
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
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
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this cloud storage. |
|
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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
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
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this cloud storage. |
|
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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
Cloud Storage actions (GET |
PUT |
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
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this cloud storage. |
|
manifest_path |
str |
Path to the manifest file in a cloud storage |
[optional] |
next_token |
str |
Used to continue listing files in the bucket |
[optional] |
page_size |
int |
|
[optional] |
prefix |
str |
Prefix to filter data |
[optional] |
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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
A manifest content |
- |
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
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this cloud storage. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
Cloud Storage preview |
- |
400 |
Failed to get cloud storage preview |
- |
404 |
Cloud Storage preview not found |
- |
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
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this cloud storage. |
|
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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
Cloud Storage status (AVAILABLE |
NOT_FOUND |
5 - CommentsApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
create |
POST /api/comments |
Create a comment |
destroy |
DELETE /api/comments/{id} |
Delete a comment |
list |
GET /api/comments |
List comments |
partial_update |
PATCH /api/comments/{id} |
Update a comment |
retrieve |
GET /api/comments/{id} |
Get comment details |
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
Name |
Type |
Description |
Notes |
comment_write_request |
CommentWriteRequest |
|
|
x_organization |
str |
Organization unique slug |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
|
- |
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
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this comment. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The comment has been deleted |
- |
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
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
filter |
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"},""]}]} 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 |
int |
A simple equality filter for the frame_id field |
[optional] |
issue_id |
int |
A simple equality filter for the issue_id field |
[optional] |
job_id |
int |
A simple equality filter for the job_id field |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
owner |
str |
A simple equality filter for the owner field |
[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. Available search_fields: (‘owner’,) |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [‘owner’, ‘id’, ‘issue_id’, ‘frame_id’, ‘job_id’] |
[optional] |
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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
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)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this comment. |
|
patched_comment_write_request |
PatchedCommentWriteRequest |
|
[optional] |
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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve
retrieve(
id,
**kwargs
)
Get comment 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 comment.
try:
(data, response) = api_client.comments_api.retrieve(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling CommentsApi.retrieve(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this comment. |
|
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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
6 - EventsApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
create |
POST /api/events |
Log client events |
list |
GET /api/events |
Get an event log |
create
create(
client_events_request,
x_organization=None,
org=None,
org_id=None,
**kwargs
)
Log client events
Sends logs to the Clickhouse if it is connected
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:
client_events_request = ClientEventsRequest(
events=[
EventRequest(
scope="scope_example",
obj_name="obj_name_example",
obj_id=1,
obj_val="obj_val_example",
source="source_example",
timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'),
count=1,
duration=0,
project_id=1,
task_id=1,
job_id=1,
user_id=1,
user_name="user_name_example",
user_email="user_email_example",
org_id=1,
org_slug="org_slug_example",
payload="payload_example",
),
],
previous_event=ClientEventsRequestPreviousEvent(None),
timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'),
) # ClientEventsRequest |
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.events_api.create(
client_events_request,
x_organization=x_organization,
org=org,
org_id=org_id,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling EventsApi.create(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
client_events_request |
ClientEventsRequest |
|
|
x_organization |
str |
Organization unique slug |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[ClientEvents, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
|
- |
list
list(
action=None,
filename=None,
_from=None,
job_id=None,
org_id=None,
project_id=None,
query_id=None,
task_id=None,
to=None,
user_id=None,
**kwargs
)
Get an event log
The log is returned in the CSV format.
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:
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"
filename = "filename_example" # str | Desired output file name (optional)
_from = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Filter events after the datetime. If no 'from' or 'to' parameters are passed, the last 30 days will be set. (optional)
job_id = 1 # int | Filter events by job ID (optional)
org_id = 1 # int | Filter events by organization ID (optional)
project_id = 1 # int | Filter events by project ID (optional)
query_id = "query_id_example" # str | ID of query request that need to check or download (optional)
task_id = 1 # int | Filter events by task ID (optional)
to = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | Filter events before the datetime. If no 'from' or 'to' parameters are passed, the last 30 days will be set. (optional)
user_id = 1 # int | Filter events by user ID (optional)
try:
api_client.events_api.list(
action=action,
filename=filename,
_from=_from,
job_id=job_id,
org_id=org_id,
project_id=project_id,
query_id=query_id,
task_id=task_id,
to=to,
user_id=user_id,
)
except exceptions.ApiException as e:
print("Exception when calling EventsApi.list(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
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” |
filename |
str |
Desired output file name |
[optional] |
_from |
datetime |
Filter events after the datetime. If no ‘from’ or ’to’ parameters are passed, the last 30 days will be set. |
[optional] |
job_id |
int |
Filter events by job ID |
[optional] |
org_id |
int |
Filter events by organization ID |
[optional] |
project_id |
int |
Filter events by project ID |
[optional] |
query_id |
str |
ID of query request that need to check or download |
[optional] |
task_id |
int |
Filter events by task ID |
[optional] |
to |
datetime |
Filter events before the datetime. If no ‘from’ or ’to’ parameters are passed, the last 30 days will be set. |
[optional] |
user_id |
int |
Filter events by user ID |
[optional] |
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
Download of file started |
- |
201 |
CSV log file is ready for downloading |
- |
202 |
Creating a CSV log file has been started |
- |
7 - GuidesApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
create |
POST /api/guides |
Create an annotation guide |
destroy |
DELETE /api/guides/{id} |
Delete an annotation guide |
partial_update |
PATCH /api/guides/{id} |
Update an annotation guide |
retrieve |
GET /api/guides/{id} |
Get annotation guide details |
create
create(
annotation_guide_write_request=None,
**kwargs
)
Create an annotation guide
The new guide will be bound either to a project or a task, depending on parameters.
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:
annotation_guide_write_request = AnnotationGuideWriteRequest(
task_id=1,
project_id=1,
markdown="markdown_example",
) # AnnotationGuideWriteRequest | (optional)
try:
(data, response) = api_client.guides_api.create(
annotation_guide_write_request=annotation_guide_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling GuidesApi.create(): %s\n" % e)
Parameters
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[AnnotationGuideRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
|
- |
destroy
destroy(
id,
**kwargs
)
Delete an annotation guide
This also deletes all assets attached to the guide.
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 annotation guide.
try:
api_client.guides_api.destroy(
id,)
except exceptions.ApiException as e:
print("Exception when calling GuidesApi.destroy(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this annotation guide. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The annotation guide has been deleted |
- |
partial_update
partial_update(
id,
patched_annotation_guide_write_request=None,
**kwargs
)
Update an annotation guide
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 annotation guide.
patched_annotation_guide_write_request = PatchedAnnotationGuideWriteRequest(
task_id=1,
project_id=1,
markdown="markdown_example",
) # PatchedAnnotationGuideWriteRequest | (optional)
try:
(data, response) = api_client.guides_api.partial_update(
id,
patched_annotation_guide_write_request=patched_annotation_guide_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling GuidesApi.partial_update(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this annotation guide. |
|
patched_annotation_guide_write_request |
PatchedAnnotationGuideWriteRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[AnnotationGuideRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve
retrieve(
id,
**kwargs
)
Get annotation guide 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 annotation guide.
try:
(data, response) = api_client.guides_api.retrieve(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling GuidesApi.retrieve(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this annotation guide. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[AnnotationGuideRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
8 - InvitationsApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
accept |
POST /api/invitations/{key}/accept |
Accept an invitation |
create |
POST /api/invitations |
Create an invitation |
decline |
POST /api/invitations/{key}/decline |
Decline an invitation |
destroy |
DELETE /api/invitations/{key} |
Delete an invitation |
list |
GET /api/invitations |
List invitations |
partial_update |
PATCH /api/invitations/{key} |
Update an invitation |
resend |
POST /api/invitations/{key}/resend |
Resend an invitation |
retrieve |
GET /api/invitations/{key} |
Get invitation details |
accept
accept(
key,
**kwargs
)
Accept an invitation
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:
key = "key_example" # str | A unique value identifying this invitation.
try:
(data, response) = api_client.invitations_api.accept(
key,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling InvitationsApi.accept(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
key |
str |
A unique value identifying this invitation. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[AcceptInvitationRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
The invitation is accepted |
- |
400 |
The invitation is expired or already accepted |
- |
create
create(
invitation_write_request,
x_organization=None,
org=None,
org_id=None,
**kwargs
)
Create an invitation
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:
invitation_write_request = InvitationWriteRequest(
role=RoleEnum("worker"),
email="email_example",
) # InvitationWriteRequest |
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.invitations_api.create(
invitation_write_request,
x_organization=x_organization,
org=org,
org_id=org_id,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling InvitationsApi.create(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
invitation_write_request |
InvitationWriteRequest |
|
|
x_organization |
str |
Organization unique slug |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[InvitationRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
|
- |
decline
decline(
key,
**kwargs
)
Decline an invitation
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:
key = "key_example" # str | A unique value identifying this invitation.
try:
api_client.invitations_api.decline(
key,)
except exceptions.ApiException as e:
print("Exception when calling InvitationsApi.decline(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
key |
str |
A unique value identifying this invitation. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The invitation has been declined |
- |
destroy
destroy(
key,
**kwargs
)
Delete an invitation
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:
key = "key_example" # str | A unique value identifying this invitation.
try:
api_client.invitations_api.destroy(
key,)
except exceptions.ApiException as e:
print("Exception when calling InvitationsApi.destroy(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
key |
str |
A unique value identifying this invitation. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The invitation has been deleted |
- |
list
list(
x_organization=None,
filter=None,
org=None,
org_id=None,
owner=None,
page=None,
page_size=None,
search=None,
sort=None,
**kwargs
)
List invitations
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', 'user_id', 'accepted']. (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', 'created_date'] (optional)
try:
(data, response) = api_client.invitations_api.list(
x_organization=x_organization,
filter=filter,
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 InvitationsApi.list(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
filter |
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"},""]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [‘owner’, ‘user_id’, ‘accepted’]. |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
owner |
str |
A simple equality filter for the owner field |
[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. Available search_fields: (‘owner’,) |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [‘owner’, ‘created_date’] |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedInvitationReadList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update
partial_update(
key,
patched_invitation_write_request=None,
**kwargs
)
Update an invitation
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:
key = "key_example" # str | A unique value identifying this invitation.
patched_invitation_write_request = PatchedInvitationWriteRequest(
role=RoleEnum("worker"),
email="email_example",
) # PatchedInvitationWriteRequest | (optional)
try:
(data, response) = api_client.invitations_api.partial_update(
key,
patched_invitation_write_request=patched_invitation_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling InvitationsApi.partial_update(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
key |
str |
A unique value identifying this invitation. |
|
patched_invitation_write_request |
PatchedInvitationWriteRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[InvitationRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
resend
resend(
key,
**kwargs
)
Resend an invitation
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:
key = "key_example" # str | A unique value identifying this invitation.
try:
api_client.invitations_api.resend(
key,)
except exceptions.ApiException as e:
print("Exception when calling InvitationsApi.resend(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
key |
str |
A unique value identifying this invitation. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
Invitation has been sent |
- |
400 |
The invitation is already accepted |
- |
retrieve
retrieve(
key,
**kwargs
)
Get invitation 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:
key = "key_example" # str | A unique value identifying this invitation.
try:
(data, response) = api_client.invitations_api.retrieve(
key,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling InvitationsApi.retrieve(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
key |
str |
A unique value identifying this invitation. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[InvitationRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
9 - IssuesApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
create |
POST /api/issues |
Create an issue |
destroy |
DELETE /api/issues/{id} |
Delete an issue |
list |
GET /api/issues |
List issues |
partial_update |
PATCH /api/issues/{id} |
Update an issue |
retrieve |
GET /api/issues/{id} |
Get issue details |
create
create(
issue_write_request,
x_organization=None,
org=None,
org_id=None,
**kwargs
)
Create an issue
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:
issue_write_request = IssueWriteRequest(
frame=0,
position=[
3.14,
],
job=1,
assignee=1,
message="message_example",
resolved=True,
) # IssueWriteRequest |
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.issues_api.create(
issue_write_request,
x_organization=x_organization,
org=org,
org_id=org_id,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling IssuesApi.create(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
issue_write_request |
IssueWriteRequest |
|
|
x_organization |
str |
Organization unique slug |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[IssueRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
|
- |
destroy
destroy(
id,
**kwargs
)
Delete an issue
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 issue.
try:
api_client.issues_api.destroy(
id,)
except exceptions.ApiException as e:
print("Exception when calling IssuesApi.destroy(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this issue. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The issue has been deleted |
- |
list
list(
x_organization=None,
assignee=None,
filter=None,
frame_id=None,
job_id=None,
org=None,
org_id=None,
owner=None,
page=None,
page_size=None,
resolved=None,
search=None,
sort=None,
task_id=None,
**kwargs
)
List issues
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)
assignee = "assignee_example" # str | A simple equality filter for the assignee 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: ['owner', 'assignee', 'id', 'job_id', 'task_id', 'resolved', 'frame_id']. (optional)
frame_id = 1 # int | A simple equality filter for the frame_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)
resolved = True # bool | A simple equality filter for the resolved field (optional)
search = "search_example" # str | A search term. Available search_fields: ('owner', 'assignee') (optional)
sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['owner', 'assignee', 'id', 'job_id', 'task_id', 'resolved', 'frame_id'] (optional)
task_id = 1 # int | A simple equality filter for the task_id field (optional)
try:
(data, response) = api_client.issues_api.list(
x_organization=x_organization,
assignee=assignee,
filter=filter,
frame_id=frame_id,
job_id=job_id,
org=org,
org_id=org_id,
owner=owner,
page=page,
page_size=page_size,
resolved=resolved,
search=search,
sort=sort,
task_id=task_id,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling IssuesApi.list(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
assignee |
str |
A simple equality filter for the assignee field |
[optional] |
filter |
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"},""]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [‘owner’, ‘assignee’, ‘id’, ‘job_id’, ’task_id’, ‘resolved’, ‘frame_id’]. |
[optional] |
frame_id |
int |
A simple equality filter for the frame_id field |
[optional] |
job_id |
int |
A simple equality filter for the job_id field |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
owner |
str |
A simple equality filter for the owner field |
[optional] |
page |
int |
A page number within the paginated result set. |
[optional] |
page_size |
int |
Number of results to return per page. |
[optional] |
resolved |
bool |
A simple equality filter for the resolved field |
[optional] |
search |
str |
A search term. Available search_fields: (‘owner’, ‘assignee’) |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [‘owner’, ‘assignee’, ‘id’, ‘job_id’, ’task_id’, ‘resolved’, ‘frame_id’] |
[optional] |
task_id |
int |
A simple equality filter for the task_id field |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedIssueReadList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update
partial_update(
id,
patched_issue_write_request=None,
**kwargs
)
Update an issue
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 issue.
patched_issue_write_request = PatchedIssueWriteRequest(
position=[
3.14,
],
assignee=1,
resolved=True,
) # PatchedIssueWriteRequest | (optional)
try:
(data, response) = api_client.issues_api.partial_update(
id,
patched_issue_write_request=patched_issue_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling IssuesApi.partial_update(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this issue. |
|
patched_issue_write_request |
PatchedIssueWriteRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[IssueRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve
retrieve(
id,
**kwargs
)
Get issue 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 issue.
try:
(data, response) = api_client.issues_api.retrieve(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling IssuesApi.retrieve(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this issue. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[IssueRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
10 - JobsApi class reference
All URIs are relative to http://localhost
create
create(
job_write_request,
**kwargs
)
Create a job
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:
job_write_request = JobWriteRequest(
assignee=1,
stage=JobStage("annotation"),
state=OperationStatus("new"),
type=JobType("annotation"),
task_id=1,
frame_selection_method=FrameSelectionMethod("random_uniform"),
frame_count=1,
frame_share=3.14,
frames_per_job_count=1,
frames_per_job_share=3.14,
random_seed=0,
seed=0,
frames=[
0,
],
) # JobWriteRequest |
try:
(data, response) = api_client.jobs_api.create(
job_write_request,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.create(): %s\n" % e)
Parameters
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[JobRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
|
- |
create_annotations
create_annotations(
id,
cloud_storage_id=None,
filename=None,
format=None,
location=None,
use_default_location=None,
annotation_file_request=None,
**kwargs
)
Import annotations into a job
The request POST /api/jobs/id/annotations will initiate the import and will create the rq job on the server in which the import will be carried out. Please, use the PUT /api/jobs/id/annotations endpoint for checking status of the process.
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 job.
cloud_storage_id = 1 # int | 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)
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
annotation_file_request = AnnotationFileRequest(
annotation_file=open('/path/to/file', 'rb'),
) # AnnotationFileRequest | (optional)
try:
api_client.jobs_api.create_annotations(
id,
cloud_storage_id=cloud_storage_id,
filename=filename,
format=format,
location=location,
use_default_location=use_default_location,
annotation_file_request=annotation_file_request,
)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.create_annotations(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this job. |
|
cloud_storage_id |
int |
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] |
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 |
annotation_file_request |
AnnotationFileRequest |
|
[optional] |
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
- Content-Type: application/json, multipart/form-data
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
Uploading has finished |
- |
202 |
Uploading has been started |
- |
405 |
Format is not available |
- |
create_dataset_export
create_dataset_export(
format,
id,
cloud_storage_id=None,
filename=None,
location=None,
save_images=None,
**kwargs
)
Initialize process to export resource as a dataset in a specific format
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.
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:
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.
cloud_storage_id = 1 # int | Storage id (optional)
filename = "filename_example" # str | Desired output file name (optional)
location = "cloud_storage" # str | Where need to save downloaded dataset (optional)
save_images = False # bool | Include images or not (optional) if omitted the server will use the default value of False
try:
(data, response) = api_client.jobs_api.create_dataset_export(
format,
id,
cloud_storage_id=cloud_storage_id,
filename=filename,
location=location,
save_images=save_images,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.create_dataset_export(): %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. |
|
cloud_storage_id |
int |
Storage id |
[optional] |
filename |
str |
Desired output file name |
[optional] |
location |
str |
Where need to save downloaded dataset |
[optional] |
save_images |
bool |
Include images or not |
[optional] if omitted the server will use the default value of False |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[RqId, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
202 |
Exporting has been started |
- |
405 |
Format is not available |
- |
409 |
Exporting is already in progress |
- |
destroy
destroy(
id,
**kwargs
)
Delete a job
Related annotations will be deleted as well. Please note, that not every job can be removed. Currently, it is only available for Ground Truth jobs.
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 job.
try:
api_client.jobs_api.destroy(
id,)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.destroy(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this job. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The job has been deleted |
- |
destroy_annotations
destroy_annotations(
id,
**kwargs
)
Delete job annotations
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 job.
try:
api_client.jobs_api.destroy_annotations(
id,)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.destroy_annotations(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this job. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The annotation has been deleted |
- |
list
list(
x_organization=None,
assignee=None,
dimension=None,
filter=None,
org=None,
org_id=None,
page=None,
page_size=None,
project_id=None,
project_name=None,
search=None,
sort=None,
stage=None,
state=None,
task_id=None,
task_name=None,
type=None,
**kwargs
)
List jobs
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)
assignee = "assignee_example" # str | A simple equality filter for the assignee field (optional)
dimension = "3d" # str | A simple equality filter for the dimension 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: ['task_name', 'project_name', 'assignee', 'state', 'stage', 'id', 'task_id', 'project_id', 'updated_date', 'dimension', 'type']. (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)
project_id = 1 # int | A simple equality filter for the project_id field (optional)
project_name = "project_name_example" # str | A simple equality filter for the project_name field (optional)
search = "search_example" # str | A search term. Available search_fields: ('task_name', 'project_name', 'assignee', 'state', 'stage') (optional)
sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['task_name', 'project_name', 'assignee', 'state', 'stage', 'id', 'task_id', 'project_id', 'updated_date', 'dimension', 'type'] (optional)
stage = "annotation" # str | A simple equality filter for the stage field (optional)
state = "new" # str | A simple equality filter for the state field (optional)
task_id = 1 # int | A simple equality filter for the task_id field (optional)
task_name = "task_name_example" # str | A simple equality filter for the task_name field (optional)
type = "annotation" # str | A simple equality filter for the type field (optional)
try:
(data, response) = api_client.jobs_api.list(
x_organization=x_organization,
assignee=assignee,
dimension=dimension,
filter=filter,
org=org,
org_id=org_id,
page=page,
page_size=page_size,
project_id=project_id,
project_name=project_name,
search=search,
sort=sort,
stage=stage,
state=state,
task_id=task_id,
task_name=task_name,
type=type,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.list(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
assignee |
str |
A simple equality filter for the assignee field |
[optional] |
dimension |
str |
A simple equality filter for the dimension field |
[optional] |
filter |
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"},""]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [’task_name’, ‘project_name’, ‘assignee’, ‘state’, ‘stage’, ‘id’, ’task_id’, ‘project_id’, ‘updated_date’, ‘dimension’, ’type’]. |
[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] |
project_id |
int |
A simple equality filter for the project_id field |
[optional] |
project_name |
str |
A simple equality filter for the project_name field |
[optional] |
search |
str |
A search term. Available search_fields: (’task_name’, ‘project_name’, ‘assignee’, ‘state’, ‘stage’) |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [’task_name’, ‘project_name’, ‘assignee’, ‘state’, ‘stage’, ‘id’, ’task_id’, ‘project_id’, ‘updated_date’, ‘dimension’, ’type’] |
[optional] |
stage |
str |
A simple equality filter for the stage field |
[optional] |
state |
str |
A simple equality filter for the state field |
[optional] |
task_id |
int |
A simple equality filter for the task_id field |
[optional] |
task_name |
str |
A simple equality filter for the task_name field |
[optional] |
type |
str |
A simple equality filter for the type field |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedJobReadList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update
partial_update(
id,
patched_job_write_request=None,
**kwargs
)
Update a job
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 job.
patched_job_write_request = PatchedJobWriteRequest(
assignee=1,
stage=JobStage("annotation"),
state=OperationStatus("new"),
) # PatchedJobWriteRequest | (optional)
try:
(data, response) = api_client.jobs_api.partial_update(
id,
patched_job_write_request=patched_job_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.partial_update(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this job. |
|
patched_job_write_request |
PatchedJobWriteRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[JobRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update_annotations
partial_update_annotations(
action,
id,
patched_labeled_data_request=None,
**kwargs
)
Update job annotations
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:
action = "create" # str |
id = 1 # int | A unique integer value identifying this job.
patched_labeled_data_request = PatchedLabeledDataRequest(
version=0,
tags=[
LabeledImageRequest(
id=1,
frame=0,
label_id=0,
group=0,
source="manual",
attributes=[
AttributeValRequest(
spec_id=1,
value="value_example",
),
],
),
],
shapes=[
LabeledShapeRequest(
type=ShapeType("rectangle"),
occluded=False,
outside=False,
z_order=0,
rotation=0.0,
points=[
3.14,
],
id=1,
frame=0,
label_id=0,
group=0,
source="manual",
attributes=[
AttributeValRequest(
spec_id=1,
value="value_example",
),
],
elements=[
SubLabeledShapeRequest(
type=ShapeType("rectangle"),
occluded=False,
outside=False,
z_order=0,
rotation=0.0,
points=[
3.14,
],
id=1,
frame=0,
label_id=0,
group=0,
source="manual",
attributes=[
AttributeValRequest(
spec_id=1,
value="value_example",
),
],
),
],
),
],
tracks=[
LabeledTrackRequest(
id=1,
frame=0,
label_id=0,
group=0,
source="manual",
shapes=[
TrackedShapeRequest(
type=ShapeType("rectangle"),
occluded=False,
outside=False,
z_order=0,
rotation=0.0,
points=[
3.14,
],
id=1,
frame=0,
attributes=[
AttributeValRequest(
spec_id=1,
value="value_example",
),
],
),
],
attributes=[
AttributeValRequest(
spec_id=1,
value="value_example",
),
],
elements=[
SubLabeledTrackRequest(
id=1,
frame=0,
label_id=0,
group=0,
source="manual",
shapes=[
TrackedShapeRequest(
type=ShapeType("rectangle"),
occluded=False,
outside=False,
z_order=0,
rotation=0.0,
points=[
3.14,
],
id=1,
frame=0,
attributes=[
AttributeValRequest(
spec_id=1,
value="value_example",
),
],
),
],
attributes=[
AttributeValRequest(
spec_id=1,
value="value_example",
),
],
),
],
),
],
) # PatchedLabeledDataRequest | (optional)
try:
api_client.jobs_api.partial_update_annotations(
action,
id,
patched_labeled_data_request=patched_labeled_data_request,
)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.partial_update_annotations(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
action |
str |
|
|
id |
int |
A unique integer value identifying this job. |
|
patched_labeled_data_request |
PatchedLabeledDataRequest |
|
[optional] |
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
- Content-Type: application/json, multipart/form-data
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
Annotations successfully uploaded |
- |
partial_update_data_meta(
id,
patched_job_data_meta_write_request=None,
**kwargs
)
Update metainformation for media files in a job
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 job.
patched_job_data_meta_write_request = PatchedJobDataMetaWriteRequest(
deleted_frames=[
0,
],
) # PatchedJobDataMetaWriteRequest | (optional)
try:
(data, response) = api_client.jobs_api.partial_update_data_meta(
id,
patched_job_data_meta_write_request=patched_job_data_meta_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.partial_update_data_meta(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this job. |
|
patched_job_data_meta_write_request |
PatchedJobDataMetaWriteRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[DataMetaRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update_validation_layout
partial_update_validation_layout(
id,
patched_job_validation_layout_write_request=None,
**kwargs
)
Allows updating current validation configuration
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 job.
patched_job_validation_layout_write_request = PatchedJobValidationLayoutWriteRequest(
frame_selection_method=None,
honeypot_real_frames=[
0,
],
) # PatchedJobValidationLayoutWriteRequest | (optional)
try:
(data, response) = api_client.jobs_api.partial_update_validation_layout(
id,
patched_job_validation_layout_write_request=patched_job_validation_layout_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.partial_update_validation_layout(): %s\n" % e)
Parameters
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[JobValidationLayoutRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve
retrieve(
id,
**kwargs
)
Get job 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 job.
try:
(data, response) = api_client.jobs_api.retrieve(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.retrieve(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this job. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[JobRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_annotations
retrieve_annotations(
id,
action=None,
cloud_storage_id=None,
filename=None,
format=None,
location=None,
use_default_location=None,
**kwargs
)
Get job annotations or export job annotations as a dataset in a specific format
If format is specified, a ZIP archive will be returned. Otherwise, the annotations will be returned as a JSON document. Deprecation warning: Utilizing this endpoint to export annotations as a dataset in a specific format will be deprecated in one of the next releases. Consider using new API: - POST /api/jobs/<job_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
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 job.
action = "download" # str | Used to start downloading process locally after annotation file has been created (optional) if omitted the server will use the default value of "download"
cloud_storage_id = 1 # int | 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)
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
try:
(data, response) = api_client.jobs_api.retrieve_annotations(
id,
action=action,
cloud_storage_id=cloud_storage_id,
filename=filename,
format=format,
location=location,
use_default_location=use_default_location,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.retrieve_annotations(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this job. |
|
action |
str |
Used to start downloading process locally after annotation file has been created |
[optional] if omitted the server will use the default value of “download” |
cloud_storage_id |
int |
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] |
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 |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[AnnotationsRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
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 |
- |
retrieve_data
retrieve_data(
id,
index=None,
number=None,
quality=None,
type=None,
**kwargs
)
Get data of a job
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 job.
index = 1 # int | A unique number value identifying chunk, starts from 0 for each job (optional)
number = 1 # int | A unique number value identifying chunk or frame. The numbers are the same as for the task. Deprecated for chunks in favor of 'index' (optional)
quality = "compressed" # str | Specifies the quality level of the requested data (optional)
type = "chunk" # str | Specifies the type of the requested data (optional)
try:
(data, response) = api_client.jobs_api.retrieve_data(
id,
index=index,
number=number,
quality=quality,
type=type,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.retrieve_data(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this job. |
|
index |
int |
A unique number value identifying chunk, starts from 0 for each job |
[optional] |
number |
int |
A unique number value identifying chunk or frame. The numbers are the same as for the task. Deprecated for chunks in favor of ‘index’ |
[optional] |
quality |
str |
Specifies the quality level of the requested data |
[optional] |
type |
str |
Specifies the type of the requested data |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[file_type, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
Data of a specific type |
- |
retrieve_data_meta(
id,
**kwargs
)
Get metainformation for media files in a job
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 job.
try:
(data, response) = api_client.jobs_api.retrieve_data_meta(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.retrieve_data_meta(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this job. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[DataMetaRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_dataset
retrieve_dataset(
format,
id,
action=None,
cloud_storage_id=None,
filename=None,
location=None,
use_default_location=None,
**kwargs
)
Export job as a dataset in a specific format
Deprecation warning: This endpoint will be deprecated in one of the next releases. Consider using new API: - POST /api/jobs/<job_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
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:
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.
action = "download" # str | Used to start downloading process locally after annotation file has been created (optional) if omitted the server will use the default value of "download"
cloud_storage_id = 1 # int | Storage id (optional)
filename = "filename_example" # str | Desired output file name (optional)
location = "cloud_storage" # str | Where need to save downloaded dataset (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
try:
(data, response) = api_client.jobs_api.retrieve_dataset(
format,
id,
action=action,
cloud_storage_id=cloud_storage_id,
filename=filename,
location=location,
use_default_location=use_default_location,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.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. |
|
action |
str |
Used to start downloading process locally after annotation file has been created |
[optional] if omitted the server will use the default value of “download” |
cloud_storage_id |
int |
Storage id |
[optional] |
filename |
str |
Desired output file name |
[optional] |
location |
str |
Where need to save downloaded dataset |
[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 |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[file_type, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
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 |
- |
retrieve_preview
retrieve_preview(
id,
**kwargs
)
Get a preview image for a job
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 job.
try:
api_client.jobs_api.retrieve_preview(
id,)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.retrieve_preview(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this job. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
Job image preview |
- |
retrieve_validation_layout
retrieve_validation_layout(
id,
**kwargs
)
Allows getting current validation configuration
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 job.
try:
(data, response) = api_client.jobs_api.retrieve_validation_layout(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.retrieve_validation_layout(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this job. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[JobValidationLayoutRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
update_annotations
update_annotations(
id,
cloud_storage_id=None,
filename=None,
format=None,
location=None,
rq_id=None,
use_default_location=None,
job_annotations_update_request=None,
**kwargs
)
Replace job annotations / Get annotation import status
To check the status of an import request: After initiating the annotation import, you will receive an rq_id parameter. Make sure to include this parameter as a query parameter in your subsequent PUT /api/jobs/id/annotations requests to track the status of the import.
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 job.
cloud_storage_id = 1 # int | 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)
rq_id = "rq_id_example" # str | rq id (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_annotations_update_request = JobAnnotationsUpdateRequest(None) # JobAnnotationsUpdateRequest | (optional)
try:
api_client.jobs_api.update_annotations(
id,
cloud_storage_id=cloud_storage_id,
filename=filename,
format=format,
location=location,
rq_id=rq_id,
use_default_location=use_default_location,
job_annotations_update_request=job_annotations_update_request,
)
except exceptions.ApiException as e:
print("Exception when calling JobsApi.update_annotations(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this job. |
|
cloud_storage_id |
int |
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] |
rq_id |
str |
rq id |
[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_annotations_update_request |
JobAnnotationsUpdateRequest |
|
[optional] |
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
- Content-Type: application/json, multipart/form-data
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
201 |
Import has finished |
- |
202 |
Import is in progress |
- |
405 |
Format is not available |
- |
11 - LabelsApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
destroy |
DELETE /api/labels/{id} |
Delete a label |
list |
GET /api/labels |
List labels |
partial_update |
PATCH /api/labels/{id} |
Update a label |
retrieve |
GET /api/labels/{id} |
Get label details |
destroy
destroy(
id,
**kwargs
)
Delete a label
To delete a sublabel, please use the PATCH method of the parent label.
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 label.
try:
api_client.labels_api.destroy(
id,)
except exceptions.ApiException as e:
print("Exception when calling LabelsApi.destroy(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this label. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The label has been deleted |
- |
list
list(
x_organization=None,
color=None,
filter=None,
job_id=None,
name=None,
org=None,
org_id=None,
page=None,
page_size=None,
parent=None,
parent_id=None,
project_id=None,
search=None,
sort=None,
task_id=None,
type=None,
**kwargs
)
List labels
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)
color = "color_example" # str | A simple equality filter for the color 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: ['name', 'parent', 'id', 'type', 'color', 'parent_id']. (optional)
job_id = 1 # int | A simple equality filter for job 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)
page = 1 # int | A page number within the paginated result set. (optional)
page_size = 1 # int | Number of results to return per page. (optional)
parent = "parent_example" # str | A simple equality filter for the parent field (optional)
parent_id = 1 # int | A simple equality filter for the parent_id field (optional)
project_id = 1 # int | A simple equality filter for project id (optional)
search = "search_example" # str | A search term. Available search_fields: ('name', 'parent') (optional)
sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['name', 'parent', 'id', 'type', 'color', 'parent_id'] (optional)
task_id = 1 # int | A simple equality filter for task id (optional)
type = "bbox" # str | A simple equality filter for the type field (optional)
try:
(data, response) = api_client.labels_api.list(
x_organization=x_organization,
color=color,
filter=filter,
job_id=job_id,
name=name,
org=org,
org_id=org_id,
page=page,
page_size=page_size,
parent=parent,
parent_id=parent_id,
project_id=project_id,
search=search,
sort=sort,
task_id=task_id,
type=type,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling LabelsApi.list(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
color |
str |
A simple equality filter for the color field |
[optional] |
filter |
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"},""]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [’name’, ‘parent’, ‘id’, ’type’, ‘color’, ‘parent_id’]. |
[optional] |
job_id |
int |
A simple equality filter for job id |
[optional] |
name |
str |
A simple equality filter for the name field |
[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] |
parent |
str |
A simple equality filter for the parent field |
[optional] |
parent_id |
int |
A simple equality filter for the parent_id field |
[optional] |
project_id |
int |
A simple equality filter for project id |
[optional] |
search |
str |
A search term. Available search_fields: (’name’, ‘parent’) |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [’name’, ‘parent’, ‘id’, ’type’, ‘color’, ‘parent_id’] |
[optional] |
task_id |
int |
A simple equality filter for task id |
[optional] |
type |
str |
A simple equality filter for the type field |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedLabelList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update
partial_update(
id,
patched_label_request=None,
**kwargs
)
Update a label
To modify a sublabel, please use the PATCH method of the parent label.
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 label.
patched_label_request = PatchedLabelRequest(
id=1,
name="name_example",
color="color_example",
attributes=[
AttributeRequest(
id=1,
name="name_example",
mutable=True,
input_type=InputTypeEnum("checkbox"),
default_value="default_value_example",
values=[
"values_example",
],
),
],
deleted=True,
type="type_example",
svg="svg_example",
sublabels=[
SublabelRequest(
id=1,
name="name_example",
color="color_example",
attributes=[
AttributeRequest(
id=1,
name="name_example",
mutable=True,
input_type=InputTypeEnum("checkbox"),
default_value="default_value_example",
values=[
"values_example",
],
),
],
type="type_example",
has_parent=True,
),
],
) # PatchedLabelRequest | (optional)
try:
(data, response) = api_client.labels_api.partial_update(
id,
patched_label_request=patched_label_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling LabelsApi.partial_update(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this label. |
|
patched_label_request |
PatchedLabelRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[Label, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve
retrieve(
id,
**kwargs
)
Get label 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 label.
try:
(data, response) = api_client.labels_api.retrieve(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling LabelsApi.retrieve(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this label. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[Label, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
12 - LambdaApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
create_functions |
POST /api/lambda/functions/{func_id} |
|
create_requests |
POST /api/lambda/requests |
Method calls the function |
delete_requests |
DELETE /api/lambda/requests/{id} |
Method cancels the request |
list_functions |
GET /api/lambda/functions |
Method returns a list of functions |
list_requests |
GET /api/lambda/requests |
Method returns a list of requests |
retrieve_functions |
GET /api/lambda/functions/{func_id} |
Method returns the information about the function |
retrieve_requests |
GET /api/lambda/requests/{id} |
Method returns the status of the request |
create_functions
create_functions(
func_id,
online_function_call_request=None,
**kwargs
)
Allows to execute a function for immediate computation. Intended for short-lived executions, useful for interactive calls. When executed for interactive annotation, the job id must be specified in the ‘job’ input field. The task id is not required in this case, but if it is specified, it must match the job task id.
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:
func_id = "2" # str |
online_function_call_request = OnlineFunctionCallRequest(
job=1,
task=1,
) # OnlineFunctionCallRequest | (optional)
try:
api_client.lambda_api.create_functions(
func_id,
online_function_call_request=online_function_call_request,
)
except exceptions.ApiException as e:
print("Exception when calling LambdaApi.create_functions(): %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
- Content-Type: application/json
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
Returns function invocation results |
- |
create_requests
create_requests(
function_call_request,
x_organization=None,
org=None,
org_id=None,
**kwargs
)
Method calls the function
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:
function_call_request = FunctionCallRequest(
function="function_example",
task=1,
job=1,
quality=None,
max_distance=1,
threshold=3.14,
cleanup=False,
conv_mask_to_poly=False,
mapping={
"key": LabelMappingEntryRequest(
name="name_example",
attributes={
"key": "key_example",
},
sublabels={
"key": SublabelMappingEntryRequest(
name="name_example",
attributes={
"key": "key_example",
},
),
},
),
},
) # FunctionCallRequest |
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.lambda_api.create_requests(
function_call_request,
x_organization=x_organization,
org=org,
org_id=org_id,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling LambdaApi.create_requests(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
function_call_request |
FunctionCallRequest |
|
|
x_organization |
str |
Organization unique slug |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[FunctionCall, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
delete_requests
delete_requests(
id,
**kwargs
)
Method cancels the request
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 = "id_example" # str | Request id
try:
api_client.lambda_api.delete_requests(
id,)
except exceptions.ApiException as e:
print("Exception when calling LambdaApi.delete_requests(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
str |
Request id |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
No response body |
- |
list_functions
list_functions(
**kwargs
)
Method returns a list of functions
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:
api_client.lambda_api.list_functions()
except exceptions.ApiException as e:
print("Exception when calling LambdaApi.list_functions(): %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
basicAuth, csrfAuth, sessionAuth, signatureAuth, tokenAuth
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
No response body |
- |
list_requests
list_requests(
**kwargs
)
Method returns a list of requests
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.lambda_api.list_requests()
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling LambdaApi.list_requests(): %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[typing.List[FunctionCall], 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_functions
retrieve_functions(
func_id,
**kwargs
)
Method returns the information about the function
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:
func_id = "2" # str |
try:
(data, response) = api_client.lambda_api.retrieve_functions(
func_id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling LambdaApi.retrieve_functions(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
func_id |
str |
|
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[typing.Dict[str, typing.Union[typing.Any, none_type]], 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
Information about the function |
- |
retrieve_requests
retrieve_requests(
id,
**kwargs
)
Method returns the status of the request
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 = "id_example" # str | Request id
try:
(data, response) = api_client.lambda_api.retrieve_requests(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling LambdaApi.retrieve_requests(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
str |
Request id |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[FunctionCall, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
13 - MembershipsApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
destroy |
DELETE /api/memberships/{id} |
Delete a membership |
list |
GET /api/memberships |
List memberships |
partial_update |
PATCH /api/memberships/{id} |
Update a membership |
retrieve |
GET /api/memberships/{id} |
Get membership details |
destroy
destroy(
id,
**kwargs
)
Delete a membership
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 membership.
try:
api_client.memberships_api.destroy(
id,)
except exceptions.ApiException as e:
print("Exception when calling MembershipsApi.destroy(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this membership. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The membership has been deleted |
- |
list
list(
x_organization=None,
filter=None,
org=None,
org_id=None,
page=None,
page_size=None,
role=None,
search=None,
sort=None,
user=None,
**kwargs
)
List memberships
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: ['user', 'role', 'id']. (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)
role = "worker" # str | A simple equality filter for the role field (optional)
search = "search_example" # str | A search term. Available search_fields: ('user', 'role') (optional)
sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['user', 'role', 'id'] (optional)
user = "user_example" # str | A simple equality filter for the user field (optional)
try:
(data, response) = api_client.memberships_api.list(
x_organization=x_organization,
filter=filter,
org=org,
org_id=org_id,
page=page,
page_size=page_size,
role=role,
search=search,
sort=sort,
user=user,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling MembershipsApi.list(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
filter |
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"},""]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [‘user’, ‘role’, ‘id’]. |
[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] |
role |
str |
A simple equality filter for the role field |
[optional] |
search |
str |
A search term. Available search_fields: (‘user’, ‘role’) |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [‘user’, ‘role’, ‘id’] |
[optional] |
user |
str |
A simple equality filter for the user field |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedMembershipReadList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update
partial_update(
id,
patched_membership_write_request=None,
**kwargs
)
Update a membership
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 membership.
patched_membership_write_request = PatchedMembershipWriteRequest(
role=RoleEnum("worker"),
) # PatchedMembershipWriteRequest | (optional)
try:
(data, response) = api_client.memberships_api.partial_update(
id,
patched_membership_write_request=patched_membership_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling MembershipsApi.partial_update(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this membership. |
|
patched_membership_write_request |
PatchedMembershipWriteRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[MembershipRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve
retrieve(
id,
**kwargs
)
Get membership 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 membership.
try:
(data, response) = api_client.memberships_api.retrieve(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling MembershipsApi.retrieve(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this membership. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[MembershipRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
14 - OrganizationsApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
create |
POST /api/organizations |
Create an organization |
destroy |
DELETE /api/organizations/{id} |
Delete an organization |
list |
GET /api/organizations |
List organizations |
partial_update |
PATCH /api/organizations/{id} |
Update an organization |
retrieve |
GET /api/organizations/{id} |
Get organization details |
create
create(
organization_write_request,
**kwargs
)
Create an organization
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:
organization_write_request = OrganizationWriteRequest(
slug="z",
name="name_example",
description="description_example",
contact={},
) # OrganizationWriteRequest |
try:
(data, response) = api_client.organizations_api.create(
organization_write_request,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling OrganizationsApi.create(): %s\n" % e)
Parameters
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[OrganizationRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
|
- |
destroy
destroy(
id,
**kwargs
)
Delete an organization
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 organization.
try:
api_client.organizations_api.destroy(
id,)
except exceptions.ApiException as e:
print("Exception when calling OrganizationsApi.destroy(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this organization. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The organization has been deleted |
- |
list
list(
filter=None,
name=None,
owner=None,
page=None,
page_size=None,
search=None,
slug=None,
sort=None,
**kwargs
)
List organizations
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:
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: ['name', 'owner', 'slug', 'id']. (optional)
name = "name_example" # str | A simple equality filter for the name field (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: ('name', 'owner', 'slug') (optional)
slug = "slug_example" # str | A simple equality filter for the slug field (optional)
sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['name', 'owner', 'slug', 'id'] (optional)
try:
(data, response) = api_client.organizations_api.list(
filter=filter,
name=name,
owner=owner,
page=page,
page_size=page_size,
search=search,
slug=slug,
sort=sort,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling OrganizationsApi.list(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
filter |
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"},""]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [’name’, ‘owner’, ‘slug’, ‘id’]. |
[optional] |
name |
str |
A simple equality filter for the name field |
[optional] |
owner |
str |
A simple equality filter for the owner field |
[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. Available search_fields: (’name’, ‘owner’, ‘slug’) |
[optional] |
slug |
str |
A simple equality filter for the slug field |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [’name’, ‘owner’, ‘slug’, ‘id’] |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedOrganizationReadList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update
partial_update(
id,
patched_organization_write_request=None,
**kwargs
)
Update an organization
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 organization.
patched_organization_write_request = PatchedOrganizationWriteRequest(
slug="z",
name="name_example",
description="description_example",
contact={},
) # PatchedOrganizationWriteRequest | (optional)
try:
(data, response) = api_client.organizations_api.partial_update(
id,
patched_organization_write_request=patched_organization_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling OrganizationsApi.partial_update(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this organization. |
|
patched_organization_write_request |
PatchedOrganizationWriteRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[OrganizationRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve
retrieve(
id,
**kwargs
)
Get organization 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 organization.
try:
(data, response) = api_client.organizations_api.retrieve(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling OrganizationsApi.retrieve(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this organization. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[OrganizationRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
15 - ProjectsApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
create |
POST /api/projects |
Create a project |
create_backup |
POST /api/projects/backup/ |
Recreate a project from a backup |
create_backup_export |
POST /api/projects/{id}/backup/export |
Initiate process to backup resource |
create_dataset |
POST /api/projects/{id}/dataset/ |
Import a dataset into a project |
create_dataset_export |
POST /api/projects/{id}/dataset/export |
Initialize process to export resource as a dataset in a specific format |
destroy |
DELETE /api/projects/{id} |
Delete a project |
list |
GET /api/projects |
List projects |
partial_update |
PATCH /api/projects/{id} |
Update a project |
retrieve |
GET /api/projects/{id} |
Get project details |
retrieve_annotations |
GET /api/projects/{id}/annotations |
Export project annotations as a dataset |
retrieve_backup |
GET /api/projects/{id}/backup |
Back up a project |
retrieve_dataset |
GET /api/projects/{id}/dataset/ |
Export a project as a dataset / Check dataset import status |
retrieve_preview |
GET /api/projects/{id}/preview |
Get a preview image for a project |
create
create(
project_write_request,
x_organization=None,
org=None,
org_id=None,
**kwargs
)
Create a project
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:
project_write_request = ProjectWriteRequest(
name="name_example",
labels=[
PatchedLabelRequest(
id=1,
name="name_example",
color="color_example",
attributes=[
AttributeRequest(
id=1,
name="name_example",
mutable=True,
input_type=InputTypeEnum("checkbox"),
default_value="default_value_example",
values=[
"values_example",
],
),
],
deleted=True,
type="type_example",
svg="svg_example",
sublabels=[
SublabelRequest(
id=1,
name="name_example",
color="color_example",
attributes=[
AttributeRequest(
id=1,
name="name_example",
mutable=True,
input_type=InputTypeEnum("checkbox"),
default_value="default_value_example",
values=[
"values_example",
],
),
],
type="type_example",
has_parent=True,
),
],
),
],
owner_id=1,
assignee_id=1,
bug_tracker="bug_tracker_example",
target_storage=PatchedProjectWriteRequestTargetStorage(None),
source_storage=PatchedProjectWriteRequestTargetStorage(None),
) # ProjectWriteRequest |
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.projects_api.create(
project_write_request,
x_organization=x_organization,
org=org,
org_id=org_id,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling ProjectsApi.create(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
project_write_request |
ProjectWriteRequest |
|
|
x_organization |
str |
Organization unique slug |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[ProjectRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
|
- |
create_backup
create_backup(
x_organization=None,
cloud_storage_id=None,
filename=None,
location=None,
org=None,
org_id=None,
rq_id=None,
backup_write_request=None,
**kwargs
)
Recreate a project from a backup
The backup import process is as follows: The first request POST /api/projects/backup will initiate file upload and will create the rq job on the server in which the process of a project creating from an uploaded backup will be carried out. After initiating the backup upload, you will receive an rq_id parameter. Make sure to include this parameter as a query parameter in your subsequent requests to track the status of the project creation. Once the project has been successfully created, the server will return the id of the newly created project.
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)
cloud_storage_id = 1 # int | Storage id (optional)
filename = "filename_example" # str | Backup file name (optional)
location = "local" # str | Where to import the backup file from (optional) if omitted the server will use the default value of "local"
org = "org_example" # str | Organization unique slug (optional)
org_id = 1 # int | Organization identifier (optional)
rq_id = "rq_id_example" # str | rq id (optional)
backup_write_request = BackupWriteRequest(None) # BackupWriteRequest | (optional)
try:
api_client.projects_api.create_backup(
x_organization=x_organization,
cloud_storage_id=cloud_storage_id,
filename=filename,
location=location,
org=org,
org_id=org_id,
rq_id=rq_id,
backup_write_request=backup_write_request,
)
except exceptions.ApiException as e:
print("Exception when calling ProjectsApi.create_backup(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
cloud_storage_id |
int |
Storage id |
[optional] |
filename |
str |
Backup file name |
[optional] |
location |
str |
Where to import the backup file from |
[optional] if omitted the server will use the default value of “local” |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
rq_id |
str |
rq id |
[optional] |
backup_write_request |
BackupWriteRequest |
|
[optional] |
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
- Content-Type: application/json, multipart/form-data
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
The project has been imported |
- |
202 |
Importing a backup file has been started |
- |
create_backup_export
create_backup_export(
id,
cloud_storage_id=None,
filename=None,
location=None,
**kwargs
)
Initiate process to backup resource
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.
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 project.
cloud_storage_id = 1 # int | Storage id (optional)
filename = "filename_example" # str | Backup file name (optional)
location = "cloud_storage" # str | Where need to save downloaded backup (optional)
try:
(data, response) = api_client.projects_api.create_backup_export(
id,
cloud_storage_id=cloud_storage_id,
filename=filename,
location=location,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling ProjectsApi.create_backup_export(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this project. |
|
cloud_storage_id |
int |
Storage id |
[optional] |
filename |
str |
Backup file name |
[optional] |
location |
str |
Where need to save downloaded backup |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[RqId, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
202 |
Creating a backup file has been started |
- |
400 |
Wrong query parameters were passed |
- |
409 |
The backup process has already been initiated and is not yet finished |
- |
create_dataset
create_dataset(
id,
cloud_storage_id=None,
filename=None,
format=None,
location=None,
use_default_location=None,
dataset_write_request=None,
**kwargs
)
Import a dataset into a project
The request POST /api/projects/id/dataset will initiate file upload and will create the rq job on the server in which the process of dataset import from a file will be carried out. Please, use the GET /api/projects/id/dataset endpoint for checking status of the process.
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 project.
cloud_storage_id = 1 # int | Storage id (optional)
filename = "filename_example" # str | Dataset file name (optional)
format = "format_example" # str | Desired dataset format name You can get the list of supported formats at: /server/annotation/formats (optional)
location = "cloud_storage" # str | Where to import the dataset from (optional)
use_default_location = True # bool | Use the location that was configured in the project to import annotations (optional) if omitted the server will use the default value of True
dataset_write_request = DatasetWriteRequest(None) # DatasetWriteRequest | (optional)
try:
(data, response) = api_client.projects_api.create_dataset(
id,
cloud_storage_id=cloud_storage_id,
filename=filename,
format=format,
location=location,
use_default_location=use_default_location,
dataset_write_request=dataset_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling ProjectsApi.create_dataset(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this project. |
|
cloud_storage_id |
int |
Storage id |
[optional] |
filename |
str |
Dataset file name |
[optional] |
format |
str |
Desired dataset format name You can get the list of supported formats at: /server/annotation/formats |
[optional] |
location |
str |
Where to import the dataset from |
[optional] |
use_default_location |
bool |
Use the location that was configured in the project to import annotations |
[optional] if omitted the server will use the default value of True |
dataset_write_request |
DatasetWriteRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[RqId, 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
- Content-Type: application/json, multipart/form-data
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
202 |
Importing has been started |
- |
400 |
Failed to import dataset |
- |
405 |
Format is not available |
- |
create_dataset_export
create_dataset_export(
format,
id,
cloud_storage_id=None,
filename=None,
location=None,
save_images=None,
**kwargs
)
Initialize process to export resource as a dataset in a specific format
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.
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:
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 project.
cloud_storage_id = 1 # int | Storage id (optional)
filename = "filename_example" # str | Desired output file name (optional)
location = "cloud_storage" # str | Where need to save downloaded dataset (optional)
save_images = False # bool | Include images or not (optional) if omitted the server will use the default value of False
try:
(data, response) = api_client.projects_api.create_dataset_export(
format,
id,
cloud_storage_id=cloud_storage_id,
filename=filename,
location=location,
save_images=save_images,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling ProjectsApi.create_dataset_export(): %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 project. |
|
cloud_storage_id |
int |
Storage id |
[optional] |
filename |
str |
Desired output file name |
[optional] |
location |
str |
Where need to save downloaded dataset |
[optional] |
save_images |
bool |
Include images or not |
[optional] if omitted the server will use the default value of False |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[RqId, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
202 |
Exporting has been started |
- |
405 |
Format is not available |
- |
409 |
Exporting is already in progress |
- |
destroy
destroy(
id,
**kwargs
)
Delete a project
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 project.
try:
api_client.projects_api.destroy(
id,)
except exceptions.ApiException as e:
print("Exception when calling ProjectsApi.destroy(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this project. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The project has been deleted |
- |
list
list(
x_organization=None,
assignee=None,
filter=None,
name=None,
org=None,
org_id=None,
owner=None,
page=None,
page_size=None,
search=None,
sort=None,
status=None,
**kwargs
)
List projects
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)
assignee = "assignee_example" # str | A simple equality filter for the assignee 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: ['name', 'owner', 'assignee', 'status', 'id', 'updated_date']. (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)
search = "search_example" # str | A search term. Available search_fields: ('name', 'owner', 'assignee', 'status') (optional)
sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['name', 'owner', 'assignee', 'status', 'id', 'updated_date'] (optional)
status = "annotation" # str | A simple equality filter for the status field (optional)
try:
(data, response) = api_client.projects_api.list(
x_organization=x_organization,
assignee=assignee,
filter=filter,
name=name,
org=org,
org_id=org_id,
owner=owner,
page=page,
page_size=page_size,
search=search,
sort=sort,
status=status,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling ProjectsApi.list(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
assignee |
str |
A simple equality filter for the assignee field |
[optional] |
filter |
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"},""]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [’name’, ‘owner’, ‘assignee’, ‘status’, ‘id’, ‘updated_date’]. |
[optional] |
name |
str |
A simple equality filter for the name field |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
owner |
str |
A simple equality filter for the owner field |
[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. Available search_fields: (’name’, ‘owner’, ‘assignee’, ‘status’) |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [’name’, ‘owner’, ‘assignee’, ‘status’, ‘id’, ‘updated_date’] |
[optional] |
status |
str |
A simple equality filter for the status field |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedProjectReadList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update
partial_update(
id,
patched_project_write_request=None,
**kwargs
)
Update a project
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 project.
patched_project_write_request = PatchedProjectWriteRequest(
name="name_example",
labels=[
PatchedLabelRequest(
id=1,
name="name_example",
color="color_example",
attributes=[
AttributeRequest(
id=1,
name="name_example",
mutable=True,
input_type=InputTypeEnum("checkbox"),
default_value="default_value_example",
values=[
"values_example",
],
),
],
deleted=True,
type="type_example",
svg="svg_example",
sublabels=[
SublabelRequest(
id=1,
name="name_example",
color="color_example",
attributes=[
AttributeRequest(
id=1,
name="name_example",
mutable=True,
input_type=InputTypeEnum("checkbox"),
default_value="default_value_example",
values=[
"values_example",
],
),
],
type="type_example",
has_parent=True,
),
],
),
],
owner_id=1,
assignee_id=1,
bug_tracker="bug_tracker_example",
target_storage=PatchedProjectWriteRequestTargetStorage(None),
source_storage=PatchedProjectWriteRequestTargetStorage(None),
) # PatchedProjectWriteRequest | (optional)
try:
(data, response) = api_client.projects_api.partial_update(
id,
patched_project_write_request=patched_project_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling ProjectsApi.partial_update(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this project. |
|
patched_project_write_request |
PatchedProjectWriteRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[ProjectRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve
retrieve(
id,
**kwargs
)
Get project 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 project.
try:
(data, response) = api_client.projects_api.retrieve(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling ProjectsApi.retrieve(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this project. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[ProjectRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_annotations
retrieve_annotations(
format,
id,
action=None,
cloud_storage_id=None,
filename=None,
location=None,
use_default_location=None,
**kwargs
)
Export project annotations as a dataset
Deprecation warning: Using this endpoint to initiate export of annotations as a dataset or to check export status is deprecated. Consider using new API: - POST /api/projects/<project_id>/dataset/export?save_images=False to initiate exporting process - GET /api/requests/<rq_id> to check export status, where rq_id is request id returned on initializing request’
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:
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 project.
action = "download" # str | Used to start downloading process locally after annotation file has been created (optional) if omitted the server will use the default value of "download"
cloud_storage_id = 1 # int | Storage id (optional)
filename = "filename_example" # str | Desired output file name (optional)
location = "cloud_storage" # str | Where need to save downloaded dataset (optional)
use_default_location = True # bool | Use the location that was configured in project to export annotation (optional) if omitted the server will use the default value of True
try:
(data, response) = api_client.projects_api.retrieve_annotations(
format,
id,
action=action,
cloud_storage_id=cloud_storage_id,
filename=filename,
location=location,
use_default_location=use_default_location,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling ProjectsApi.retrieve_annotations(): %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 project. |
|
action |
str |
Used to start downloading process locally after annotation file has been created |
[optional] if omitted the server will use the default value of “download” |
cloud_storage_id |
int |
Storage id |
[optional] |
filename |
str |
Desired output file name |
[optional] |
location |
str |
Where need to save downloaded dataset |
[optional] |
use_default_location |
bool |
Use the location that was configured in project to export annotation |
[optional] if omitted the server will use the default value of True |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[AnnotationsRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
Download of file started |
- |
201 |
Annotations file is ready to download |
- |
202 |
Dump of annotations has been started |
- |
401 |
Format is not specified |
- |
405 |
Format is not available |
- |
retrieve_backup
retrieve_backup(
id,
action=None,
cloud_storage_id=None,
filename=None,
location=None,
use_default_location=None,
**kwargs
)
Back up a project
Deprecation warning: This endpoint will be deprecated in one of the next releases. Consider using new API: - POST /api/projects/<project_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
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 project.
action = "download" # str | Used to start downloading process after backup file had been created (optional) if omitted the server will use the default value of "download"
cloud_storage_id = 1 # int | Storage id (optional)
filename = "filename_example" # str | Backup file name (optional)
location = "cloud_storage" # str | Where need to save downloaded backup (optional)
use_default_location = True # bool | Use the location that was configured in project to export backup (optional) if omitted the server will use the default value of True
try:
api_client.projects_api.retrieve_backup(
id,
action=action,
cloud_storage_id=cloud_storage_id,
filename=filename,
location=location,
use_default_location=use_default_location,
)
except exceptions.ApiException as e:
print("Exception when calling ProjectsApi.retrieve_backup(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this project. |
|
action |
str |
Used to start downloading process after backup file had been created |
[optional] if omitted the server will use the default value of “download” |
cloud_storage_id |
int |
Storage id |
[optional] |
filename |
str |
Backup file name |
[optional] |
location |
str |
Where need to save downloaded backup |
[optional] |
use_default_location |
bool |
Use the location that was configured in project to export backup |
[optional] if omitted the server will use the default value of True |
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
Download of file started |
- |
201 |
Output backup file is ready for downloading |
- |
202 |
Creating a backup file has been started |
- |
retrieve_dataset
retrieve_dataset(
id,
action=None,
cloud_storage_id=None,
filename=None,
format=None,
location=None,
rq_id=None,
use_default_location=None,
**kwargs
)
Export a project as a dataset / Check dataset import status
To check the status of the process of importing a project dataset from a file: After initiating the dataset upload, you will receive an rq_id parameter. Make sure to include this parameter as a query parameter in your subsequent GET /api/projects/id/dataset requests to track the status of the dataset import. Also you should specify action parameter: action=import_status. Deprecation warning: Utilizing this endpoint to export project dataset in a specific format will be deprecated in one of the next releases. Consider using new API: - POST /api/projects/<project_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
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 project.
action = "download" # str | Used to start downloading process locally after annotation file has been created (optional)
cloud_storage_id = 1 # int | 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 dataset (optional)
rq_id = "rq_id_example" # str | rq id (optional)
use_default_location = True # bool | Use the location that was configured in project to import dataset (optional) if omitted the server will use the default value of True
try:
(data, response) = api_client.projects_api.retrieve_dataset(
id,
action=action,
cloud_storage_id=cloud_storage_id,
filename=filename,
format=format,
location=location,
rq_id=rq_id,
use_default_location=use_default_location,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling ProjectsApi.retrieve_dataset(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this project. |
|
action |
str |
Used to start downloading process locally after annotation file has been created |
[optional] |
cloud_storage_id |
int |
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 dataset |
[optional] |
rq_id |
str |
rq id |
[optional] |
use_default_location |
bool |
Use the location that was configured in project to import dataset |
[optional] if omitted the server will use the default value of True |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[file_type, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
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 |
- |
retrieve_preview
retrieve_preview(
id,
**kwargs
)
Get a preview image for a project
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 project.
try:
api_client.projects_api.retrieve_preview(
id,)
except exceptions.ApiException as e:
print("Exception when calling ProjectsApi.retrieve_preview(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this project. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
Project image preview |
- |
404 |
Project image preview not found |
- |
16 - QualityApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
create_report |
POST /api/quality/reports |
Create a quality report |
list_conflicts |
GET /api/quality/conflicts |
List annotation conflicts in a quality report |
list_reports |
GET /api/quality/reports |
List quality reports |
list_settings |
GET /api/quality/settings |
List quality settings instances |
partial_update_settings |
PATCH /api/quality/settings/{id} |
Update a quality settings instance |
retrieve_report |
GET /api/quality/reports/{id} |
Get quality report details |
retrieve_report_data |
GET /api/quality/reports/{id}/data |
Get quality report contents |
retrieve_settings |
GET /api/quality/settings/{id} |
Get quality settings instance details |
create_report
create_report(
rq_id=None,
quality_report_create_request=None,
**kwargs
)
Create a quality 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)
quality_report_create_request = QualityReportCreateRequest(
task_id=1,
) # QualityReportCreateRequest | (optional)
try:
(data, response) = api_client.quality_api.create_report(
rq_id=rq_id,
quality_report_create_request=quality_report_create_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling QualityApi.create_report(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
rq_id |
str |
The report creation request id. Can be specified to check the report creation status. |
[optional] |
quality_report_create_request |
QualityReportCreateRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[QualityReport, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
|
- |
202 |
A quality report request has been enqueued, the request id is returned. The request status can be checked at this endpoint by passing the rq_id as the query parameter. If the request id is specified, this response means the quality report request is queued or is being processed. |
- |
400 |
Invalid or failed request, check the response data for details |
- |
list_conflicts
list_conflicts(
x_organization=None,
filter=None,
frame=None,
job_id=None,
org=None,
org_id=None,
page=None,
page_size=None,
report_id=None,
severity=None,
sort=None,
task_id=None,
type=None,
**kwargs
)
List annotation conflicts in a quality 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:
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: ['id', 'frame', 'type', 'job_id', 'task_id', 'severity']. (optional)
frame = 1 # int | A simple equality filter for the frame 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)
page = 1 # int | A page number within the paginated result set. (optional)
page_size = 1 # int | Number of results to return per page. (optional)
report_id = 1 # int | A simple equality filter for report id (optional)
severity = "warning" # str | A simple equality filter for the severity field (optional)
sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['id', 'frame', 'type', 'job_id', 'task_id', 'severity'] (optional)
task_id = 1 # int | A simple equality filter for the task_id field (optional)
type = "missing_annotation" # str | A simple equality filter for the type field (optional)
try:
(data, response) = api_client.quality_api.list_conflicts(
x_organization=x_organization,
filter=filter,
frame=frame,
job_id=job_id,
org=org,
org_id=org_id,
page=page,
page_size=page_size,
report_id=report_id,
severity=severity,
sort=sort,
task_id=task_id,
type=type,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling QualityApi.list_conflicts(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
filter |
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"},""]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [‘id’, ‘frame’, ’type’, ‘job_id’, ’task_id’, ‘severity’]. |
[optional] |
frame |
int |
A simple equality filter for the frame field |
[optional] |
job_id |
int |
A simple equality filter for the job_id field |
[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] |
report_id |
int |
A simple equality filter for report id |
[optional] |
severity |
str |
A simple equality filter for the severity field |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [‘id’, ‘frame’, ’type’, ‘job_id’, ’task_id’, ‘severity’] |
[optional] |
task_id |
int |
A simple equality filter for the task_id field |
[optional] |
type |
str |
A simple equality filter for the type field |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedAnnotationConflictList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
list_reports
list_reports(
x_organization=None,
filter=None,
job_id=None,
org=None,
org_id=None,
page=None,
page_size=None,
parent_id=None,
sort=None,
target=None,
task_id=None,
**kwargs
)
List quality reports
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: ['id', 'job_id', 'created_date', 'gt_last_updated', 'target_last_updated', 'parent_id']. (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)
page = 1 # int | A page number within the paginated result set. (optional)
page_size = 1 # int | Number of results to return per page. (optional)
parent_id = 1 # int | A simple equality filter for the parent_id field (optional)
sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['id', 'job_id', 'created_date', 'gt_last_updated', 'target_last_updated', 'parent_id'] (optional)
target = "target_example" # str | A simple equality filter for target (optional)
task_id = 1 # int | A simple equality filter for task id (optional)
try:
(data, response) = api_client.quality_api.list_reports(
x_organization=x_organization,
filter=filter,
job_id=job_id,
org=org,
org_id=org_id,
page=page,
page_size=page_size,
parent_id=parent_id,
sort=sort,
target=target,
task_id=task_id,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling QualityApi.list_reports(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
filter |
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"},""]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [‘id’, ‘job_id’, ‘created_date’, ‘gt_last_updated’, ’target_last_updated’, ‘parent_id’]. |
[optional] |
job_id |
int |
A simple equality filter for the job_id field |
[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] |
parent_id |
int |
A simple equality filter for the parent_id field |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [‘id’, ‘job_id’, ‘created_date’, ‘gt_last_updated’, ’target_last_updated’, ‘parent_id’] |
[optional] |
target |
str |
A simple equality filter for target |
[optional] |
task_id |
int |
A simple equality filter for task id |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedQualityReportList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
list_settings
list_settings(
x_organization=None,
filter=None,
org=None,
org_id=None,
page=None,
page_size=None,
sort=None,
task_id=None,
**kwargs
)
List quality settings instances
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: ['id', 'task_id']. (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)
sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['id'] (optional)
task_id = 1 # int | A simple equality filter for the task_id field (optional)
try:
(data, response) = api_client.quality_api.list_settings(
x_organization=x_organization,
filter=filter,
org=org,
org_id=org_id,
page=page,
page_size=page_size,
sort=sort,
task_id=task_id,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling QualityApi.list_settings(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
filter |
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"},""]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [‘id’, ’task_id’]. |
[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] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [‘id’] |
[optional] |
task_id |
int |
A simple equality filter for the task_id field |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedQualitySettingsList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update_settings
partial_update_settings(
id,
patched_quality_settings_request=None,
**kwargs
)
Update a quality settings instance
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 | An id of a quality settings instance
patched_quality_settings_request = PatchedQualitySettingsRequest(
target_metric=None,
target_metric_threshold=3.14,
max_validations_per_job=0,
iou_threshold=3.14,
oks_sigma=3.14,
line_thickness=3.14,
low_overlap_threshold=3.14,
compare_line_orientation=True,
line_orientation_threshold=3.14,
compare_groups=True,
group_match_threshold=3.14,
check_covered_annotations=True,
object_visibility_threshold=3.14,
panoptic_comparison=True,
compare_attributes=True,
) # PatchedQualitySettingsRequest | (optional)
try:
(data, response) = api_client.quality_api.partial_update_settings(
id,
patched_quality_settings_request=patched_quality_settings_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling QualityApi.partial_update_settings(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
An id of a quality settings instance |
|
patched_quality_settings_request |
PatchedQualitySettingsRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[QualitySettings, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_report
retrieve_report(
id,
**kwargs
)
Get quality report 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 quality report.
try:
(data, response) = api_client.quality_api.retrieve_report(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling QualityApi.retrieve_report(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this quality report. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[QualityReport, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_report_data
retrieve_report_data(
id,
**kwargs
)
Get quality report contents
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 quality report.
try:
(data, response) = api_client.quality_api.retrieve_report_data(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling QualityApi.retrieve_report_data(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this quality report. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[typing.Dict[str, typing.Union[typing.Any, none_type]], 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_settings
retrieve_settings(
id,
**kwargs
)
Get quality settings instance 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 | An id of a quality settings instance
try:
(data, response) = api_client.quality_api.retrieve_settings(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling QualityApi.retrieve_settings(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
An id of a quality settings instance |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[QualitySettings, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
17 - RequestsApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
create_cancel |
POST /api/requests/{id}/cancel |
Cancel request |
list |
GET /api/requests |
List requests |
retrieve |
GET /api/requests/{id} |
Get request details |
create_cancel
create_cancel(
id,
**kwargs
)
Cancel request
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 = "id_example" # str |
try:
api_client.requests_api.create_cancel(
id,)
except exceptions.ApiException as e:
print("Exception when calling RequestsApi.create_cancel(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
str |
|
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
The request has been cancelled |
- |
list
list(
action=None,
filter=None,
format=None,
job_id=None,
org=None,
page=None,
page_size=None,
project_id=None,
sort=None,
status=None,
subresource=None,
target=None,
task_id=None,
**kwargs
)
List requests
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:
action = "autoannotate" # str | A simple equality filter for the action field (optional)
filter = "filter_example" # str | JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: ['status', 'project_id', 'task_id', 'job_id', 'action', 'target', 'subresource', 'format']. (optional)
format = "format_example" # str | A simple equality filter for the format field (optional)
job_id = 1 # int | A simple equality filter for the job_id field (optional)
org = "org_example" # str | A simple equality filter for the org 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)
project_id = 1 # int | A simple equality filter for the project_id field (optional)
sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['created_date', 'status', 'action'] (optional)
status = "queued" # str | A simple equality filter for the status field (optional)
subresource = "annotations" # str | A simple equality filter for the subresource field (optional)
target = "project" # str | A simple equality filter for the target field (optional)
task_id = 1 # int | A simple equality filter for the task_id field (optional)
try:
(data, response) = api_client.requests_api.list(
action=action,
filter=filter,
format=format,
job_id=job_id,
org=org,
page=page,
page_size=page_size,
project_id=project_id,
sort=sort,
status=status,
subresource=subresource,
target=target,
task_id=task_id,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling RequestsApi.list(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
action |
str |
A simple equality filter for the action field |
[optional] |
filter |
str |
JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [‘status’, ‘project_id’, ’task_id’, ‘job_id’, ‘action’, ’target’, ‘subresource’, ‘format’]. |
[optional] |
format |
str |
A simple equality filter for the format field |
[optional] |
job_id |
int |
A simple equality filter for the job_id field |
[optional] |
org |
str |
A simple equality filter for the org field |
[optional] |
page |
int |
A page number within the paginated result set. |
[optional] |
page_size |
int |
Number of results to return per page. |
[optional] |
project_id |
int |
A simple equality filter for the project_id field |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [‘created_date’, ‘status’, ‘action’] |
[optional] |
status |
str |
A simple equality filter for the status field |
[optional] |
subresource |
str |
A simple equality filter for the subresource field |
[optional] |
target |
str |
A simple equality filter for the target field |
[optional] |
task_id |
int |
A simple equality filter for the task_id field |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedRequestList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve
retrieve(
id,
**kwargs
)
Get request 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 = "id_example" # str |
try:
(data, response) = api_client.requests_api.retrieve(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling RequestsApi.retrieve(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
str |
|
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[Request, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
18 - SchemaApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
retrieve |
GET /api/schema/ |
|
retrieve
retrieve(
lang=None,
scheme=None,
**kwargs
)
OpenApi3 schema for this API. Format can be selected via content negotiation. - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
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:
lang = "af" # str | (optional)
scheme = "json" # str | (optional)
try:
(data, response) = api_client.schema_api.retrieve(
lang=lang,
scheme=scheme,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling SchemaApi.retrieve(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
lang |
str |
|
[optional] |
scheme |
str |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[typing.Dict[str, typing.Union[typing.Any, none_type]], 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
- Content-Type: Not defined
- Accept: application/vnd.oai.openapi, application/yaml, application/vnd.oai.openapi+json, application/json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
19 - ServerApi class reference
All URIs are relative to http://localhost
list_share
list_share(
directory=None,
search=None,
**kwargs
)
List files/directories in the mounted share
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:
directory = "directory_example" # str | Directory to browse (optional)
search = "search_example" # str | Search for specific files (optional)
try:
(data, response) = api_client.server_api.list_share(
directory=directory,
search=search,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling ServerApi.list_share(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
directory |
str |
Directory to browse |
[optional] |
search |
str |
Search for specific files |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[typing.List[FileInfo], 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_about
retrieve_about(
**kwargs
)
Get basic CVAT information
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.server_api.retrieve_about()
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling ServerApi.retrieve_about(): %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[About, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_annotation_formats(
**kwargs
)
Get supported annotation formats
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.server_api.retrieve_annotation_formats()
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling ServerApi.retrieve_annotation_formats(): %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[DatasetFormats, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_plugins
retrieve_plugins(
**kwargs
)
Get enabled plugins
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.server_api.retrieve_plugins()
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling ServerApi.retrieve_plugins(): %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[Plugins, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
20 - TasksApi class reference
All URIs are relative to http://localhost
create
create(
task_write_request,
x_organization=None,
org=None,
org_id=None,
**kwargs
)
Create a task
The new task will not have any attached images or videos. To attach them, use the /api/tasks//data endpoint.
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:
task_write_request = TaskWriteRequest(
name="name_example",
project_id=1,
owner_id=1,
assignee_id=1,
bug_tracker="bug_tracker_example",
overlap=0,
segment_size=0,
labels=[
PatchedLabelRequest(
id=1,
name="name_example",
color="color_example",
attributes=[
AttributeRequest(
id=1,
name="name_example",
mutable=True,
input_type=InputTypeEnum("checkbox"),
default_value="default_value_example",
values=[
"values_example",
],
),
],
deleted=True,
type="type_example",
svg="svg_example",
sublabels=[
SublabelRequest(
id=1,
name="name_example",
color="color_example",
attributes=[
AttributeRequest(
id=1,
name="name_example",
mutable=True,
input_type=InputTypeEnum("checkbox"),
default_value="default_value_example",
values=[
"values_example",
],
),
],
type="type_example",
has_parent=True,
),
],
),
],
subset="subset_example",
target_storage=PatchedTaskWriteRequestTargetStorage(None),
source_storage=PatchedTaskWriteRequestTargetStorage(None),
) # TaskWriteRequest |
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.tasks_api.create(
task_write_request,
x_organization=x_organization,
org=org,
org_id=org_id,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.create(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
task_write_request |
TaskWriteRequest |
|
|
x_organization |
str |
Organization unique slug |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[TaskRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
|
- |
create_annotations
create_annotations(
id,
cloud_storage_id=None,
filename=None,
format=None,
location=None,
use_default_location=None,
task_annotations_write_request=None,
**kwargs
)
Import annotations into a task
The request POST /api/tasks/id/annotations will initiate the import and will create the rq job on the server in which the import will be carried out. Please, use the PUT /api/tasks/id/annotations endpoint for checking status of the process.
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 task.
cloud_storage_id = 1 # int | 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)
use_default_location = True # bool | Use the location that was configured in task to import annotations (optional) if omitted the server will use the default value of True
task_annotations_write_request = TaskAnnotationsWriteRequest(None) # TaskAnnotationsWriteRequest | (optional)
try:
api_client.tasks_api.create_annotations(
id,
cloud_storage_id=cloud_storage_id,
filename=filename,
format=format,
location=location,
use_default_location=use_default_location,
task_annotations_write_request=task_annotations_write_request,
)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.create_annotations(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
cloud_storage_id |
int |
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] |
use_default_location |
bool |
Use the location that was configured in task to import annotations |
[optional] if omitted the server will use the default value of True |
task_annotations_write_request |
TaskAnnotationsWriteRequest |
|
[optional] |
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
- Content-Type: application/json, multipart/form-data
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
Uploading has finished |
- |
202 |
Uploading has been started |
- |
405 |
Format is not available |
- |
create_backup
create_backup(
x_organization=None,
cloud_storage_id=None,
filename=None,
location=None,
org=None,
org_id=None,
rq_id=None,
task_file_request=None,
**kwargs
)
Recreate a task from a backup
The backup import process is as follows: The first request POST /api/tasks/backup will initiate file upload and will create the rq job on the server in which the process of a task creating from an uploaded backup will be carried out. After initiating the backup upload, you will receive an rq_id parameter. Make sure to include this parameter as a query parameter in your subsequent requests to track the status of the task creation. Once the task has been successfully created, the server will return the id of the newly created task.
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)
cloud_storage_id = 1 # int | Storage id (optional)
filename = "filename_example" # str | Backup file name (optional)
location = "local" # str | Where to import the backup file from (optional) if omitted the server will use the default value of "local"
org = "org_example" # str | Organization unique slug (optional)
org_id = 1 # int | Organization identifier (optional)
rq_id = "rq_id_example" # str | rq id (optional)
task_file_request = TaskFileRequest(
task_file=open('/path/to/file', 'rb'),
) # TaskFileRequest | (optional)
try:
api_client.tasks_api.create_backup(
x_organization=x_organization,
cloud_storage_id=cloud_storage_id,
filename=filename,
location=location,
org=org,
org_id=org_id,
rq_id=rq_id,
task_file_request=task_file_request,
)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.create_backup(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
cloud_storage_id |
int |
Storage id |
[optional] |
filename |
str |
Backup file name |
[optional] |
location |
str |
Where to import the backup file from |
[optional] if omitted the server will use the default value of “local” |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
rq_id |
str |
rq id |
[optional] |
task_file_request |
TaskFileRequest |
|
[optional] |
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
- Content-Type: application/json, multipart/form-data
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
The task has been imported |
- |
202 |
Importing a backup file has been started |
- |
create_backup_export
create_backup_export(
id,
cloud_storage_id=None,
filename=None,
location=None,
**kwargs
)
Initiate process to backup resource
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.
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 task.
cloud_storage_id = 1 # int | Storage id (optional)
filename = "filename_example" # str | Backup file name (optional)
location = "cloud_storage" # str | Where need to save downloaded backup (optional)
try:
(data, response) = api_client.tasks_api.create_backup_export(
id,
cloud_storage_id=cloud_storage_id,
filename=filename,
location=location,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.create_backup_export(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
cloud_storage_id |
int |
Storage id |
[optional] |
filename |
str |
Backup file name |
[optional] |
location |
str |
Where need to save downloaded backup |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[RqId, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
202 |
Creating a backup file has been started |
- |
400 |
Wrong query parameters were passed |
- |
409 |
The backup process has already been initiated and is not yet finished |
- |
create_data
create_data(
id,
upload_finish=None,
upload_multiple=None,
upload_start=None,
data_request=None,
**kwargs
)
Attach data to a task
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.
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 task.
upload_finish = True # bool | Finishes data upload. Can be combined with Upload-Start header to create task data with one request (optional)
upload_multiple = True # bool | Indicates that data with this request are single or multiple files that should be attached to a task (optional)
upload_start = True # bool | Initializes data upload. Optionally, can include upload metadata in the request body. (optional)
data_request = DataRequest(
chunk_size=0,
image_quality=0,
start_frame=0,
stop_frame=0,
frame_filter="frame_filter_example",
client_files=[],
server_files=[],
remote_files=[],
use_zip_chunks=False,
server_files_exclude=[],
cloud_storage_id=1,
use_cache=False,
copy_data=False,
storage_method=StorageMethod("cache"),
storage=StorageType("cloud_storage"),
sorting_method=SortingMethod("lexicographical"),
filename_pattern="filename_pattern_example",
job_file_mapping=[
[
"a",
],
],
upload_file_order=[
"upload_file_order_example",
],
validation_params=DataRequestValidationParams(None),
) # DataRequest | (optional)
try:
(data, response) = api_client.tasks_api.create_data(
id,
upload_finish=upload_finish,
upload_multiple=upload_multiple,
upload_start=upload_start,
data_request=data_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.create_data(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
upload_finish |
bool |
Finishes data upload. Can be combined with Upload-Start header to create task data with one request |
[optional] |
upload_multiple |
bool |
Indicates that data with this request are single or multiple files that should be attached to a task |
[optional] |
upload_start |
bool |
Initializes data upload. Optionally, can include upload metadata in the request body. |
[optional] |
data_request |
DataRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[DataResponse, 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
- Content-Type: application/json, multipart/form-data
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
202 |
Request to attach a data to a task has been accepted |
- |
create_dataset_export
create_dataset_export(
format,
id,
cloud_storage_id=None,
filename=None,
location=None,
save_images=None,
**kwargs
)
Initialize process to export resource as a dataset in a specific format
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.
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:
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 task.
cloud_storage_id = 1 # int | Storage id (optional)
filename = "filename_example" # str | Desired output file name (optional)
location = "cloud_storage" # str | Where need to save downloaded dataset (optional)
save_images = False # bool | Include images or not (optional) if omitted the server will use the default value of False
try:
(data, response) = api_client.tasks_api.create_dataset_export(
format,
id,
cloud_storage_id=cloud_storage_id,
filename=filename,
location=location,
save_images=save_images,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.create_dataset_export(): %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 task. |
|
cloud_storage_id |
int |
Storage id |
[optional] |
filename |
str |
Desired output file name |
[optional] |
location |
str |
Where need to save downloaded dataset |
[optional] |
save_images |
bool |
Include images or not |
[optional] if omitted the server will use the default value of False |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[RqId, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
202 |
Exporting has been started |
- |
405 |
Format is not available |
- |
409 |
Exporting is already in progress |
- |
destroy
destroy(
id,
**kwargs
)
Delete a task
All attached jobs, annotations and data will be deleted as well.
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 task.
try:
api_client.tasks_api.destroy(
id,)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.destroy(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The task has been deleted |
- |
destroy_annotations
destroy_annotations(
id,
**kwargs
)
Delete task annotations
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 task.
try:
api_client.tasks_api.destroy_annotations(
id,)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.destroy_annotations(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The annotation has been deleted |
- |
list
list(
x_organization=None,
assignee=None,
dimension=None,
filter=None,
mode=None,
name=None,
org=None,
org_id=None,
owner=None,
page=None,
page_size=None,
project_id=None,
project_name=None,
search=None,
sort=None,
status=None,
subset=None,
tracker_link=None,
validation_mode=None,
**kwargs
)
List tasks
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)
assignee = "assignee_example" # str | A simple equality filter for the assignee field (optional)
dimension = "3d" # str | A simple equality filter for the dimension 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: ['project_name', 'name', 'owner', 'status', 'assignee', 'subset', 'mode', 'dimension', 'tracker_link', 'validation_mode', 'id', 'project_id', 'updated_date']. There are few examples for complex filtering tasks: - Get all tasks from 1,2,3 projects - { \"and\" : [{ \"in\" : [{ \"var\" : \"project_id\" }, [1, 2, 3]]}]} - Get all completed tasks from 1 project - { \"and\": [{ \"==\": [{ \"var\" : \"status\" }, \"completed\"]}, { \"==\" : [{ \"var\" : \"project_id\"}, 1]}]} (optional)
mode = "mode_example" # str | A simple equality filter for the mode field (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)
project_id = 1 # int | A simple equality filter for the project_id field (optional)
project_name = "project_name_example" # str | A simple equality filter for the project_name field (optional)
search = "search_example" # str | A search term. Available search_fields: ('project_name', 'name', 'owner', 'status', 'assignee', 'subset', 'mode', 'dimension', 'tracker_link', 'validation_mode') (optional)
sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['project_name', 'name', 'owner', 'status', 'assignee', 'subset', 'mode', 'dimension', 'tracker_link', 'validation_mode', 'id', 'project_id', 'updated_date'] (optional)
status = "annotation" # str | A simple equality filter for the status field (optional)
subset = "subset_example" # str | A simple equality filter for the subset field (optional)
tracker_link = "tracker_link_example" # str | A simple equality filter for the tracker_link field (optional)
validation_mode = "gt" # str | A simple equality filter for the validation_mode field (optional)
try:
(data, response) = api_client.tasks_api.list(
x_organization=x_organization,
assignee=assignee,
dimension=dimension,
filter=filter,
mode=mode,
name=name,
org=org,
org_id=org_id,
owner=owner,
page=page,
page_size=page_size,
project_id=project_id,
project_name=project_name,
search=search,
sort=sort,
status=status,
subset=subset,
tracker_link=tracker_link,
validation_mode=validation_mode,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.list(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
assignee |
str |
A simple equality filter for the assignee field |
[optional] |
dimension |
str |
A simple equality filter for the dimension field |
[optional] |
filter |
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"},""]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [‘project_name’, ’name’, ‘owner’, ‘status’, ‘assignee’, ‘subset’, ‘mode’, ‘dimension’, ’tracker_link’, ‘validation_mode’, ‘id’, ‘project_id’, ‘updated_date’]. There are few examples for complex filtering tasks: - Get all tasks from 1,2,3 projects - { "and" : [{ "in" : [{ "var" : "project_id" }, [1, 2, 3]]}]} - Get all completed tasks from 1 project - { "and": [{ "==": [{ "var" : "status" }, "completed"]}, { "==" : [{ "var" : "project_id"}, 1]}]} |
[optional] |
mode |
str |
A simple equality filter for the mode field |
[optional] |
name |
str |
A simple equality filter for the name field |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
owner |
str |
A simple equality filter for the owner field |
[optional] |
page |
int |
A page number within the paginated result set. |
[optional] |
page_size |
int |
Number of results to return per page. |
[optional] |
project_id |
int |
A simple equality filter for the project_id field |
[optional] |
project_name |
str |
A simple equality filter for the project_name field |
[optional] |
search |
str |
A search term. Available search_fields: (‘project_name’, ’name’, ‘owner’, ‘status’, ‘assignee’, ‘subset’, ‘mode’, ‘dimension’, ’tracker_link’, ‘validation_mode’) |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [‘project_name’, ’name’, ‘owner’, ‘status’, ‘assignee’, ‘subset’, ‘mode’, ‘dimension’, ’tracker_link’, ‘validation_mode’, ‘id’, ‘project_id’, ‘updated_date’] |
[optional] |
status |
str |
A simple equality filter for the status field |
[optional] |
subset |
str |
A simple equality filter for the subset field |
[optional] |
tracker_link |
str |
A simple equality filter for the tracker_link field |
[optional] |
validation_mode |
str |
A simple equality filter for the validation_mode field |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedTaskReadList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update
partial_update(
id,
patched_task_write_request=None,
**kwargs
)
Update a task
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 task.
patched_task_write_request = PatchedTaskWriteRequest(
name="name_example",
project_id=1,
owner_id=1,
assignee_id=1,
bug_tracker="bug_tracker_example",
labels=[
PatchedLabelRequest(
id=1,
name="name_example",
color="color_example",
attributes=[
AttributeRequest(
id=1,
name="name_example",
mutable=True,
input_type=InputTypeEnum("checkbox"),
default_value="default_value_example",
values=[
"values_example",
],
),
],
deleted=True,
type="type_example",
svg="svg_example",
sublabels=[
SublabelRequest(
id=1,
name="name_example",
color="color_example",
attributes=[
AttributeRequest(
id=1,
name="name_example",
mutable=True,
input_type=InputTypeEnum("checkbox"),
default_value="default_value_example",
values=[
"values_example",
],
),
],
type="type_example",
has_parent=True,
),
],
),
],
subset="subset_example",
target_storage=PatchedTaskWriteRequestTargetStorage(None),
source_storage=PatchedTaskWriteRequestTargetStorage(None),
) # PatchedTaskWriteRequest | (optional)
try:
(data, response) = api_client.tasks_api.partial_update(
id,
patched_task_write_request=patched_task_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.partial_update(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
patched_task_write_request |
PatchedTaskWriteRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[TaskRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update_annotations
partial_update_annotations(
action,
id,
patched_labeled_data_request=None,
**kwargs
)
Update task annotations
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:
action = "create" # str |
id = 1 # int | A unique integer value identifying this task.
patched_labeled_data_request = PatchedLabeledDataRequest(
version=0,
tags=[
LabeledImageRequest(
id=1,
frame=0,
label_id=0,
group=0,
source="manual",
attributes=[
AttributeValRequest(
spec_id=1,
value="value_example",
),
],
),
],
shapes=[
LabeledShapeRequest(
type=ShapeType("rectangle"),
occluded=False,
outside=False,
z_order=0,
rotation=0.0,
points=[
3.14,
],
id=1,
frame=0,
label_id=0,
group=0,
source="manual",
attributes=[
AttributeValRequest(
spec_id=1,
value="value_example",
),
],
elements=[
SubLabeledShapeRequest(
type=ShapeType("rectangle"),
occluded=False,
outside=False,
z_order=0,
rotation=0.0,
points=[
3.14,
],
id=1,
frame=0,
label_id=0,
group=0,
source="manual",
attributes=[
AttributeValRequest(
spec_id=1,
value="value_example",
),
],
),
],
),
],
tracks=[
LabeledTrackRequest(
id=1,
frame=0,
label_id=0,
group=0,
source="manual",
shapes=[
TrackedShapeRequest(
type=ShapeType("rectangle"),
occluded=False,
outside=False,
z_order=0,
rotation=0.0,
points=[
3.14,
],
id=1,
frame=0,
attributes=[
AttributeValRequest(
spec_id=1,
value="value_example",
),
],
),
],
attributes=[
AttributeValRequest(
spec_id=1,
value="value_example",
),
],
elements=[
SubLabeledTrackRequest(
id=1,
frame=0,
label_id=0,
group=0,
source="manual",
shapes=[
TrackedShapeRequest(
type=ShapeType("rectangle"),
occluded=False,
outside=False,
z_order=0,
rotation=0.0,
points=[
3.14,
],
id=1,
frame=0,
attributes=[
AttributeValRequest(
spec_id=1,
value="value_example",
),
],
),
],
attributes=[
AttributeValRequest(
spec_id=1,
value="value_example",
),
],
),
],
),
],
) # PatchedLabeledDataRequest | (optional)
try:
(data, response) = api_client.tasks_api.partial_update_annotations(
action,
id,
patched_labeled_data_request=patched_labeled_data_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.partial_update_annotations(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
action |
str |
|
|
id |
int |
A unique integer value identifying this task. |
|
patched_labeled_data_request |
PatchedLabeledDataRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[LabeledData, 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
- Content-Type: application/json, multipart/form-data
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update_data_meta(
id,
patched_data_meta_write_request=None,
**kwargs
)
Update metainformation for media files in a task
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 task.
patched_data_meta_write_request = PatchedDataMetaWriteRequest(
deleted_frames=[
0,
],
) # PatchedDataMetaWriteRequest | (optional)
try:
(data, response) = api_client.tasks_api.partial_update_data_meta(
id,
patched_data_meta_write_request=patched_data_meta_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.partial_update_data_meta(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
patched_data_meta_write_request |
PatchedDataMetaWriteRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[DataMetaRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update_validation_layout
partial_update_validation_layout(
id,
patched_task_validation_layout_write_request=None,
**kwargs
)
Allows updating current validation configuration
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 task.
patched_task_validation_layout_write_request = PatchedTaskValidationLayoutWriteRequest(
disabled_frames=[
0,
],
frame_selection_method=None,
honeypot_real_frames=[
0,
],
) # PatchedTaskValidationLayoutWriteRequest | (optional)
try:
(data, response) = api_client.tasks_api.partial_update_validation_layout(
id,
patched_task_validation_layout_write_request=patched_task_validation_layout_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.partial_update_validation_layout(): %s\n" % e)
Parameters
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[TaskValidationLayoutRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve
retrieve(
id,
**kwargs
)
Get task 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 task.
try:
(data, response) = api_client.tasks_api.retrieve(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.retrieve(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[TaskRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_annotations
retrieve_annotations(
id,
action=None,
cloud_storage_id=None,
filename=None,
format=None,
location=None,
use_default_location=None,
**kwargs
)
Get task annotations or export them as a dataset in a specific format
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
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 task.
action = "download" # str | Used to start downloading process locally after annotation file has been created (optional) if omitted the server will use the default value of "download"
cloud_storage_id = 1 # int | 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 dataset (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
try:
(data, response) = api_client.tasks_api.retrieve_annotations(
id,
action=action,
cloud_storage_id=cloud_storage_id,
filename=filename,
format=format,
location=location,
use_default_location=use_default_location,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.retrieve_annotations(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
action |
str |
Used to start downloading process locally after annotation file has been created |
[optional] if omitted the server will use the default value of “download” |
cloud_storage_id |
int |
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 dataset |
[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 |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[AnnotationsRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
Download of file started |
- |
201 |
Annotations file is ready to download |
- |
202 |
Dump of annotations has been started |
- |
400 |
Exporting without data is not allowed |
- |
405 |
Format is not available |
- |
retrieve_backup
retrieve_backup(
id,
action=None,
cloud_storage_id=None,
filename=None,
location=None,
use_default_location=None,
**kwargs
)
Back up a task
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’
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 task.
action = "download" # str | Used to start downloading process after backup file had been created (optional) if omitted the server will use the default value of "download"
cloud_storage_id = 1 # int | Storage id (optional)
filename = "filename_example" # str | Backup file name (optional)
location = "cloud_storage" # str | Where need to save downloaded backup (optional)
use_default_location = True # bool | Use the location that was configured in the task to export backup (optional) if omitted the server will use the default value of True
try:
api_client.tasks_api.retrieve_backup(
id,
action=action,
cloud_storage_id=cloud_storage_id,
filename=filename,
location=location,
use_default_location=use_default_location,
)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.retrieve_backup(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
action |
str |
Used to start downloading process after backup file had been created |
[optional] if omitted the server will use the default value of “download” |
cloud_storage_id |
int |
Storage id |
[optional] |
filename |
str |
Backup file name |
[optional] |
location |
str |
Where need to save downloaded backup |
[optional] |
use_default_location |
bool |
Use the location that was configured in the task to export backup |
[optional] if omitted the server will use the default value of True |
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
Download of file started |
- |
201 |
Output backup file is ready for downloading |
- |
202 |
Creating a backup file has been started |
- |
400 |
Backup of a task without data is not allowed |
- |
retrieve_data
retrieve_data(
id,
number=None,
quality=None,
type=None,
**kwargs
)
Get data of a task
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 task.
number = 1 # int | A unique number value identifying chunk or frame (optional)
quality = "compressed" # str | Specifies the quality level of the requested data (optional)
type = "chunk" # str | Specifies the type of the requested data (optional)
try:
api_client.tasks_api.retrieve_data(
id,
number=number,
quality=quality,
type=type,
)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.retrieve_data(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
number |
int |
A unique number value identifying chunk or frame |
[optional] |
quality |
str |
Specifies the quality level of the requested data |
[optional] |
type |
str |
Specifies the type of the requested data |
[optional] |
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
Data of a specific type |
* X-Checksum - Data checksum, applicable for chunks only * X-Updated-Date - Data update date, applicable for chunks only
|
retrieve_data_meta(
id,
**kwargs
)
Get metainformation for media files in a task
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 task.
try:
(data, response) = api_client.tasks_api.retrieve_data_meta(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.retrieve_data_meta(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[DataMetaRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_dataset
retrieve_dataset(
format,
id,
action=None,
cloud_storage_id=None,
filename=None,
location=None,
use_default_location=None,
**kwargs
)
Export task as a dataset in a specific format
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
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:
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 task.
action = "download" # str | Used to start downloading process locally after annotation file has been created (optional) if omitted the server will use the default value of "download"
cloud_storage_id = 1 # int | Storage id (optional)
filename = "filename_example" # str | Desired output file name (optional)
location = "cloud_storage" # str | Where need to save downloaded dataset (optional)
use_default_location = True # bool | Use the location that was configured in task to export annotations (optional) if omitted the server will use the default value of True
try:
(data, response) = api_client.tasks_api.retrieve_dataset(
format,
id,
action=action,
cloud_storage_id=cloud_storage_id,
filename=filename,
location=location,
use_default_location=use_default_location,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.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 task. |
|
action |
str |
Used to start downloading process locally after annotation file has been created |
[optional] if omitted the server will use the default value of “download” |
cloud_storage_id |
int |
Storage id |
[optional] |
filename |
str |
Desired output file name |
[optional] |
location |
str |
Where need to save downloaded dataset |
[optional] |
use_default_location |
bool |
Use the location that was configured in task to export annotations |
[optional] if omitted the server will use the default value of True |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[file_type, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
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 |
- |
400 |
Exporting without data is not allowed |
- |
405 |
Format is not available |
- |
retrieve_preview
retrieve_preview(
id,
**kwargs
)
Get a preview image for a task
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 task.
try:
api_client.tasks_api.retrieve_preview(
id,)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.retrieve_preview(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
Task image preview |
- |
404 |
Task image preview not found |
- |
retrieve_status
retrieve_status(
id,
**kwargs
)
Get the creation status of a task
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>
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 task.
try:
(data, response) = api_client.tasks_api.retrieve_status(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.retrieve_status(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[RqStatus, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_validation_layout
retrieve_validation_layout(
id,
**kwargs
)
Allows getting current validation configuration
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 task.
try:
(data, response) = api_client.tasks_api.retrieve_validation_layout(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.retrieve_validation_layout(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[TaskValidationLayoutRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
update_annotations
update_annotations(
id,
format=None,
rq_id=None,
task_annotations_update_request=None,
**kwargs
)
Replace task annotations / Get annotation import status
To check the status of an import request: After initiating the annotation import, you will receive an rq_id parameter. Make sure to include this parameter as a query parameter in your subsequent PUT /api/tasks/id/annotations requests to track the status of the import.
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 task.
format = "format_example" # str | Input format name You can get the list of supported formats at: /server/annotation/formats (optional)
rq_id = "rq_id_example" # str | rq id (optional)
task_annotations_update_request = TaskAnnotationsUpdateRequest(None) # TaskAnnotationsUpdateRequest | (optional)
try:
api_client.tasks_api.update_annotations(
id,
format=format,
rq_id=rq_id,
task_annotations_update_request=task_annotations_update_request,
)
except exceptions.ApiException as e:
print("Exception when calling TasksApi.update_annotations(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this task. |
|
format |
str |
Input format name You can get the list of supported formats at: /server/annotation/formats |
[optional] |
rq_id |
str |
rq id |
[optional] |
task_annotations_update_request |
TaskAnnotationsUpdateRequest |
|
[optional] |
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
- Content-Type: application/json, multipart/form-data
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
201 |
Import has finished |
- |
202 |
Import is in progress |
- |
405 |
Format is not available |
- |
21 - UsersApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
destroy |
DELETE /api/users/{id} |
Delete a user |
list |
GET /api/users |
List users |
partial_update |
PATCH /api/users/{id} |
Update a user |
retrieve |
GET /api/users/{id} |
Get user details |
retrieve_self |
GET /api/users/self |
Get details of the current user |
destroy
destroy(
id,
**kwargs
)
Delete a user
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 user.
try:
api_client.users_api.destroy(
id,)
except exceptions.ApiException as e:
print("Exception when calling UsersApi.destroy(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this user. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The user has been deleted |
- |
list
list(
x_organization=None,
filter=None,
first_name=None,
is_active=None,
last_name=None,
org=None,
org_id=None,
page=None,
page_size=None,
search=None,
sort=None,
username=None,
**kwargs
)
List users
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: ['username', 'first_name', 'last_name', 'id', 'is_active']. (optional)
first_name = "first_name_example" # str | A simple equality filter for the first_name field (optional)
is_active = True # bool | A simple equality filter for the is_active field (optional)
last_name = "last_name_example" # str | A simple equality filter for the last_name field (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. Available search_fields: ('username', 'first_name', 'last_name') (optional)
sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['username', 'first_name', 'last_name', 'id', 'is_active'] (optional)
username = "username_example" # str | A simple equality filter for the username field (optional)
try:
(data, response) = api_client.users_api.list(
x_organization=x_organization,
filter=filter,
first_name=first_name,
is_active=is_active,
last_name=last_name,
org=org,
org_id=org_id,
page=page,
page_size=page_size,
search=search,
sort=sort,
username=username,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling UsersApi.list(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
filter |
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"},""]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [‘username’, ‘first_name’, ’last_name’, ‘id’, ‘is_active’]. |
[optional] |
first_name |
str |
A simple equality filter for the first_name field |
[optional] |
is_active |
bool |
A simple equality filter for the is_active field |
[optional] |
last_name |
str |
A simple equality filter for the last_name field |
[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. Available search_fields: (‘username’, ‘first_name’, ’last_name’) |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [‘username’, ‘first_name’, ’last_name’, ‘id’, ‘is_active’] |
[optional] |
username |
str |
A simple equality filter for the username field |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedMetaUserList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update
partial_update(
id,
patched_user_request=None,
**kwargs
)
Update a user
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 user.
patched_user_request = PatchedUserRequest(
username="A",
first_name="first_name_example",
last_name="last_name_example",
email="email_example",
groups=[
"groups_example",
],
is_staff=True,
is_superuser=True,
is_active=True,
) # PatchedUserRequest | (optional)
try:
(data, response) = api_client.users_api.partial_update(
id,
patched_user_request=patched_user_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling UsersApi.partial_update(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this user. |
|
patched_user_request |
PatchedUserRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[MetaUser, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve
retrieve(
id,
**kwargs
)
Get user 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 user.
try:
(data, response) = api_client.users_api.retrieve(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling UsersApi.retrieve(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this user. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[MetaUser, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_self
retrieve_self(
**kwargs
)
Get details of the current user
Method returns an instance of a user who is currently authenticated
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.users_api.retrieve_self()
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling UsersApi.retrieve_self(): %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[MetaUser, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
22 - WebhooksApi class reference
All URIs are relative to http://localhost
Method |
HTTP request |
Description |
create |
POST /api/webhooks |
Create a webhook |
create_deliveries_redelivery |
POST /api/webhooks/{id}/deliveries/{delivery_id}/redelivery |
Redeliver a webhook delivery |
create_ping |
POST /api/webhooks/{id}/ping |
Send a ping webhook |
destroy |
DELETE /api/webhooks/{id} |
Delete a webhook |
list |
GET /api/webhooks |
List webhooks |
list_deliveries |
GET /api/webhooks/{id}/deliveries |
List deliveries for a webhook |
partial_update |
PATCH /api/webhooks/{id} |
Update a webhook |
retrieve |
GET /api/webhooks/{id} |
Get webhook details |
retrieve_deliveries |
GET /api/webhooks/{id}/deliveries/{delivery_id} |
Get details of a webhook delivery |
retrieve_events |
GET /api/webhooks/events |
List available webhook events |
update |
PUT /api/webhooks/{id} |
Replace a webhook |
create
create(
webhook_write_request,
x_organization=None,
org=None,
org_id=None,
**kwargs
)
Create a webhook
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:
webhook_write_request = WebhookWriteRequest(
target_url="target_url_example",
description="description_example",
type=WebhookType("organization"),
content_type=WebhookContentType("application/json"),
secret="secret_example",
is_active=True,
enable_ssl=True,
project_id=1,
events=[
EventsEnum("create:comment"),
],
) # WebhookWriteRequest |
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.webhooks_api.create(
webhook_write_request,
x_organization=x_organization,
org=org,
org_id=org_id,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling WebhooksApi.create(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
webhook_write_request |
WebhookWriteRequest |
|
|
x_organization |
str |
Organization unique slug |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[WebhookRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
201 |
|
- |
create_deliveries_redelivery
create_deliveries_redelivery(
delivery_id,
id,
**kwargs
)
Redeliver a webhook delivery
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:
delivery_id = "4" # str |
id = 1 # int | A unique integer value identifying this webhook.
try:
api_client.webhooks_api.create_deliveries_redelivery(
delivery_id,
id,)
except exceptions.ApiException as e:
print("Exception when calling WebhooksApi.create_deliveries_redelivery(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
delivery_id |
str |
|
|
id |
int |
A unique integer value identifying this webhook. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
200 |
No response body |
- |
create_ping
create_ping(
id,
**kwargs
)
Send a ping webhook
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 webhook.
try:
(data, response) = api_client.webhooks_api.create_ping(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling WebhooksApi.create_ping(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this webhook. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[WebhookDeliveryRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
destroy
destroy(
id,
**kwargs
)
Delete a webhook
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 webhook.
try:
api_client.webhooks_api.destroy(
id,)
except exceptions.ApiException as e:
print("Exception when calling WebhooksApi.destroy(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this webhook. |
|
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
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code |
Description |
Response headers |
204 |
The webhook has been deleted |
- |
list
list(
x_organization=None,
filter=None,
org=None,
org_id=None,
owner=None,
page=None,
page_size=None,
project_id=None,
search=None,
sort=None,
target_url=None,
type=None,
**kwargs
)
List webhooks
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: ['target_url', 'owner', 'type', 'description', 'id', 'project_id', 'updated_date']. (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)
project_id = 1 # int | A simple equality filter for the project_id field (optional)
search = "search_example" # str | A search term. Available search_fields: ('target_url', 'owner', 'type', 'description') (optional)
sort = "sort_example" # str | Which field to use when ordering the results. Available ordering_fields: ['target_url', 'owner', 'type', 'description', 'id', 'project_id', 'updated_date'] (optional)
target_url = "target_url_example" # str | A simple equality filter for the target_url field (optional)
type = "organization" # str | A simple equality filter for the type field (optional)
try:
(data, response) = api_client.webhooks_api.list(
x_organization=x_organization,
filter=filter,
org=org,
org_id=org_id,
owner=owner,
page=page,
page_size=page_size,
project_id=project_id,
search=search,
sort=sort,
target_url=target_url,
type=type,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling WebhooksApi.list(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
x_organization |
str |
Organization unique slug |
[optional] |
filter |
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"},""]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [’target_url’, ‘owner’, ’type’, ‘description’, ‘id’, ‘project_id’, ‘updated_date’]. |
[optional] |
org |
str |
Organization unique slug |
[optional] |
org_id |
int |
Organization identifier |
[optional] |
owner |
str |
A simple equality filter for the owner field |
[optional] |
page |
int |
A page number within the paginated result set. |
[optional] |
page_size |
int |
Number of results to return per page. |
[optional] |
project_id |
int |
A simple equality filter for the project_id field |
[optional] |
search |
str |
A search term. Available search_fields: (’target_url’, ‘owner’, ’type’, ‘description’) |
[optional] |
sort |
str |
Which field to use when ordering the results. Available ordering_fields: [’target_url’, ‘owner’, ’type’, ‘description’, ‘id’, ‘project_id’, ‘updated_date’] |
[optional] |
target_url |
str |
A simple equality filter for the target_url field |
[optional] |
type |
str |
A simple equality filter for the type field |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedWebhookReadList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
list_deliveries
list_deliveries(
id,
page=None,
page_size=None,
**kwargs
)
List deliveries for a webhook
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 webhook.
page = 1 # int | A page number within the paginated result set. (optional)
page_size = 1 # int | Number of results to return per page. (optional)
try:
(data, response) = api_client.webhooks_api.list_deliveries(
id,
page=page,
page_size=page_size,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling WebhooksApi.list_deliveries(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this webhook. |
|
page |
int |
A page number within the paginated result set. |
[optional] |
page_size |
int |
Number of results to return per page. |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[PaginatedWebhookDeliveryReadList, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
partial_update
partial_update(
id,
patched_webhook_write_request=None,
**kwargs
)
Update a webhook
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 webhook.
patched_webhook_write_request = PatchedWebhookWriteRequest(
target_url="target_url_example",
description="description_example",
content_type=WebhookContentType("application/json"),
secret="secret_example",
is_active=True,
enable_ssl=True,
events=[
EventsEnum("create:comment"),
],
) # PatchedWebhookWriteRequest | (optional)
try:
(data, response) = api_client.webhooks_api.partial_update(
id,
patched_webhook_write_request=patched_webhook_write_request,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling WebhooksApi.partial_update(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this webhook. |
|
patched_webhook_write_request |
PatchedWebhookWriteRequest |
|
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[WebhookRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve
retrieve(
id,
**kwargs
)
Get webhook 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 webhook.
try:
(data, response) = api_client.webhooks_api.retrieve(
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling WebhooksApi.retrieve(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this webhook. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[WebhookRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_deliveries
retrieve_deliveries(
delivery_id,
id,
**kwargs
)
Get details of a webhook delivery
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:
delivery_id = "4" # str |
id = 1 # int | A unique integer value identifying this webhook.
try:
(data, response) = api_client.webhooks_api.retrieve_deliveries(
delivery_id,
id,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling WebhooksApi.retrieve_deliveries(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
delivery_id |
str |
|
|
id |
int |
A unique integer value identifying this webhook. |
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[WebhookDeliveryRead, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
retrieve_events
retrieve_events(
type=None,
**kwargs
)
List available webhook events
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:
type = "type_example" # str | Type of webhook (optional)
try:
(data, response) = api_client.webhooks_api.retrieve_events(
type=type,
)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling WebhooksApi.retrieve_events(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
type |
str |
Type of webhook |
[optional] |
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[Events, 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
- Content-Type: Not defined
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |
update
update(
id,
webhook_write_request,
**kwargs
)
Replace a webhook
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 webhook.
webhook_write_request = WebhookWriteRequest(
target_url="target_url_example",
description="description_example",
type=WebhookType("organization"),
content_type=WebhookContentType("application/json"),
secret="secret_example",
is_active=True,
enable_ssl=True,
project_id=1,
events=[
EventsEnum("create:comment"),
],
) # WebhookWriteRequest |
try:
(data, response) = api_client.webhooks_api.update(
id,
webhook_write_request,)
pprint(data)
except exceptions.ApiException as e:
print("Exception when calling WebhooksApi.update(): %s\n" % e)
Parameters
Name |
Type |
Description |
Notes |
id |
int |
A unique integer value identifying this webhook. |
|
webhook_write_request |
WebhookWriteRequest |
|
|
There are also optional kwargs that control the function invocation behavior.
Read more here.
Returned values
Returned type: Tuple[WebhookRead, 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
- Content-Type: application/json
- Accept: application/vnd.cvat+json
HTTP response details
Status code |
Description |
Response headers |
200 |
|
- |