Models

• 1: About class reference
• 2: AcceptInvitationRead class reference
• 3: AccessTokenRead class reference
• 4: AccessTokenWriteRequest class reference
• 5: AnnotationConflict class reference
• 6: AnnotationConflictAnnotationType class reference
• 7: AnnotationConflictSeverity class reference
• 8: AnnotationConflictType class reference
• 9: AnnotationFileRequest class reference
• 10: AnnotationGuideRead class reference
• 11: AnnotationGuideWriteRequest class reference
• 12: AnnotationId class reference
• 13: AnnotationIdShapeType class reference
• 14: AssetRead class reference
• 15: Attribute class reference
• 16: AttributeRequest class reference
• 17: AttributeVal class reference
• 18: AttributeValRequest class reference
• 19: BasicOrganization class reference
• 20: BasicUser class reference
• 21: BasicUserRequest class reference
• 22: ChunkType class reference
• 23: ClientEvents class reference
• 24: ClientEventsRequest class reference
• 25: ClientEventsRequestPreviousEvent class reference
• 26: CloudStorageContent class reference
• 27: CloudStorageRead class reference
• 28: CloudStorageReadOwner class reference
• 29: CloudStorageWriteRequest class reference
• 30: CommentRead class reference
• 31: CommentsSummary class reference
• 32: CommentWriteRequest class reference
• 33: ConsensusMergeCreateRequest class reference
• 34: ConsensusSettings class reference
• 35: CredentialsTypeEnum class reference
• 36: DataMetaRead class reference
• 37: DataRequest class reference
• 38: DataRequestValidationParams class reference
• 39: DataResponse class reference
• 40: DatasetFileRequest class reference
• 41: DatasetFormat class reference
• 42: DatasetFormats class reference
• 43: Event class reference
• 44: EventRequest class reference
• 45: Events class reference
• 46: EventsEnum class reference
• 47: FileInfo class reference
• 48: FileInfoTypeEnum class reference
• 49: FrameMeta class reference
• 50: FrameSelectionMethod class reference
• 51: FunctionCall class reference
• 52: FunctionCallParams class reference
• 53: FunctionCallRequest class reference
• 54: InputTypeEnum class reference
• 55: InvitationRead class reference
• 56: InvitationWriteRequest class reference
• 57: IssueRead class reference
• 58: IssuesSummary class reference
• 59: IssueWriteRequest class reference
• 60: JobRead class reference
• 61: JobReadAssignee class reference
• 62: JobReadTargetStorage class reference
• 63: JobsSummary class reference
• 64: JobStage class reference
• 65: JobStatus class reference
• 66: JobType class reference
• 67: JobValidationLayoutRead class reference
• 68: JobWriteRequest class reference
• 69: Label class reference
• 70: LabeledData class reference
• 71: LabeledDataRequest class reference
• 72: LabeledImage class reference
• 73: LabeledImageRequest class reference
• 74: LabeledShape class reference
• 75: LabeledShapeRequest class reference
• 76: LabeledTrack class reference
• 77: LabeledTrackRequest class reference
• 78: LabelMappingEntryRequest class reference
• 79: LabelsSummary class reference
• 80: LabelType class reference
• 81: LocationEnum class reference
• 82: LoginSerializerExRequest class reference
• 83: MembershipRead class reference
• 84: MetaUser class reference
• 85: NullEnum class reference
• 86: OnlineFunctionCallRequest class reference
• 87: OperationStatus class reference
• 88: OrganizationRead class reference
• 89: OrganizationWriteRequest class reference
• 90: PaginatedAccessTokenReadList class reference
• 91: PaginatedAnnotationConflictList class reference
• 92: PaginatedCloudStorageReadList class reference
• 93: PaginatedCommentReadList class reference
• 94: PaginatedConsensusSettingsList class reference
• 95: PaginatedInvitationReadList class reference
• 96: PaginatedIssueReadList class reference
• 97: PaginatedJobReadList class reference
• 98: PaginatedLabelList class reference
• 99: PaginatedMembershipReadList class reference
• 100: PaginatedMetaUserList class reference
• 101: PaginatedOrganizationReadList class reference
• 102: PaginatedProjectReadList class reference
• 103: PaginatedQualityReportList class reference
• 104: PaginatedQualitySettingsList class reference
• 105: PaginatedRequestList class reference
• 106: PaginatedTaskReadList class reference
• 107: PaginatedWebhookDeliveryReadList class reference
• 108: PaginatedWebhookReadList class reference
• 109: PasswordChangeRequest class reference
• 110: PasswordResetConfirmRequest class reference
• 111: PasswordResetSerializerExRequest class reference
• 112: PatchedAccessTokenWriteRequest class reference
• 113: PatchedAnnotationGuideWriteRequest class reference
• 114: PatchedCloudStorageWriteRequest class reference
• 115: PatchedCommentWriteRequest class reference
• 116: PatchedConsensusSettingsRequest class reference
• 117: PatchedDataMetaWriteRequest class reference
• 118: PatchedInvitationWriteRequest class reference
• 119: PatchedIssueWriteRequest class reference
• 120: PatchedJobDataMetaWriteRequest class reference
• 121: PatchedJobValidationLayoutWriteRequest class reference
• 122: PatchedJobWriteRequest class reference
• 123: PatchedLabeledDataRequest class reference
• 124: PatchedLabelRequest class reference
• 125: PatchedMembershipWriteRequest class reference
• 126: PatchedOrganizationWriteRequest class reference
• 127: PatchedProjectWriteRequest class reference
• 128: PatchedProjectWriteRequestTargetStorage class reference
• 129: PatchedQualitySettingsRequest class reference
• 130: PatchedTaskValidationLayoutWriteRequest class reference
• 131: PatchedTaskWriteRequest class reference
• 132: PatchedUserRequest class reference
• 133: PatchedWebhookWriteRequest class reference
• 134: Plugins class reference
• 135: ProjectFileRequest class reference
• 136: ProjectRead class reference
• 137: ProjectReadTargetStorage class reference
• 138: ProjectWriteRequest class reference
• 139: ProviderTypeEnum class reference
• 140: QualityPointSizeBase class reference
• 141: QualityReport class reference
• 142: QualityReportCreateRequest class reference
• 143: QualityReportJobsSummary class reference
• 144: QualityReportSummary class reference
• 145: QualityReportSummaryJobs class reference
• 146: QualityReportSummaryTasks class reference
• 147: QualityReportTarget class reference
• 148: QualityReportTasksSummary class reference
• 149: QualitySettings class reference
• 150: QualityTargetMetric class reference
• 151: RegisterSerializerEx class reference
• 152: RegisterSerializerExRequest class reference
• 153: Request class reference
• 154: RequestDataOperation class reference
• 155: RequestOwner class reference
• 156: RequestStatus class reference
• 157: RestAuthDetail class reference
• 158: RoleEnum class reference
• 159: RqId class reference
• 160: RqStatus class reference
• 161: RqStatusStateEnum class reference
• 162: ShapeType class reference
• 163: SortingMethod class reference
• 164: Storage class reference
• 165: StorageMethod class reference
• 166: StorageRequest class reference
• 167: StorageType class reference
• 168: Sublabel class reference
• 169: SubLabeledShape class reference
• 170: SubLabeledShapeRequest class reference
• 171: SubLabeledTrack class reference
• 172: SubLabeledTrackRequest class reference
• 173: SublabelMappingEntryRequest class reference
• 174: SublabelRequest class reference
• 175: TaskFileRequest class reference
• 176: TaskRead class reference
• 177: TasksSummary class reference
• 178: TaskValidationLayoutRead class reference
• 179: TaskValidationLayoutReadMode class reference
• 180: TaskWriteRequest class reference
• 181: Token class reference
• 182: TrackedShape class reference
• 183: TrackedShapeRequest class reference
• 184: User class reference
• 185: UserIdentifiers class reference
• 186: ValidationMode class reference
• 187: ValidationParamsRequest class reference
• 188: WebhookContentType class reference
• 189: WebhookDeliveryRead class reference
• 190: WebhookRead class reference
• 191: WebhookType class reference
• 192: WebhookWriteRequest class reference

