This the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Models

1 - About class reference

Properties

Name Type Description Notes
name str
description str
version str

2 - AcceptInvitationRead class reference

Properties

Name Type Description Notes
organization_slug str

3 - AnalyticsReport class reference

Properties

Name Type Description Notes
created_date datetime
target AnalyticsReportTargetEnum
statistics [Metric]
job_id int [optional]
task_id int [optional]
project_id int [optional]

4 - AnalyticsReportCreateRequest class reference

Properties

Name Type Description Notes
job_id int [optional]
task_id int [optional]
project_id int [optional]

5 - AnalyticsReportTargetEnum class reference

  • `job` - JOB * `task` - TASK * `project` - PROJECT

Properties

Name Type Description Notes
value str * job - JOB * task - TASK * project - PROJECT must be one of [“job”, “task”, “project”, ]

6 - AnnotationConflict class reference

Properties

Name Type Description Notes
annotation_ids [AnnotationId]
id int [optional] [readonly]
frame int [optional] [readonly]
type bool, date, datetime, dict, float, int, list, str, none_type [optional] [readonly]
report_id int [optional] [readonly]
severity bool, date, datetime, dict, float, int, list, str, none_type [optional] [readonly]

7 - AnnotationConflictTypeEnum class reference

  • `missing_annotation` - MISSING_ANNOTATION * `extra_annotation` - EXTRA_ANNOTATION * `mismatching_label` - MISMATCHING_LABEL * `low_overlap` - LOW_OVERLAP * `mismatching_direction` - MISMATCHING_DIRECTION * `mismatching_attributes` - MISMATCHING_ATTRIBUTES * `mismatching_groups` - MISMATCHING_GROUPS * `covered_annotation` - COVERED_ANNOTATION

Properties

Name Type Description Notes
value str * missing_annotation - MISSING_ANNOTATION * extra_annotation - EXTRA_ANNOTATION * mismatching_label - MISMATCHING_LABEL * low_overlap - LOW_OVERLAP * mismatching_direction - MISMATCHING_DIRECTION * mismatching_attributes - MISMATCHING_ATTRIBUTES * mismatching_groups - MISMATCHING_GROUPS * covered_annotation - COVERED_ANNOTATION must be one of [“missing_annotation”, “extra_annotation”, “mismatching_label”, “low_overlap”, “mismatching_direction”, “mismatching_attributes”, “mismatching_groups”, “covered_annotation”, ]

8 - AnnotationFileRequest class reference

Properties

Name Type Description Notes
annotation_file file_type

9 - AnnotationGuideRead class reference

Properties

Name Type Description Notes
id int [optional] [readonly]
task_id int, none_type [optional] [readonly]
project_id int, none_type [optional] [readonly]
created_date datetime [optional] [readonly]
updated_date datetime [optional] [readonly]
markdown str [optional] [readonly]

10 - AnnotationGuideWriteRequest class reference

Properties

Name Type Description Notes
task_id int, none_type [optional]
project_id int, none_type [optional]
markdown str [optional]

11 - AnnotationId class reference

Properties

Name Type Description Notes
obj_id int [optional] [readonly]
job_id int [optional] [readonly]
type bool, date, datetime, dict, float, int, list, str, none_type [optional] [readonly]
shape_type AnnotationIdShapeType [optional]

12 - AnnotationIdShapeType class reference

Properties

Name Type Description Notes

13 - AnnotationIdTypeEnum class reference

  • `tag` - TAG * `shape` - SHAPE * `track` - TRACK

Properties

Name Type Description Notes
value str * tag - TAG * shape - SHAPE * track - TRACK must be one of [“tag”, “shape”, “track”, ]

14 - AnnotationsRead class reference

Properties

Name Type Description Notes
version int [optional] if omitted the server will use the default value of 0
tags [LabeledImage] [optional] if omitted the server will use the default value of []
shapes [LabeledShape] [optional] if omitted the server will use the default value of []
tracks [LabeledTrack] [optional] if omitted the server will use the default value of []

15 - AssetRead class reference

Properties

Name Type Description Notes
filename str
uuid str [optional] [readonly]
created_date datetime [optional] [readonly]
owner BasicUser [optional]
guide_id int [optional] [readonly]

16 - Attribute class reference

Properties

Name Type Description Notes
name str
mutable bool
input_type InputTypeEnum
values [str]
id int [optional] [readonly]
default_value str [optional]

17 - AttributeRequest class reference

Properties

Name Type Description Notes
name str
mutable bool
input_type InputTypeEnum
values [str]
default_value str [optional]

18 - AttributeVal class reference

Properties

Name Type Description Notes
spec_id int
value str

19 - AttributeValRequest class reference

Properties

Name Type Description Notes
spec_id int
value str

20 - BackupWriteRequest class reference

Properties

Name Type Description Notes
project_file file_type [optional]

21 - BasicOrganization class reference

Properties

Name Type Description Notes
id int [optional] [readonly]
slug str [optional] [readonly]

22 - BasicUser class reference

Properties

Name Type Description Notes
username str Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
url str [optional] [readonly]
id int [optional] [readonly]
first_name str [optional]
last_name str [optional]

23 - BasicUserRequest class reference

Properties

Name Type Description Notes
username str Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
first_name str [optional]
last_name str [optional]

24 - BinaryOperation class reference

Properties

Name Type Description Notes
operator OperatorEnum
left str, none_type The name of the data series used as the left (first) operand of the binary operation. [optional]
right str, none_type The name of the data series used as the right (second) operand of the binary operation. [optional]

25 - ChunkType class reference

  • `video` - VIDEO * `imageset` - IMAGESET * `list` - LIST

Properties

Name Type Description Notes
value str * video - VIDEO * imageset - IMAGESET * list - LIST must be one of [“video”, “imageset”, “list”, ]

26 - ClientEvents class reference

Properties

Name Type Description Notes
timestamp datetime
events [Event] [optional] if omitted the server will use the default value of []

27 - ClientEventsRequest class reference

Properties

Name Type Description Notes
timestamp datetime
events [EventRequest] [optional] if omitted the server will use the default value of []
previous_event ClientEventsRequestPreviousEvent [optional]

28 - ClientEventsRequestPreviousEvent class reference

Properties

Name Type Description Notes
scope str
timestamp datetime
obj_name str, none_type [optional]
obj_id int, none_type [optional]
obj_val str, none_type [optional]
source str, none_type [optional]
count int, none_type [optional]
duration int [optional] if omitted the server will use the default value of 0
project_id int, none_type [optional]
task_id int, none_type [optional]
job_id int, none_type [optional]
user_id int, none_type [optional]
user_name str, none_type [optional]
user_email str, none_type [optional]
org_id int, none_type [optional]
org_slug str, none_type [optional]
payload str, none_type [optional]

29 - CloudStorageContent class reference

Properties

Name Type Description Notes
content [FileInfo]
next str, none_type This token is used to continue listing files in the bucket. [optional]