1 - About class reference

Properties

Name	Type	Description	Notes
name	str
description	str
version	str
logo_url	str
subtitle	str

2 - AcceptInvitationRead class reference

Properties

Name	Type	Description	Notes
organization_slug	str

3 - AccessTokenRead class reference

Properties

Name	Type	Description	Notes
id	int		[optional] [readonly]
name	str	A free-form name for the token.	[optional] [readonly]
created_date	datetime		[optional] [readonly]
updated_date	datetime		[optional] [readonly]
expiry_date	datetime, none_type	Once the token expires, clients cannot use it anymore.	[optional] [readonly]
last_used_date	datetime, none_type	The last use date of the token. This field is NOT updated after each user request. The minimum expected resolution should be 1 day.	[optional] [readonly]
read_only	bool		[optional] [readonly]
owner	BasicUser		[optional]
value	str	The raw value of the token. Must be saved by the user, returned only once	[optional]

4 - AccessTokenWriteRequest class reference

Properties

Name	Type	Description	Notes
name	str	A free-form name for the token. Doesn’t have to be unique
expiry_date	datetime, none_type	Once the token expires, clients cannot use it anymore. If not set, the token will not expire.	[optional]
read_only	bool		[optional]

5 - 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]

6 - AnnotationConflictAnnotationType 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”, ]

7 - AnnotationConflictSeverity class reference

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

Properties

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

8 - AnnotationConflictType 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”, ]

9 - AnnotationFileRequest class reference

Properties

Name	Type	Description	Notes
annotation_file	file_type

10 - 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]

11 - AnnotationGuideWriteRequest class reference

Properties

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

12 - 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]

13 - AnnotationIdShapeType class reference

Properties

Name	Type	Description	Notes

14 - 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]

15 - Attribute class reference

Properties

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

16 - AttributeRequest class reference

Properties

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

17 - AttributeVal class reference

Properties

Name	Type	Description	Notes
spec_id	int
value	str

18 - AttributeValRequest class reference

Properties

Name	Type	Description	Notes
spec_id	int
value	str

19 - BasicOrganization class reference

Properties

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

20 - 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]

21 - 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]

22 - 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”, ]

23 - ClientEvents class reference

Properties

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

24 - 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]

25 - 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]

26 - 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]

27 - 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]

28 - 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]

29 - 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 []

30 - 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]

31 - 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]

32 - CommentWriteRequest class reference

Properties

Name	Type	Description	Notes
issue	int
message	str		[optional]

33 - ConsensusMergeCreateRequest class reference

Properties

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

34 - ConsensusSettings class reference

Properties

Name	Type	Description	Notes
id	int		[optional] [readonly]
task_id	int		[optional] [readonly]
iou_threshold	float	Pairwise annotation matching IoU threshold	[optional]
quorum	float	Minimum required share of sources having an annotation for it to be accepted	[optional]

35 - 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”, ]

36 - DataMetaRead class reference

Properties

Name	Type	Description	Notes
chunks_updated_date	datetime
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]
storage	bool, date, datetime, dict, float, int, list, str, none_type		[optional] [readonly]
cloud_storage_id	int, none_type		[optional] [readonly]

37 - DataRequest class reference

Read more about parameters here: https://docs.cvat.ai/docs/manual/basics/create-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]
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]
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://docs.cvat.ai/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]
validation_params	DataRequestValidationParams		[optional]

38 - DataRequestValidationParams class reference

Properties

Name	Type	Description	Notes
mode	ValidationMode
frame_selection_method	FrameSelectionMethod
random_seed	int	The seed value for the random number generator. The same value will produce the same frame sets. Applicable only to random frame selection methods. By default, a random value is used.	[optional]
frames	[str]	The list of file names to be included in the validation set. Applicable only to the "manual" frame selection method. Can only be used for images.	[optional]
frame_count	int	The number of frames to be included in the validation set. Applicable only to the "random_uniform" frame selection method	[optional]
frame_share	float	The share of frames to be included in the validation set. Applicable only to the "random_uniform" frame selection method	[optional]
frames_per_job_count	int	The number of frames to be included in the validation set from each annotation job. Applicable only to the "random_per_job" frame selection method	[optional]
frames_per_job_share	float	The share of frames to be included in the validation set from each annotation job. Applicable only to the "random_per_job" frame selection method	[optional]