30 - CloudStorageRead class reference

Properties

Name Type Description Notes
provider_type ProviderTypeEnum
resource str
display_name str
credentials_type CredentialsTypeEnum
id int [optional] [readonly]
owner CloudStorageReadOwner [optional]
manifests [str] [optional] if omitted the server will use the default value of []
created_date datetime [optional] [readonly]
updated_date datetime [optional] [readonly]
specific_attributes str [optional]
description str [optional]
organization int, none_type [optional] [readonly]

31 - CloudStorageReadOwner class reference

Properties

Name Type Description Notes
username str Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
url str [optional] [readonly]
id int [optional] [readonly]
first_name str [optional]
last_name str [optional]

32 - CloudStorageWriteRequest class reference

Properties

Name Type Description Notes
provider_type ProviderTypeEnum
resource str
display_name str
credentials_type CredentialsTypeEnum
owner BasicUserRequest [optional]
session_token str [optional]
account_name str [optional]
key str [optional]
secret_key str [optional]
connection_string str [optional]
key_file file_type [optional]
specific_attributes str [optional]
description str [optional]
manifests [str] [optional] if omitted the server will use the default value of []

33 - CommentRead class reference

Properties

Name Type Description Notes
id int [optional] [readonly]
issue int [optional] [readonly]
owner CloudStorageReadOwner [optional]
message str [optional] [readonly]
created_date datetime [optional] [readonly]
updated_date datetime [optional] [readonly]

34 - CommentsSummary class reference

Properties

Name Type Description Notes
count int [optional] if omitted the server will use the default value of 0
url str [optional] [readonly]

35 - CommentWriteRequest class reference

Properties

Name Type Description Notes
issue int
message str [optional]

36 - CredentialsTypeEnum class reference

  • `KEY_SECRET_KEY_PAIR` - KEY_SECRET_KEY_PAIR * `ACCOUNT_NAME_TOKEN_PAIR` - ACCOUNT_NAME_TOKEN_PAIR * `KEY_FILE_PATH` - KEY_FILE_PATH * `ANONYMOUS_ACCESS` - ANONYMOUS_ACCESS * `CONNECTION_STRING` - CONNECTION_STRING

Properties

Name Type Description Notes
value str * KEY_SECRET_KEY_PAIR - KEY_SECRET_KEY_PAIR * ACCOUNT_NAME_TOKEN_PAIR - ACCOUNT_NAME_TOKEN_PAIR * KEY_FILE_PATH - KEY_FILE_PATH * ANONYMOUS_ACCESS - ANONYMOUS_ACCESS * CONNECTION_STRING - CONNECTION_STRING must be one of [“KEY_SECRET_KEY_PAIR”, “ACCOUNT_NAME_TOKEN_PAIR”, “KEY_FILE_PATH”, “ANONYMOUS_ACCESS”, “CONNECTION_STRING”, ]

37 - DataFrame class reference

Properties

Name Type Description Notes
value float
date date

38 - DataMetaRead class reference

Properties

Name Type Description Notes
image_quality int
frames [FrameMeta], none_type
deleted_frames [int]
chunk_size int, none_type [optional] [readonly]
size int The number of frames included. Deleted frames do not affect this value. [optional] [readonly]
start_frame int [optional] [readonly]
stop_frame int [optional] [readonly]
frame_filter str [optional] [readonly]
included_frames [int], none_type A list of valid frame ids. The None value means all frames are included. [optional]

39 - DataRequest class reference

Read more about parameters here: https://opencv.github.io/cvat/docs/manual/basics/create_an_annotation_task/#advanced-configuration

Properties