39 - DataResponse class reference

Properties

Name	Type	Description	Notes
rq_id	str	Request id	[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 - 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]

44 - 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]

45 - Events class reference

Properties

Name	Type	Description	Notes
webhook_type	WebhookType
events	[EventsEnum]

46 - 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”, ]

47 - FileInfo class reference

Properties

Name	Type	Description	Notes
name	str
type	FileInfoTypeEnum
mime_type	str

48 - FileInfoTypeEnum class reference

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

Properties

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

49 - FrameMeta class reference

Properties

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

50 - FrameSelectionMethod class reference

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

Properties

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

51 - 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]

52 - 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]

53 - 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]
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	Deprecated; use conv_mask_to_poly instead	[optional]
conv_mask_to_poly	bool	Convert mask shapes to polygons	[optional]
mapping	{str: (LabelMappingEntryRequest,)}	Label mapping from the model to the task labels	[optional]

54 - 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”, ]

55 - 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]

56 - InvitationWriteRequest class reference

Properties

Name	Type	Description	Notes
role	RoleEnum
email	str

57 - 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]

58 - IssuesSummary class reference

Properties

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

59 - IssueWriteRequest class reference

Properties

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

60 - 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]
data_original_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]
assignee_updated_date	datetime, none_type		[optional] [readonly]
parent_job_id	int, none_type		[optional] [readonly]
consensus_replicas	int		[optional] [readonly]

61 - 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]

62 - JobReadTargetStorage class reference

Properties

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

63 - 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]

64 - 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”, ]

65 - 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”, ]

66 - JobType class reference

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

Properties

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

67 - JobValidationLayoutRead class reference

Properties

Name	Type	Description	Notes
honeypot_count	int		[optional]
honeypot_frames	[int]	The list of frame ids for honeypots in the job	[optional]
honeypot_real_frames	[int]	The list of real (validation) frame ids for honeypots in the job	[optional]

68 - 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	FrameSelectionMethod		[optional]
frame_count	int	The number of frames included in the GT job. Applicable only to the "random_uniform" frame selection method	[optional]
frame_share	float	The share of frames included in the GT job. Applicable only to the "random_uniform" frame selection method	[optional]
frames_per_job_count	int	The number of frames included in the GT job from each annotation job. Applicable only to the "random_per_job" frame selection method	[optional]
frames_per_job_share	float	The share of frames included in the GT job from each annotation job. Applicable only to the "random_per_job" frame selection method	[optional]
random_seed	int	The seed value for the random number generator. The same value will produce the same frame sets. Applicable only to random frame selection methods. By default, a random value is used.	[optional]
frames	[int]	The list of frame ids. Applicable only to the "manual" frame selection method	[optional]

69 - 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	bool, date, datetime, dict, float, int, list, str, none_type	Associated annotation type for this label * any - ANY * cuboid - CUBOID * ellipse - ELLIPSE * mask - MASK * points - POINTS * polygon - POLYGON * polyline - POLYLINE * rectangle - RECTANGLE * skeleton - SKELETON * tag - TAG	[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]

70 - 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 []

71 - 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 []

72 - 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 []

73 - 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 []

74 - 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]

75 - 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]

76 - 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]

77 - 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]

78 - 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]

79 - LabelsSummary class reference

Properties

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

80 - LabelType class reference

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

Properties

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

81 - 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”, ]

82 - LoginSerializerExRequest class reference

Properties

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

83 - 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]

84 - 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]
has_analytics_access	bool		[optional] [readonly]
username	str	Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.	[optional]
groups	[str]		[optional]

85 - NullEnum class reference

Properties

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

86 - OnlineFunctionCallRequest class reference

Properties

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

87 - 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”, ]

88 - 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]

89 - 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]

90 - PaginatedAccessTokenReadList class reference

Properties

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

91 - PaginatedAnnotationConflictList class reference

Properties

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

92 - PaginatedCloudStorageReadList class reference

Properties

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

93 - PaginatedCommentReadList class reference

Properties

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

94 - PaginatedConsensusSettingsList class reference

Properties

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

95 - PaginatedInvitationReadList class reference

Properties

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

96 - PaginatedIssueReadList class reference

Properties

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

97 - PaginatedJobReadList class reference

Properties

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

98 - PaginatedLabelList class reference

Properties

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

99 - PaginatedMembershipReadList class reference

Properties

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

100 - PaginatedMetaUserList class reference

Properties

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

101 - PaginatedOrganizationReadList class reference

Properties

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

102 - PaginatedProjectReadList class reference

Properties

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

103 - PaginatedQualityReportList class reference

Properties

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

104 - PaginatedQualitySettingsList class reference

Properties

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

105 - PaginatedRequestList class reference

Properties

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

106 - PaginatedTaskReadList class reference

Properties

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

107 - PaginatedWebhookDeliveryReadList class reference

Properties

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

108 - PaginatedWebhookReadList class reference

Properties

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

109 - PasswordChangeRequest class reference

Properties

Name	Type	Description	Notes
old_password	str
new_password1	str
new_password2	str

110 - 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

111 - PasswordResetSerializerExRequest class reference

Serializer for requesting a password reset e-mail.

Properties

Name	Type	Description	Notes
email	str

112 - PatchedAccessTokenWriteRequest class reference

Properties

Name	Type	Description	Notes
name	str	A free-form name for the token. Doesn’t have to be unique	[optional]
expiry_date	datetime, none_type	Once the token expires, clients cannot use it anymore. If not set, the token will not expire.	[optional]
read_only	bool		[optional]

113 - PatchedAnnotationGuideWriteRequest class reference

Properties

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

114 - 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 []

115 - PatchedCommentWriteRequest class reference

Properties

Name	Type	Description	Notes
message	str		[optional]

116 - PatchedConsensusSettingsRequest class reference

Properties

Name	Type	Description	Notes
iou_threshold	float	Pairwise annotation matching IoU threshold	[optional]
quorum	float	Minimum required share of sources having an annotation for it to be accepted	[optional]

117 - PatchedDataMetaWriteRequest class reference

Properties

Name	Type	Description	Notes
deleted_frames	[int]		[optional]
cloud_storage_id	int, none_type		[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 - PatchedJobDataMetaWriteRequest class reference

Properties

Name	Type	Description	Notes
deleted_frames	[int]		[optional]

121 - PatchedJobValidationLayoutWriteRequest class reference

Properties

Name	Type	Description	Notes
frame_selection_method	bool, date, datetime, dict, float, int, list, str, none_type	The method to use for frame selection of new real frames for honeypots in the job * random_uniform - RANDOM_UNIFORM * random_per_job - RANDOM_PER_JOB * manual - MANUAL	[optional]
honeypot_real_frames	[int]	The list of frame ids. Applicable only to the "manual" frame selection method	[optional]

122 - PatchedJobWriteRequest class reference

Properties

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

123 - 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 []

124 - 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	bool, date, datetime, dict, float, int, list, str, none_type	Associated annotation type for this label * any - ANY * cuboid - CUBOID * ellipse - ELLIPSE * mask - MASK * points - POINTS * polygon - POLYGON * polyline - POLYLINE * rectangle - RECTANGLE * skeleton - SKELETON * tag - TAG	[optional]
svg	str		[optional]
sublabels	**[SublabelRequest]**		[optional]

125 - PatchedMembershipWriteRequest class reference

Properties

Name	Type	Description	Notes
role	RoleEnum		[optional]

126 - 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]

127 - 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]
organization_id	int, none_type		[optional]

128 - PatchedProjectWriteRequestTargetStorage class reference

Properties

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

129 - PatchedQualitySettingsRequest class reference

Properties