Name Type Description Notes
image_quality int Image quality to use during annotation
chunk_size int, none_type Maximum number of frames per chunk [optional]
size int The number of frames [optional]
start_frame int First frame index [optional]
stop_frame int Last frame index [optional]
frame_filter str Frame filter. The only supported syntax is: ‘step=N’ [optional]
compressed_chunk_type ChunkType [optional]
original_chunk_type ChunkType [optional]
client_files [file_type] Uploaded files. Must contain all files from job_file_mapping if job_file_mapping is not empty. [optional] if omitted the server will use the default value of []
server_files [str] Paths to files from a file share mounted on the server, or from a cloud storage. Must contain all files from job_file_mapping if job_file_mapping is not empty. [optional] if omitted the server will use the default value of []
remote_files [str] Direct download URLs for files. Must contain all files from job_file_mapping if job_file_mapping is not empty. [optional] if omitted the server will use the default value of []
use_zip_chunks bool When true, video chunks will be represented as zip archives with decoded video frames. When false, video chunks are represented as video segments [optional] if omitted the server will use the default value of False
server_files_exclude [str] Paths to files and directories from a file share mounted on the server, or from a cloud storage that should be excluded from the directories specified in server_files. This option cannot be used together with filename_pattern. The server_files_exclude parameter cannot be used to exclude a part of dataset from an archive. Examples: Exclude all files from subfolder ‘sub/sub_1/sub_2’and single file ‘sub/image.jpg’ from specified folder: server_files = [‘sub/'], server_files_exclude = [‘sub/sub_1/sub_2/’, ‘sub/image.jpg’] Exclude all cloud storage files with prefix ‘sub’ from the content of manifest file: server_files = [‘manifest.jsonl’], server_files_exclude = [‘sub/'] [optional] if omitted the server will use the default value of []
cloud_storage_id int, none_type If not null, the files referenced by server_files will be retrieved from the cloud storage with the specified ID. The cloud storages applicable depend on the context. In the user sandbox, only the user sandbox cloud storages can be used. In an organization, only the organization cloud storages can be used. [optional]
use_cache bool Enable or disable task data chunk caching for the task. Read more: https://opencv.github.io/cvat/docs/manual/advanced/data_on_fly/ [optional] if omitted the server will use the default value of False
copy_data bool Copy data from the server file share to CVAT during the task creation. This will create a copy of the data, making the server independent from the file share availability [optional] if omitted the server will use the default value of False
storage_method StorageMethod [optional]
storage StorageType [optional]
sorting_method SortingMethod [optional]
filename_pattern str, none_type A filename filter for cloud storage files listed in the manifest. Supports fnmatch wildcards. Read more: https://docs.python.org/3/library/fnmatch.html [optional]
job_file_mapping [[str]] Represents a file-to-job mapping. Useful to specify a custom job configuration during task creation. This option is not compatible with most other job split-related options. Files in the jobs must not overlap or repeat. Job file mapping files must be a subset of the input files. If directories are specified in server_files, all files obtained by recursive search in the specified directories will be used as input files. In case of missing items in the input files, an error will be raised. Example: [ ["file1.jpg", "file2.jpg"], # job #1 files ["file3.png"], # job #2 files ["file4.jpg", "file5.png", "file6.bmp"], # job #3 files ] [optional]
upload_file_order [str] Allows to specify file order for client_file uploads. Only valid with the "predefined" sorting method selected. To state that the input files are sent in the correct order, pass an empty list. If you want to send files in an arbitrary order and reorder them afterwards on the server, pass the list of file names in the required order. [optional]

40 - DatasetFileRequest class reference

Properties

Name Type Description Notes
dataset_file file_type

41 - DatasetFormat class reference

Properties

Name Type Description Notes
name str
ext str
version str
enabled bool
dimension str

42 - DatasetFormats class reference

Properties

Name Type Description Notes
importers [DatasetFormat]
exporters [DatasetFormat]

43 - DatasetWriteRequest class reference

Properties

Name Type Description Notes
dataset_file file_type [optional]

44 - DefaultViewEnum class reference

  • `numeric` - NUMERIC * `histogram` - HISTOGRAM

Properties

Name Type Description Notes
value str * numeric - NUMERIC * histogram - HISTOGRAM must be one of [“numeric”, “histogram”, ]

45 - Event class reference

Properties

Name Type Description Notes
scope str
timestamp datetime
obj_name str, none_type [optional]
obj_id int, none_type [optional]
obj_val str, none_type [optional]
source str, none_type [optional]
count int, none_type [optional]
duration int [optional] if omitted the server will use the default value of 0
project_id int, none_type [optional]
task_id int, none_type [optional]
job_id int, none_type [optional]
user_id int, none_type [optional]
user_name str, none_type [optional]
user_email str, none_type [optional]
org_id int, none_type [optional]
org_slug str, none_type [optional]
payload str, none_type [optional]

46 - EventRequest class reference

Properties

Name Type Description Notes
scope str
timestamp datetime
obj_name str, none_type [optional]
obj_id int, none_type [optional]
obj_val str, none_type [optional]
source str, none_type [optional]
count int, none_type [optional]
duration int [optional] if omitted the server will use the default value of 0
project_id int, none_type [optional]
task_id int, none_type [optional]
job_id int, none_type [optional]
user_id int, none_type [optional]
user_name str, none_type [optional]
user_email str, none_type [optional]
org_id int, none_type [optional]
org_slug str, none_type [optional]
payload str, none_type [optional]

47 - Events class reference

Properties

Name Type Description Notes
webhook_type WebhookType
events [EventsEnum]

48 - EventsEnum class reference

  • `create:comment` - CREATE:COMMENT * `create:invitation` - CREATE:INVITATION * `create:issue` - CREATE:ISSUE * `create:job` - CREATE:JOB * `create:membership` - CREATE:MEMBERSHIP * `create:project` - CREATE:PROJECT * `create:task` - CREATE:TASK * `delete:comment` - DELETE:COMMENT * `delete:invitation` - DELETE:INVITATION * `delete:issue` - DELETE:ISSUE * `delete:job` - DELETE:JOB * `delete:membership` - DELETE:MEMBERSHIP * `delete:organization` - DELETE:ORGANIZATION * `delete:project` - DELETE:PROJECT * `delete:task` - DELETE:TASK * `update:comment` - UPDATE:COMMENT * `update:issue` - UPDATE:ISSUE * `update:job` - UPDATE:JOB * `update:membership` - UPDATE:MEMBERSHIP * `update:organization` - UPDATE:ORGANIZATION * `update:project` - UPDATE:PROJECT * `update:task` - UPDATE:TASK

Properties

Name Type Description Notes
value str * create:comment - CREATE:COMMENT * create:invitation - CREATE:INVITATION * create:issue - CREATE:ISSUE * create:job - CREATE:JOB * create:membership - CREATE:MEMBERSHIP * create:project - CREATE:PROJECT * create:task - CREATE:TASK * delete:comment - DELETE:COMMENT * delete:invitation - DELETE:INVITATION * delete:issue - DELETE:ISSUE * delete:job - DELETE:JOB * delete:membership - DELETE:MEMBERSHIP * delete:organization - DELETE:ORGANIZATION * delete:project - DELETE:PROJECT * delete:task - DELETE:TASK * update:comment - UPDATE:COMMENT * update:issue - UPDATE:ISSUE * update:job - UPDATE:JOB * update:membership - UPDATE:MEMBERSHIP * update:organization - UPDATE:ORGANIZATION * update:project - UPDATE:PROJECT * update:task - UPDATE:TASK must be one of [“create:comment”, “create:invitation”, “create:issue”, “create:job”, “create:membership”, “create:project”, “create:task”, “delete:comment”, “delete:invitation”, “delete:issue”, “delete:job”, “delete:membership”, “delete:organization”, “delete:project”, “delete:task”, “update:comment”, “update:issue”, “update:job”, “update:membership”, “update:organization”, “update:project”, “update:task”, ]

49 - FileInfo class reference

Properties

Name Type Description Notes
name str
type FileInfoTypeEnum
mime_type str

50 - FileInfoTypeEnum class reference

  • `REG` - REG * `DIR` - DIR

Properties

Name Type Description Notes
value str * REG - REG * DIR - DIR must be one of [“REG”, “DIR”, ]

51 - FrameMeta class reference

Properties

Name Type Description Notes
width int
height int
name str
related_files int
has_related_context bool [optional] [readonly]

52 - FrameSelectionMethodEnum class reference

  • `random_uniform` - RANDOM_UNIFORM * `manual` - MANUAL

Properties

Name Type Description Notes
value str * random_uniform - RANDOM_UNIFORM * manual - MANUAL must be one of [“random_uniform”, “manual”, ]

53 - FunctionCall class reference

Properties

Name Type Description Notes
id str Request id
function FunctionCallParams
status str, none_type
enqueued datetime, none_type
started datetime, none_type
ended datetime, none_type
progress int, none_type [optional] if omitted the server will use the default value of 0
exc_info str, none_type [optional]

54 - FunctionCallParams class reference

Properties

Name Type Description Notes
id str, none_type The name of the function
task int, none_type The id of the task
threshold float, none_type
job int The id of the job [optional]

55 - FunctionCallRequest class reference

Properties

Name Type Description Notes
function str The name of the function to execute
task int The id of the task to be annotated
job int The id of the job to be annotated [optional]
quality bool, date, datetime, dict, float, int, list, str, none_type The quality of the images to use in the model run * compressed - compressed * original - original [optional]
max_distance int [optional]
threshold float [optional]
cleanup bool Whether existing annotations should be removed [optional] if omitted the server will use the default value of False
conv_mask_to_poly bool [optional] if omitted the server will use the default value of False
mapping {str: (LabelMappingEntryRequest,)} Label mapping from the model to the task labels [optional]

56 - GranularityEnum class reference

  • `day` - DAY * `week` - WEEK * `month` - MONTH

Properties

Name Type Description Notes
value str * day - DAY * week - WEEK * month - MONTH must be one of [“day”, “week”, “month”, ]

57 - InputTypeEnum class reference

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

Properties

Name Type Description Notes
value str * checkbox - CHECKBOX * radio - RADIO * number - NUMBER * text - TEXT * select - SELECT must be one of [“checkbox”, “radio”, “number”, “text”, “select”, ]

58 - InvitationRead class reference

Properties

Name Type Description Notes
owner CloudStorageReadOwner
role RoleEnum
user BasicUser
organization int
organization_info BasicOrganization
key str [optional] [readonly]
created_date datetime [optional] [readonly]
expired bool, none_type [optional] [readonly]

59 - InvitationWriteRequest class reference

Properties

Name Type Description Notes
role RoleEnum
email str

60 - IssueRead class reference

Properties

Name Type Description Notes
position [float]
comments CommentsSummary
id int [optional] [readonly]
frame int [optional] [readonly]
job int [optional] [readonly]
owner CloudStorageReadOwner [optional]
assignee CloudStorageReadOwner [optional]
created_date datetime, none_type [optional] [readonly]
updated_date datetime, none_type [optional] [readonly]
resolved bool [optional] [readonly]

61 - IssuesSummary class reference

Properties

Name Type Description Notes
url str [optional] [readonly]
count int [optional] [readonly]

62 - IssueWriteRequest class reference

Properties

Name Type Description Notes
frame int
position [float]
job int
message str
assignee int, none_type [optional]
resolved bool [optional]

63 - JobAnnotationsUpdateRequest class reference

Properties

Name Type Description Notes
version int [optional] if omitted the server will use the default value of 0
tags [LabeledImageRequest] [optional] if omitted the server will use the default value of []
shapes [LabeledShapeRequest] [optional] if omitted the server will use the default value of []
tracks [LabeledTrackRequest] [optional] if omitted the server will use the default value of []
annotation_file file_type [optional]

64 - JobRead class reference

Properties

Name Type Description Notes
issues IssuesSummary
labels LabelsSummary
url str [optional] [readonly]
id int [optional] [readonly]
task_id int [optional] [readonly]
project_id int, none_type [optional] [readonly]
assignee JobReadAssignee [optional]
guide_id int, none_type [optional] [readonly]
dimension str [optional] [readonly]
bug_tracker str, none_type [optional] [readonly]
status bool, date, datetime, dict, float, int, list, str, none_type [optional] [readonly]
stage bool, date, datetime, dict, float, int, list, str, none_type [optional] [readonly]
state bool, date, datetime, dict, float, int, list, str, none_type [optional] [readonly]
mode str [optional] [readonly]
frame_count int [optional] [readonly]
start_frame int [optional] [readonly]
stop_frame int [optional] [readonly]
data_chunk_size int, none_type [optional] [readonly]
data_compressed_chunk_type bool, date, datetime, dict, float, int, list, str, none_type [optional] [readonly]
created_date datetime [optional] [readonly]
updated_date datetime [optional] [readonly]
type bool, date, datetime, dict, float, int, list, str, none_type [optional] [readonly]
organization int, none_type [optional] [readonly]
target_storage JobReadTargetStorage [optional]
source_storage JobReadTargetStorage [optional]

65 - JobReadAssignee class reference

Properties

Name Type Description Notes
username str Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
url str [optional] [readonly]
id int [optional] [readonly]
first_name str [optional]
last_name str [optional]

66 - JobReadTargetStorage class reference

Properties

Name Type Description Notes
id int [optional] [readonly]
location LocationEnum [optional]
cloud_storage_id int, none_type [optional]

67 - JobsSummary class reference

Properties

Name Type Description Notes
completed int, none_type
validation int, none_type
count int [optional] if omitted the server will use the default value of 0
url str [optional] [readonly]

68 - JobStage class reference

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

Properties

Name Type Description Notes
value str * annotation - ANNOTATION * validation - VALIDATION * acceptance - ACCEPTANCE must be one of [“annotation”, “validation”, “acceptance”, ]

69 - JobStatus class reference

  • `annotation` - ANNOTATION * `validation` - VALIDATION * `completed` - COMPLETED

Properties

Name Type Description Notes
value str * annotation - ANNOTATION * validation - VALIDATION * completed - COMPLETED must be one of [“annotation”, “validation”, “completed”, ]

70 - JobType class reference

  • `annotation` - ANNOTATION * `ground_truth` - GROUND_TRUTH

Properties

Name Type Description Notes
value str * annotation - ANNOTATION * ground_truth - GROUND_TRUTH must be one of [“annotation”, “ground_truth”, ]

71 - JobWriteRequest class reference

Properties

Name Type Description Notes
type JobType
task_id int
assignee int, none_type [optional]
stage JobStage [optional]
state OperationStatus [optional]
frame_selection_method FrameSelectionMethodEnum [optional]
frame_count int The number of frames included in the job. Applicable only to the random frame selection [optional]
seed int The seed value for the random number generator. The same value will produce the same frame sets. Applicable only to the random frame selection. By default, a random value is used. [optional]
frames [int] The list of frame ids. Applicable only to the manual frame selection [optional]

72 - Label class reference

Properties

Name Type Description Notes
name str
id int [optional]
color str The hex value for the RGB color. Will be generated automatically, unless specified explicitly. [optional]
attributes [Attribute] The list of attributes. If you want to remove an attribute, you need to recreate the label and specify the remaining attributes. [optional] if omitted the server will use the default value of []
type str Associated annotation type for this label [optional]
svg str [optional]
sublabels [Sublabel] [optional]
project_id int, none_type [optional] [readonly]
task_id int, none_type [optional] [readonly]
parent_id int, none_type [optional] [readonly]
has_parent bool [optional] [readonly]

73 - LabeledData class reference

Properties

Name Type Description Notes
version int [optional] if omitted the server will use the default value of 0
tags [LabeledImage] [optional] if omitted the server will use the default value of []
shapes [LabeledShape] [optional] if omitted the server will use the default value of []
tracks [LabeledTrack] [optional] if omitted the server will use the default value of []

74 - LabeledDataRequest class reference

Properties

Name Type Description Notes
version int [optional] if omitted the server will use the default value of 0
tags [LabeledImageRequest] [optional] if omitted the server will use the default value of []
shapes [LabeledShapeRequest] [optional] if omitted the server will use the default value of []
tracks [LabeledTrackRequest] [optional] if omitted the server will use the default value of []

75 - LabeledImage class reference

Properties

Name Type Description Notes
frame int
label_id int
id int, none_type [optional]
group int, none_type [optional]
source str [optional] if omitted the server will use the default value of “manual”
attributes [AttributeVal] [optional] if omitted the server will use the default value of []

76 - LabeledImageRequest class reference

Properties

Name Type Description Notes
frame int
label_id int
id int, none_type [optional]
group int, none_type [optional]
source str [optional] if omitted the server will use the default value of “manual”
attributes [AttributeValRequest] [optional] if omitted the server will use the default value of []

77 - LabeledShape class reference

Properties

Name Type Description Notes
type ShapeType
frame int
label_id int
occluded bool [optional] if omitted the server will use the default value of False
outside bool [optional] if omitted the server will use the default value of False
z_order int [optional] if omitted the server will use the default value of 0
rotation float [optional] if omitted the server will use the default value of 0.0
points [float] [optional]
id int, none_type [optional]
group int, none_type [optional]
source str [optional] if omitted the server will use the default value of “manual”
attributes [AttributeVal] [optional] if omitted the server will use the default value of []
elements [SubLabeledShape] [optional]

78 - LabeledShapeRequest class reference

Properties

Name Type Description Notes
type ShapeType
frame int
label_id int
occluded bool [optional] if omitted the server will use the default value of False
outside bool [optional] if omitted the server will use the default value of False
z_order int [optional] if omitted the server will use the default value of 0
rotation float [optional] if omitted the server will use the default value of 0.0
points [float] [optional]
id int, none_type [optional]
group int, none_type [optional]
source str [optional] if omitted the server will use the default value of “manual”
attributes [AttributeValRequest] [optional] if omitted the server will use the default value of []
elements [SubLabeledShapeRequest] [optional]

79 - LabeledTrack class reference

Properties

Name Type Description Notes
frame int
label_id int
shapes [TrackedShape]
id int, none_type [optional]
group int, none_type [optional]
source str [optional] if omitted the server will use the default value of “manual”
attributes [AttributeVal] [optional] if omitted the server will use the default value of []
elements [SubLabeledTrack] [optional]

80 - LabeledTrackRequest class reference

Properties

Name Type Description Notes
frame int
label_id int
shapes [TrackedShapeRequest]
id int, none_type [optional]
group int, none_type [optional]
source str [optional] if omitted the server will use the default value of “manual”
attributes [AttributeValRequest] [optional] if omitted the server will use the default value of []
elements [SubLabeledTrackRequest] [optional]

81 - LabelMappingEntryRequest class reference

Properties

Name Type Description Notes
name str
attributes {str: (str,)} [optional]
sublabels {str: (SublabelMappingEntryRequest,)} Label mapping for from the model to the task sublabels within a parent label [optional]

82 - LabelsSummary class reference

Properties

Name Type Description Notes
url str [optional] [readonly]

83 - LocationEnum class reference

  • `cloud_storage` - CLOUD_STORAGE * `local` - LOCAL

Properties

Name Type Description Notes
value str * cloud_storage - CLOUD_STORAGE * local - LOCAL must be one of [“cloud_storage”, “local”, ]

84 - LoginSerializerExRequest class reference

Properties

Name Type Description Notes
password str
username str [optional]
email str [optional]

85 - MembershipRead class reference

Properties

Name Type Description Notes
user BasicUser
id int [optional] [readonly]
organization int [optional] [readonly]
is_active bool [optional] [readonly]
joined_date datetime, none_type [optional] [readonly]
role bool, date, datetime, dict, float, int, list, str, none_type [optional] [readonly]
invitation str, none_type [optional] [readonly]

86 - MetaUser class reference

Properties

Name Type Description Notes
url str [optional] [readonly]
id int [optional] [readonly]
first_name str [optional]
last_name str [optional]
email str [optional]
is_staff bool Designates whether the user can log into this admin site. [optional]
is_superuser bool Designates that this user has all permissions without explicitly assigning them. [optional]
is_active bool Designates whether this user should be treated as active. Unselect this instead of deleting accounts. [optional]
last_login datetime, none_type [optional] [readonly]
date_joined datetime [optional] [readonly]
username str Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. [optional]
groups [str] [optional]

87 - Metric class reference

Properties

Name Type Description Notes
name str
title str
description str
default_view DefaultViewEnum
data_series {str: ([DataFrame],)}
transformations [Transformation]
granularity MetricGranularity [optional]

88 - MetricGranularity class reference

Properties

Name Type Description Notes

89 - NullEnum class reference

Properties

Name Type Description Notes
value str must be one of [“null”, ]

90 - OnlineFunctionCallRequest class reference

Properties

Name Type Description Notes
job int [optional]
task int [optional]

91 - OperationStatus class reference

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

Properties

Name Type Description Notes
value str * new - NEW * in progress - IN_PROGRESS * completed - COMPLETED * rejected - REJECTED must be one of [“new”, “in progress”, “completed”, “rejected”, ]

92 - OperatorEnum class reference

  • `+` - ADDITION * `-` - SUBTRACTION * `*` - MULTIPLICATION * `/` - DIVISION

Properties

Name Type Description Notes
value str * + - ADDITION * - - SUBTRACTION * * - MULTIPLICATION * / - DIVISION must be one of ["+", “-”, “*”, “/”, ]

93 - OrganizationRead class reference

Properties

Name Type Description Notes
owner CloudStorageReadOwner
id int [optional] [readonly]
slug str [optional] [readonly]
name str [optional] [readonly]
description str [optional] [readonly]
created_date datetime [optional] [readonly]
updated_date datetime [optional] [readonly]
contact {str: (bool, date, datetime, dict, float, int, list, str, none_type)} [optional] [readonly]

94 - OrganizationWriteRequest class reference

Properties

Name Type Description Notes
slug str
name str [optional]
description str [optional]
contact {str: (bool, date, datetime, dict, float, int, list, str, none_type)} [optional]

95 - PaginatedAnnotationConflictList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [AnnotationConflict] [optional]

96 - PaginatedCloudStorageReadList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [CloudStorageRead] [optional]

97 - PaginatedCommentReadList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [CommentRead] [optional]

98 - PaginatedInvitationReadList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [InvitationRead] [optional]

99 - PaginatedIssueReadList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [IssueRead] [optional]

100 - PaginatedJobReadList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [JobRead] [optional]

101 - PaginatedLabelList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [Label] [optional]

102 - PaginatedMembershipReadList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [MembershipRead] [optional]

103 - PaginatedMetaUserList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [MetaUser] [optional]

104 - PaginatedOrganizationReadList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [OrganizationRead] [optional]

105 - PaginatedProjectReadList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [ProjectRead] [optional]

106 - PaginatedQualityReportList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [QualityReport] [optional]

107 - PaginatedQualitySettingsList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [QualitySettings] [optional]

108 - PaginatedTaskReadList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [TaskRead] [optional]

109 - PaginatedWebhookDeliveryReadList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [WebhookDeliveryRead] [optional]

110 - PaginatedWebhookReadList class reference

Properties

Name Type Description Notes
count int [optional]
next str, none_type [optional]
previous str, none_type [optional]
results [WebhookRead] [optional]

111 - PasswordChangeRequest class reference

Properties

Name Type Description Notes
old_password str
new_password1 str
new_password2 str

112 - PasswordResetConfirmRequest class reference

Serializer for confirming a password reset attempt.

Properties

Name Type Description Notes
new_password1 str
new_password2 str
uid str
token str

113 - PasswordResetSerializerExRequest class reference

Serializer for requesting a password reset e-mail.

Properties

Name Type Description Notes
email str

114 - PatchedAnnotationGuideWriteRequest class reference

Properties

Name Type Description Notes
task_id int, none_type [optional]
project_id int, none_type [optional]
markdown str [optional]

115 - PatchedCloudStorageWriteRequest class reference

Properties

Name Type Description Notes
provider_type ProviderTypeEnum [optional]
resource str [optional]
display_name str [optional]
owner BasicUserRequest [optional]
credentials_type CredentialsTypeEnum [optional]
session_token str [optional]
account_name str [optional]
key str [optional]
secret_key str [optional]
connection_string str [optional]
key_file file_type [optional]
specific_attributes str [optional]
description str [optional]
manifests [str] [optional] if omitted the server will use the default value of []

116 - PatchedCommentWriteRequest class reference

Properties

Name Type Description Notes
message str [optional]

117 - PatchedDataMetaWriteRequest class reference

Properties

Name Type Description Notes
deleted_frames [int] [optional]

118 - PatchedInvitationWriteRequest class reference

Properties

Name Type Description Notes
role RoleEnum [optional]
email str [optional]

119 - PatchedIssueWriteRequest class reference

Properties

Name Type Description Notes
position [float] [optional]
assignee int, none_type [optional]
resolved bool [optional]

120 - PatchedJobWriteRequest class reference

Properties

Name Type Description Notes
assignee int, none_type [optional]
stage JobStage [optional]
state OperationStatus [optional]

121 - PatchedLabeledDataRequest class reference

Properties

Name Type Description Notes
version int [optional] if omitted the server will use the default value of 0
tags [LabeledImageRequest] [optional] if omitted the server will use the default value of []
shapes [LabeledShapeRequest] [optional] if omitted the server will use the default value of []
tracks [LabeledTrackRequest] [optional] if omitted the server will use the default value of []

122 - PatchedLabelRequest class reference

Properties

Name Type Description Notes
id int [optional]
name str [optional]
color str The hex value for the RGB color. Will be generated automatically, unless specified explicitly. [optional]
attributes [AttributeRequest] The list of attributes. If you want to remove an attribute, you need to recreate the label and specify the remaining attributes. [optional] if omitted the server will use the default value of []
deleted bool Delete the label. Only applicable in the PATCH methods of a project or a task. [optional]
type str Associated annotation type for this label [optional]
svg str [optional]
sublabels [SublabelRequest] [optional]

123 - PatchedMembershipWriteRequest class reference

Properties

Name Type Description Notes
role RoleEnum [optional]

124 - PatchedOrganizationWriteRequest class reference

Properties

Name Type Description Notes
slug str [optional]
name str [optional]
description str [optional]
contact {str: (bool, date, datetime, dict, float, int, list, str, none_type)} [optional]

125 - PatchedProjectWriteRequest class reference

Properties

Name Type Description Notes
name str [optional]
labels [PatchedLabelRequest] [optional] if omitted the server will use the default value of []
owner_id int, none_type [optional]
assignee_id int, none_type [optional]
bug_tracker str [optional]
target_storage PatchedProjectWriteRequestTargetStorage [optional]
source_storage PatchedProjectWriteRequestTargetStorage [optional]
task_subsets [str] [optional]

126 - PatchedProjectWriteRequestTargetStorage class reference

Properties

Name Type Description Notes
location LocationEnum [optional]
cloud_storage_id int, none_type [optional]

127 - PatchedQualitySettingsRequest class reference

Properties

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

128 - PatchedTaskWriteRequest class reference

Properties

Name Type Description Notes
name str [optional]
project_id int, none_type [optional]
owner_id int, none_type [optional]
assignee_id int, none_type [optional]
bug_tracker str [optional]
labels [PatchedLabelRequest] [optional]
subset str [optional]
target_storage PatchedTaskWriteRequestTargetStorage [optional]
source_storage PatchedTaskWriteRequestTargetStorage [optional]

129 - PatchedTaskWriteRequestTargetStorage class reference

Properties

Name Type Description Notes
location LocationEnum [optional]
cloud_storage_id int, none_type [optional]

130 - PatchedUserRequest class reference

Properties

Name Type Description Notes
username str Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. [optional]
first_name str [optional]
last_name str [optional]
email str [optional]
groups [str] [optional]
is_staff bool Designates whether the user can log into this admin site. [optional]
is_superuser bool Designates that this user has all permissions without explicitly assigning them. [optional]
is_active bool Designates whether this user should be treated as active. Unselect this instead of deleting accounts. [optional]

131 - PatchedWebhookWriteRequest class reference

Properties

Name Type Description Notes
target_url str [optional]
description str [optional]
content_type WebhookContentType [optional]
secret str [optional]
is_active bool [optional]
enable_ssl bool [optional]
events [EventsEnum] [optional]

132 - Plugins class reference

Properties

Name Type Description Notes
git_integration bool
analytics bool
models bool
predict bool

133 - ProjectFileRequest class reference

Properties

Name Type Description Notes
project_file file_type

134 - ProjectRead class reference

Properties

Name Type Description Notes
tasks TasksSummary
labels LabelsSummary
url str [optional] [readonly]
id int [optional] [readonly]
name str [optional] [readonly]
owner JobReadAssignee [optional]
assignee JobReadAssignee [optional]
guide_id int, none_type [optional]
bug_tracker str [optional] [readonly]
task_subsets [str] [optional] [readonly]
created_date datetime [optional] [readonly]
updated_date datetime [optional] [readonly]
status bool, date, datetime, dict, float, int, list, str, none_type [optional] [readonly]
dimension str, none_type [optional] [readonly]
organization int, none_type [optional] [readonly]
target_storage ProjectReadTargetStorage [optional]
source_storage ProjectReadTargetStorage [optional]

135 - ProjectReadTargetStorage class reference

Properties

Name Type Description Notes
id int [optional] [readonly]
location LocationEnum [optional]
cloud_storage_id int, none_type [optional]

136 - ProjectWriteRequest class reference

Properties

Name Type Description Notes
name str
labels [PatchedLabelRequest] [optional] if omitted the server will use the default value of []
owner_id int, none_type [optional]
assignee_id int, none_type [optional]
bug_tracker str [optional]
target_storage PatchedProjectWriteRequestTargetStorage [optional]
source_storage PatchedProjectWriteRequestTargetStorage [optional]
task_subsets [str] [optional]

137 - ProviderTypeEnum class reference

  • `AWS_S3_BUCKET` - AWS_S3 * `AZURE_CONTAINER` - AZURE_CONTAINER * `GOOGLE_DRIVE` - GOOGLE_DRIVE * `GOOGLE_CLOUD_STORAGE` - GOOGLE_CLOUD_STORAGE

Properties

Name Type Description Notes
value str * AWS_S3_BUCKET - AWS_S3 * AZURE_CONTAINER - AZURE_CONTAINER * GOOGLE_DRIVE - GOOGLE_DRIVE * GOOGLE_CLOUD_STORAGE - GOOGLE_CLOUD_STORAGE must be one of [“AWS_S3_BUCKET”, “AZURE_CONTAINER”, “GOOGLE_DRIVE”, “GOOGLE_CLOUD_STORAGE”, ]

138 - QualityEnum class reference

  • `compressed` - compressed * `original` - original

Properties

Name Type Description Notes
value str * compressed - compressed * original - original must be one of [“compressed”, “original”, ]

139 - QualityReport class reference

Properties

Name Type Description Notes
target QualityReportTarget
summary QualityReportSummary
id int [optional] [readonly]
job_id int, none_type [optional] [readonly]
task_id int, none_type [optional] [readonly]
parent_id int, none_type [optional] [readonly]
created_date datetime [optional] [readonly]
target_last_updated datetime [optional] [readonly]
gt_last_updated datetime [optional] [readonly]

140 - QualityReportCreateRequest class reference

Properties

Name Type Description Notes
task_id int

141 - QualityReportSummary class reference

Properties

Name Type Description Notes
frame_count int
frame_share float
conflict_count int
warning_count int
error_count int
conflicts_by_type {str: (int,)}
valid_count int
ds_count int
gt_count int

142 - QualityReportTarget class reference

  • `job` - JOB * `task` - TASK

Properties

Name Type Description Notes
value str * job - JOB * task - TASK must be one of [“job”, “task”, ]

143 - QualitySettings class reference

Properties

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

144 - RegisterSerializerEx class reference

Properties

Name Type Description Notes
username str
email str [optional]
first_name str [optional]
last_name str [optional]

145 - RegisterSerializerExRequest class reference

Properties

Name Type Description Notes
username str
password1 str
password2 str
email str [optional]
first_name str [optional]
last_name str [optional]

146 - RestAuthDetail class reference

Properties

Name Type Description Notes
detail str [optional] [readonly]

147 - RoleEnum class reference

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

Properties

Name Type Description Notes
value str * worker - Worker * supervisor - Supervisor * maintainer - Maintainer * owner - Owner must be one of [“worker”, “supervisor”, “maintainer”, “owner”, ]

148 - RqId class reference

Properties

Name Type Description Notes
rq_id str Request id

149 - RqStatus class reference

Properties

Name Type Description Notes
state RqStatusStateEnum
message str [optional] if omitted the server will use the default value of ""
progress float [optional] if omitted the server will use the default value of 0.0

150 - RqStatusStateEnum class reference

  • `Queued` - Queued * `Started` - Started * `Finished` - Finished * `Failed` - Failed

Properties

Name Type Description Notes
value str * Queued - Queued * Started - Started * Finished - Finished * Failed - Failed must be one of [“Queued”, “Started”, “Finished”, “Failed”, ]

151 - SeverityEnum class reference

  • `warning` - WARNING * `error` - ERROR

Properties

Name Type Description Notes
value str * warning - WARNING * error - ERROR must be one of [“warning”, “error”, ]

152 - ShapeType class reference

  • `rectangle` - RECTANGLE * `polygon` - POLYGON * `polyline` - POLYLINE * `points` - POINTS * `ellipse` - ELLIPSE * `cuboid` - CUBOID * `mask` - MASK * `skeleton` - SKELETON

Properties

Name Type Description Notes
value str * rectangle - RECTANGLE * polygon - POLYGON * polyline - POLYLINE * points - POINTS * ellipse - ELLIPSE * cuboid - CUBOID * mask - MASK * skeleton - SKELETON must be one of [“rectangle”, “polygon”, “polyline”, “points”, “ellipse”, “cuboid”, “mask”, “skeleton”, ]

153 - SigningRequest class reference

Properties

Name Type Description Notes
url str

154 - SortingMethod class reference

  • `lexicographical` - LEXICOGRAPHICAL * `natural` - NATURAL * `predefined` - PREDEFINED * `random` - RANDOM

Properties

Name Type Description Notes
value str * lexicographical - LEXICOGRAPHICAL * natural - NATURAL * predefined - PREDEFINED * random - RANDOM must be one of [“lexicographical”, “natural”, “predefined”, “random”, ]

155 - Storage class reference

Properties

Name Type Description Notes
id int [optional] [readonly]
location LocationEnum [optional]
cloud_storage_id int, none_type [optional]

156 - StorageMethod class reference

  • `cache` - CACHE * `file_system` - FILE_SYSTEM

Properties

Name Type Description Notes
value str * cache - CACHE * file_system - FILE_SYSTEM must be one of [“cache”, “file_system”, ]

157 - StorageRequest class reference

Properties

Name Type Description Notes
location LocationEnum [optional]
cloud_storage_id int, none_type [optional]

158 - StorageType class reference

  • `cloud_storage` - CLOUD_STORAGE * `local` - LOCAL * `share` - SHARE

Properties

Name Type Description Notes
value str * cloud_storage - CLOUD_STORAGE * local - LOCAL * share - SHARE must be one of [“cloud_storage”, “local”, “share”, ]

159 - Sublabel class reference

Properties

Name Type Description Notes
name str
id int [optional]
color str The hex value for the RGB color. Will be generated automatically, unless specified explicitly. [optional]
attributes [Attribute] The list of attributes. If you want to remove an attribute, you need to recreate the label and specify the remaining attributes. [optional] if omitted the server will use the default value of []
type str Associated annotation type for this label [optional]
has_parent bool [optional]

160 - SubLabeledShape class reference

Properties

Name Type Description Notes
type ShapeType
frame int
label_id int
occluded bool [optional] if omitted the server will use the default value of False
outside bool [optional] if omitted the server will use the default value of False
z_order int [optional] if omitted the server will use the default value of 0
rotation float [optional] if omitted the server will use the default value of 0.0
points [float] [optional]
id int, none_type [optional]
group int, none_type [optional]
source str [optional] if omitted the server will use the default value of “manual”
attributes [AttributeVal] [optional] if omitted the server will use the default value of []

161 - SubLabeledShapeRequest class reference

Properties

Name Type Description Notes
type ShapeType
frame int
label_id int
occluded bool [optional] if omitted the server will use the default value of False
outside bool [optional] if omitted the server will use the default value of False
z_order int [optional] if omitted the server will use the default value of 0
rotation float [optional] if omitted the server will use the default value of 0.0
points [float] [optional]
id int, none_type [optional]
group int, none_type [optional]
source str [optional] if omitted the server will use the default value of “manual”
attributes [AttributeValRequest] [optional] if omitted the server will use the default value of []

162 - SubLabeledTrack class reference

Properties

Name Type Description Notes
frame int
label_id int
shapes [TrackedShape]
id int, none_type [optional]
group int, none_type [optional]
source str [optional] if omitted the server will use the default value of “manual”
attributes [AttributeVal] [optional] if omitted the server will use the default value of []

163 - SubLabeledTrackRequest class reference

Properties

Name Type Description Notes
frame int
label_id int
shapes [TrackedShapeRequest]
id int, none_type [optional]
group int, none_type [optional]
source str [optional] if omitted the server will use the default value of “manual”
attributes [AttributeValRequest] [optional] if omitted the server will use the default value of []

164 - SublabelMappingEntryRequest class reference

Properties

Name Type Description Notes
name str
attributes {str: (str,)} [optional]

165 - SublabelRequest class reference

Properties

Name Type Description Notes
name str
id int [optional]
color str The hex value for the RGB color. Will be generated automatically, unless specified explicitly. [optional]
attributes [AttributeRequest] The list of attributes. If you want to remove an attribute, you need to recreate the label and specify the remaining attributes. [optional] if omitted the server will use the default value of []
type str Associated annotation type for this label [optional]
has_parent bool [optional]

166 - TaskAnnotationsUpdateRequest class reference

Properties

Name Type Description Notes
version int [optional] if omitted the server will use the default value of 0
tags [LabeledImageRequest] [optional] if omitted the server will use the default value of []
shapes [LabeledShapeRequest] [optional] if omitted the server will use the default value of []
tracks [LabeledTrackRequest] [optional] if omitted the server will use the default value of []
annotation_file file_type [optional]

167 - TaskAnnotationsWriteRequest class reference

Properties

Name Type Description Notes
annotation_file file_type [optional]

168 - TaskFileRequest class reference

Properties

Name Type Description Notes
task_file file_type

169 - TaskRead class reference

Properties

Name Type Description Notes
jobs JobsSummary
labels LabelsSummary
url str [optional] [readonly]
id int [optional] [readonly]
name str [optional] [readonly]
project_id int, none_type [optional]
mode str [optional] [readonly]
owner CloudStorageReadOwner [optional]
assignee CloudStorageReadOwner [optional]
bug_tracker str [optional] [readonly]
created_date datetime [optional] [readonly]
updated_date datetime [optional] [readonly]
overlap int, none_type [optional] [readonly]
segment_size int [optional] [readonly]
status bool, date, datetime, dict, float, int, list, str, none_type [optional] [readonly]
data_chunk_size int, none_type [optional] [readonly]
data_compressed_chunk_type bool, date, datetime, dict, float, int, list, str, none_type [optional] [readonly]
guide_id int, none_type [optional]
data_original_chunk_type bool, date, datetime, dict, float, int, list, str, none_type [optional] [readonly]
size int [optional] [readonly]
image_quality int [optional] [readonly]
data int [optional] [readonly]
dimension str [optional]
subset str [optional] [readonly]
organization int, none_type [optional] [readonly]
target_storage JobReadTargetStorage [optional]
source_storage JobReadTargetStorage [optional]

170 - TasksSummary class reference

Properties

Name Type Description Notes
count int [optional] if omitted the server will use the default value of 0
url str [optional] [readonly]

171 - TaskWriteRequest class reference

Properties

Name Type Description Notes
name str
project_id int, none_type [optional]
owner_id int, none_type [optional]
assignee_id int, none_type [optional]
bug_tracker str [optional]
overlap int, none_type [optional]
segment_size int [optional]
labels [PatchedLabelRequest] [optional]
subset str [optional]
target_storage PatchedTaskWriteRequestTargetStorage [optional]
source_storage PatchedTaskWriteRequestTargetStorage [optional]

172 - Token class reference

Serializer for Token model.

Properties

Name Type Description Notes
key str

173 - TrackedShape class reference

Properties

Name Type Description Notes
type ShapeType
frame int
occluded bool [optional] if omitted the server will use the default value of False
outside bool [optional] if omitted the server will use the default value of False
z_order int [optional] if omitted the server will use the default value of 0
rotation float [optional] if omitted the server will use the default value of 0.0
points [float] [optional]
id int, none_type [optional]
attributes [AttributeVal] [optional] if omitted the server will use the default value of []

174 - TrackedShapeRequest class reference

Properties

Name Type Description Notes
type ShapeType
frame int
occluded bool [optional] if omitted the server will use the default value of False
outside bool [optional] if omitted the server will use the default value of False
z_order int [optional] if omitted the server will use the default value of 0
rotation float [optional] if omitted the server will use the default value of 0.0
points [float] [optional]
id int, none_type [optional]
attributes [AttributeValRequest] [optional] if omitted the server will use the default value of []

175 - Transformation class reference

Properties

Name Type Description Notes
name str
binary TransformationBinary [optional]

176 - TransformationBinary class reference

Properties

Name Type Description Notes
operator OperatorEnum
left str, none_type The name of the data series used as the left (first) operand of the binary operation. [optional]
right str, none_type The name of the data series used as the right (second) operand of the binary operation. [optional]

177 - User class reference

Properties

Name Type Description Notes
username str Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
groups [str]
url str [optional] [readonly]
id int [optional] [readonly]
first_name str [optional]
last_name str [optional]
email str [optional]
is_staff bool Designates whether the user can log into this admin site. [optional]
is_superuser bool Designates that this user has all permissions without explicitly assigning them. [optional]
is_active bool Designates whether this user should be treated as active. Unselect this instead of deleting accounts. [optional]
last_login datetime, none_type [optional] [readonly]
date_joined datetime [optional] [readonly]

178 - WebhookContentType class reference

  • `application/json` - JSON

Properties

Name Type Description Notes
value str * application/json - JSON defaults to “application/json”, must be one of [“application/json”, ]

179 - WebhookDeliveryRead class reference

Properties

Name Type Description Notes
id int [optional] [readonly]
webhook_id int [optional] [readonly]
event str [optional] [readonly]
status_code int, none_type [optional] [readonly]
redelivery bool [optional] [readonly]
created_date datetime [optional] [readonly]
updated_date datetime [optional] [readonly]
changed_fields str [optional] [readonly]
request {str: (bool, date, datetime, dict, float, int, list, str, none_type)} [optional] [readonly]
response {str: (bool, date, datetime, dict, float, int, list, str, none_type)} [optional] [readonly]

180 - WebhookRead class reference

Properties

Name Type Description Notes
type WebhookType
content_type WebhookContentType
id int [optional] [readonly]
url str [optional] [readonly]
target_url str [optional] [readonly]
description str [optional] [readonly]
is_active bool [optional] [readonly]
enable_ssl bool [optional] [readonly]
created_date datetime [optional] [readonly]
updated_date datetime [optional] [readonly]
owner JobReadAssignee [optional]
project_id int, none_type [optional]
organization int, none_type [optional] [readonly]
events [EventsEnum] [optional] [readonly]
last_status int [optional] [readonly]
last_delivery_date datetime [optional] [readonly]

181 - WebhookType class reference

  • `organization` - ORGANIZATION * `project` - PROJECT

Properties

Name Type Description Notes
value str * organization - ORGANIZATION * project - PROJECT must be one of [“organization”, “project”, ]

182 - WebhookWriteRequest class reference

Properties

Name Type Description Notes
target_url str
type WebhookType
events [EventsEnum]
description str [optional]
content_type WebhookContentType [optional]
secret str [optional]
is_active bool [optional]
enable_ssl bool [optional]
project_id int, none_type [optional]