Name	Type	Description	Notes
job_filter	str	A JSON-based logic expression used to filter jobs for quality validation. The filter supports various terms to specify conditions on job: [‘assignee’, ‘id’, ‘stage’, ‘state’, ’task_id’, ’task_name’, ’type’]	[optional]
inherit	bool	Allow using project settings when computing task quality. Only applicable to task quality settings inside projects	[optional]
target_metric	bool, date, datetime, dict, float, int, list, str, none_type	The primary metric used for quality estimation * accuracy - ACCURACY * precision - PRECISION * recall - RECALL	[optional]
target_metric_threshold	float	Defines the minimal quality requirements in terms of the selected target metric.	[optional]
max_validations_per_job	int	The maximum number of job validation attempts for the job assignee. The job can be automatically accepted if the job quality is above the required threshold, defined by the target threshold parameter.	[optional]
iou_threshold	float	Used for distinction between matched / unmatched shapes	[optional] if omitted the server will use the default value of 0.4
oks_sigma	float	Like IoU threshold, but for points. The percent of the bbox side, used as the radius of the circle around the GT point, where the checked point is expected to be. For boxes with different width and height, the "side" is computed as a geometric mean of the width and height. Read more: https://cocodataset.org/#keypoints-eval	[optional] if omitted the server will use the default value of 0.09
point_size_base	bool, date, datetime, dict, float, int, list, str, none_type	When comparing point annotations (including both separate points and point groups), the OKS sigma parameter defines matching area for each GT point based to the object size. The point size base parameter allows to configure how to determine the object size. If image_size, the image size is used. Useful if each point annotation represents a separate object or boxes grouped with points do not represent object boundaries. If group_bbox_size, the object size is based on the point group bbox size. Useful if each point group represents an object or there is a bbox grouped with points, representing the object size. * image_size - IMAGE_SIZE * group_bbox_size - GROUP_BBOX_SIZE	[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] if omitted the server will use the default value of 0.01
low_overlap_threshold	float	Used for distinction between strong / weak (low_overlap) matches	[optional] if omitted the server will use the default value of 0.8
compare_line_orientation	bool	Enables or disables polyline orientation comparison	[optional] if omitted the server will use the default value of True
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] if omitted the server will use the default value of 0.1
compare_groups	bool	Enables or disables annotation group checks	[optional] if omitted the server will use the default value of True
group_match_threshold	float	Minimal IoU for groups to be considered matching. Only used when the ‘compare_groups’ parameter is true	[optional] if omitted the server will use the default value of 0.5
check_covered_annotations	bool	Check for partially-covered annotations, useful in segmentation tasks	[optional] if omitted the server will use the default value of True
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] if omitted the server will use the default value of 0.05
panoptic_comparison	bool	Use only the visible part of the masks and polygons in comparisons	[optional] if omitted the server will use the default value of True
compare_attributes	bool	Enables or disables annotation attribute comparison	[optional] if omitted the server will use the default value of True
empty_is_annotated	bool	Consider empty frames annotated as "empty". This affects target metrics like accuracy in cases there are no annotations. If disabled, frames without annotations are counted as not matching (accuracy is 0). If enabled, accuracy will be 1 instead. This will also add virtual annotations to empty frames in the comparison results.	[optional] if omitted the server will use the default value of False

130 - PatchedTaskValidationLayoutWriteRequest class reference

Properties

Name	Type	Description	Notes
disabled_frames	[int]	The list of frame ids to be excluded from validation	[optional]
frame_selection_method	bool, date, datetime, dict, float, int, list, str, none_type	The method to use for frame selection of new real frames for honeypots in the task * random_uniform - RANDOM_UNIFORM * random_per_job - RANDOM_PER_JOB * manual - MANUAL	[optional]
honeypot_real_frames	[int]	The list of frame ids. Applicable only to the "manual" frame selection method	[optional]

131 - 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	StorageRequest		[optional]
source_storage	StorageRequest		[optional]
organization_id	int, none_type		[optional]

132 - 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]

133 - 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]

134 - Plugins class reference

Properties

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

135 - ProjectFileRequest class reference

Properties

Name	Type	Description	Notes
project_file	file_type

136 - 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]
organization_id	int, none_type		[optional] [readonly]
target_storage	ProjectReadTargetStorage		[optional]
source_storage	ProjectReadTargetStorage		[optional]
assignee_updated_date	datetime, none_type		[optional] [readonly]

137 - ProjectReadTargetStorage class reference

Properties

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

138 - 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]

139 - ProviderTypeEnum class reference

• `AWS_S3_BUCKET` - Amazon S3 * `AZURE_CONTAINER` - Azure Blob Storage * `GOOGLE_CLOUD_STORAGE` - Google Cloud Storage

Properties

Name	Type	Description	Notes
value	str	* AWS_S3_BUCKET - Amazon S3 * AZURE_CONTAINER - Azure Blob Storage * GOOGLE_CLOUD_STORAGE - Google Cloud Storage	must be one of [“AWS_S3_BUCKET”, “AZURE_CONTAINER”, “GOOGLE_CLOUD_STORAGE”, ]

140 - QualityPointSizeBase class reference

• `image_size` - IMAGE_SIZE * `group_bbox_size` - GROUP_BBOX_SIZE

Properties

Name	Type	Description	Notes
value	str	* image_size - IMAGE_SIZE * group_bbox_size - GROUP_BBOX_SIZE	must be one of [“image_size”, “group_bbox_size”, ]

141 - 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]
project_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, none_type		[optional] [readonly]
assignee	JobReadAssignee		[optional]

142 - QualityReportCreateRequest class reference

Properties

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

143 - QualityReportJobsSummary class reference

Properties

Name	Type	Description	Notes
total	int	Non-GT jobs in included tasks
excluded	int	Jobs excluded by filters
not_checkable	int	Included jobs without validation frames
included	int	Included job count = total - excluded

144 - QualityReportSummary class reference

Properties

Name	Type	Description	Notes
total_frames	int
validation_frames	int
validation_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
total_count	int
accuracy	float
precision	float
recall	float
frame_count	int	Deprecated. Use ‘validation_frames’ instead	[optional]
frame_share	float	Deprecated. Use ‘validation_frame_share’ instead	[optional]
tasks	QualityReportSummaryTasks		[optional]
jobs	QualityReportSummaryJobs		[optional]

145 - QualityReportSummaryJobs class reference

Included only in task and project reports

Properties

Name	Type	Description	Notes
total	int	Non-GT jobs in included tasks
excluded	int	Jobs excluded by filters
not_checkable	int	Included jobs without validation frames
included	int	Included job count = total - excluded

146 - QualityReportSummaryTasks class reference

Included only in project reports

Properties

Name	Type	Description	Notes
total	int	Total task count
custom	int	Tasks with individual settings
not_configured	int	Tasks with validation not configured
excluded	int	Tasks excluded by filters
included	int	Included task count = total - custom - non_configured - excluded

147 - QualityReportTarget 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”, ]

148 - QualityReportTasksSummary class reference

Properties

Name	Type	Description	Notes
total	int	Total task count
custom	int	Tasks with individual settings
not_configured	int	Tasks with validation not configured
excluded	int	Tasks excluded by filters
included	int	Included task count = total - custom - non_configured - excluded

149 - QualitySettings class reference

Properties

Name	Type	Description	Notes
id	int		[optional] [readonly]
task_id	int, none_type		[optional]
project_id	int, none_type		[optional]
job_filter	str	A JSON-based logic expression used to filter jobs for quality validation. The filter supports various terms to specify conditions on job: [‘assignee’, ‘id’, ‘stage’, ‘state’, ’task_id’, ’task_name’, ’type’]	[optional]
inherit	bool	Allow using project settings when computing task quality. Only applicable to task quality settings inside projects	[optional]
target_metric	bool, date, datetime, dict, float, int, list, str, none_type	The primary metric used for quality estimation * accuracy - ACCURACY * precision - PRECISION * recall - RECALL	[optional]
target_metric_threshold	float	Defines the minimal quality requirements in terms of the selected target metric.	[optional]
max_validations_per_job	int	The maximum number of job validation attempts for the job assignee. The job can be automatically accepted if the job quality is above the required threshold, defined by the target threshold parameter.	[optional]
iou_threshold	float	Used for distinction between matched / unmatched shapes	[optional] if omitted the server will use the default value of 0.4
oks_sigma	float	Like IoU threshold, but for points. The percent of the bbox side, used as the radius of the circle around the GT point, where the checked point is expected to be. For boxes with different width and height, the "side" is computed as a geometric mean of the width and height. Read more: https://cocodataset.org/#keypoints-eval	[optional] if omitted the server will use the default value of 0.09
point_size_base	bool, date, datetime, dict, float, int, list, str, none_type	When comparing point annotations (including both separate points and point groups), the OKS sigma parameter defines matching area for each GT point based to the object size. The point size base parameter allows to configure how to determine the object size. If image_size, the image size is used. Useful if each point annotation represents a separate object or boxes grouped with points do not represent object boundaries. If group_bbox_size, the object size is based on the point group bbox size. Useful if each point group represents an object or there is a bbox grouped with points, representing the object size. * image_size - IMAGE_SIZE * group_bbox_size - GROUP_BBOX_SIZE	[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] if omitted the server will use the default value of 0.01
low_overlap_threshold	float	Used for distinction between strong / weak (low_overlap) matches	[optional] if omitted the server will use the default value of 0.8
compare_line_orientation	bool	Enables or disables polyline orientation comparison	[optional] if omitted the server will use the default value of True
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] if omitted the server will use the default value of 0.1
compare_groups	bool	Enables or disables annotation group checks	[optional] if omitted the server will use the default value of True
group_match_threshold	float	Minimal IoU for groups to be considered matching. Only used when the ‘compare_groups’ parameter is true	[optional] if omitted the server will use the default value of 0.5
check_covered_annotations	bool	Check for partially-covered annotations, useful in segmentation tasks	[optional] if omitted the server will use the default value of True
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] if omitted the server will use the default value of 0.05
panoptic_comparison	bool	Use only the visible part of the masks and polygons in comparisons	[optional] if omitted the server will use the default value of True
compare_attributes	bool	Enables or disables annotation attribute comparison	[optional] if omitted the server will use the default value of True
empty_is_annotated	bool	Consider empty frames annotated as "empty". This affects target metrics like accuracy in cases there are no annotations. If disabled, frames without annotations are counted as not matching (accuracy is 0). If enabled, accuracy will be 1 instead. This will also add virtual annotations to empty frames in the comparison results.	[optional] if omitted the server will use the default value of False
created_date	datetime		[optional] [readonly]
updated_date	datetime		[optional] [readonly]

150 - QualityTargetMetric class reference

• `accuracy` - ACCURACY * `precision` - PRECISION * `recall` - RECALL

Properties

Name	Type	Description	Notes
value	str	* accuracy - ACCURACY * precision - PRECISION * recall - RECALL	must be one of [“accuracy”, “precision”, “recall”, ]

151 - RegisterSerializerEx class reference

Properties

Name	Type	Description	Notes
username	str
email	str		[optional]
first_name	str		[optional]
last_name	str		[optional]
email_verification_required	bool		[optional] [readonly]
key	str, none_type		[optional] [readonly]

152 - 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]

153 - Request class reference

Properties

Name	Type	Description	Notes
status	RequestStatus
id	str
operation	RequestDataOperation
created_date	datetime
message	str		[optional] [readonly]
progress	float, none_type		[optional] [readonly]
started_date	datetime, none_type		[optional]
finished_date	datetime, none_type		[optional]
expiry_date	datetime, none_type		[optional] [readonly]
owner	RequestOwner		[optional]
result_url	str, none_type		[optional]
result_id	int, none_type		[optional]

154 - RequestDataOperation class reference

Properties

Name	Type	Description	Notes
type	str
target	str
project_id	int, none_type		[optional]
task_id	int, none_type		[optional]
job_id	int, none_type		[optional]
format	str, none_type		[optional]
function_id	str, none_type		[optional]
lightweight	bool, none_type		[optional]