API Definitions

Definitions

apps.app_info

Name	Description	Schema
active optional	Indicates whether the application version is active	boolean
badges optional	List of the application badges	< string > array
category optional	Application category	string
confirm_config_update optional	Indicates whether the configuration update should be confirmed by the end user Default : false	boolean
description optional	Application description	string
details_page optional	The link template for the running instance details	apps.details_page_enum
disabled optional	Indicates whether this app instances can be created Default : false	boolean
icon optional	The link to the application icon	string
id optional	Application ID	string
missing_router optional	'true' if the application requires task router and no task router available for the company	boolean
name optional	Application name	string
no_info_html optional	The link to the html that will be shown in case no info template is defined	string
no_info_image optional	The link to the image that will be shown in case no info template is defined	string
provider optional	Application provider	string
user_group_sharing optional	'true' if the application supports user group sharing	boolean
version optional	Application version	string

apps.app_info_with_usages

Name	Description	Schema
active optional	Indicates whether the application version is active	boolean
badges optional	List of the application badges	< string > array
category optional	Application category	string
confirm_config_update optional	Indicates whether the configuration update should be confirmed by the end user Default : false	boolean
description optional	Application description	string
details_page optional	The link template for the running instance details	apps.details_page_enum
disabled optional	Indicates whether this app instances can be created Default : false	boolean
icon optional	The link to the application icon	string
id optional	Application ID	string
missing_router optional	'true' if the application requires task router and no task router available for the company	boolean
name optional	Application name	string
no_info_html optional	The link to the html that will be shown in case no info template is defined	string
no_info_image optional	The link to the image that will be shown in case no info template is defined	string
pending optional	The amount of pending app instances	integer
provider optional	Application provider	string
running optional	The amount of running app instances	integer
user_group_sharing optional	'true' if the application supports user group sharing	boolean
version optional	Application version	string

apps.application_instance

Name	Description	Schema
active_duration optional	Application instance duration time (seconds)	integer
application optional	Application instance parameters	application
comment optional	Free text comment	string
company optional	Company ID	string
completed optional	Application instance end time (UTC)	string (date-time)
created optional	Application creation time (UTC)	string (date-time)
id optional	Application instance id	string
last_change optional	Last update time	string (date-time)
name optional	Application instance Name	string
project optional	Project ID of the project to which this application is assigned	string
queue optional	The ID of the queue where the app instance is enqueued	string
queue_name optional	The name of the queue where the app instance is enqueued	string
readonly optional	If true then this app instance cannot be modified	boolean
setting_up optional	If true then the agent is setting up the task and has not started its execution yet	boolean
started optional	Application instance start time (UTC)	string (date-time)
status optional		apps.task_status_enum
status_changed optional	Last status change time	string (date-time)
status_message optional	free text string representing info about the status	string
status_reason optional	Reason for last status change	string
user optional	Associated user id	string
user_groups optional	IDs of the user groups that this instance is shared with	< string > array
valid_app_version optional	True if the version of the application template matches the version of the current application template. False otherwise	boolean

application

Name	Description	Schema
app_id optional	ID of the application template	string
configuration optional	Configuration parameters	object
internal_execution optional	True if the app is scheduled for the execution by internal agent. False otherwise	boolean
run_by_admin optional	Indicates whether the application was run by an admin or system user	boolean
version optional	The version of the application template	string

apps.application_instance_status_enum

Type : enum (running, stopped)

apps.application_instance_summary

Name	Description	Schema
active_duration optional	Application instance duration time (seconds)	integer
application optional	Application instance parameters	application
id optional	Application instance id	string
last_change optional	Last update time	string (date-time)
name optional	Application instance Name	string
readonly optional	If true then this app instance cannot be modified	boolean
status optional		apps.task_status_enum
user_groups optional	IDs of the user groups that this instance is shared with	< string > array

application

Name	Description	Schema
version optional	The version of the application template	string

apps.details_page_enum

Type : enum (task, project)

apps.task_status_enum

Type : enum (created, queued, in_progress, stopped, published, publishing, closed, failed, completed, unknown)

auth.credential_key

Name	Description	Schema
access_key optional		string
created optional		string (date-time)
expire optional	Credential expiration time (UTC)	string (date-time)
label optional	Optional credentials label	string
last_used optional		string (date-time)
last_used_from optional		string

auth.credentials

Name	Description	Schema
access_key optional	Credentials access key	string
expire optional	Credential expiration time (UTC)	string (date-time)
label optional	Optional credentials label	string
secret_key optional	Credentials secret key	string

auth.role

Type : enum (admin, superuser, user, annotator)

billing.payment_details

The last payment details

Name	Schema
amount optional	string
currency optional	string
next_retry_date optional	string
status optional	enum (failed, succeeded)
time optional	string (date-time)

billing.resource_usage

Resource usage

Name	Description	Schema
base optional	The free amount of the resource for the paid tier. Not relevant for the free tier	number
details optional	Resource usage per app	object
limit optional	The limit for the resource usage	number
payment optional	The payment for the resoure due to the current usage. Not relevant for the free tier	number
used optional	The used amount of the resource	number

datasets.dataset

Name	Description	Schema
comment optional		string
company optional	Company ID	string
created optional	Dataset creation time (UTC)	string (date-time)
display_stats optional	Calculated statistics for the latest committed or published version	datasets.statistics
display_version_name optional	The name of the version from which statistics are taken	string
head_version optional	The most recent version for write operations. Calculated as the non-published version with the longest path to the root.	datasets.version
id optional	Dataset ID	string
last_update optional	Time of last update (UTC). Updated on dataset update; on any version operation: when version is created, modified, committed, published or deleted; and on any frame operation: when frames are added, modified or deleted.	string (date-time)
metadata optional	User-provided metadata	object
name optional	Dataset name	string
paradigm optional	'single_version' for datasets whose version tree has only one path, 'general' otherwise	datasets.version_paradigm_enum
project optional	Associated project ID	string
system_tags optional	List of system tags. This field is reserved for system use, please don't use it.	< string > array
tags optional	List of user-defined tags	< string > array
terms_of_use optional	Terms of use string	string
user optional	Associated user ID	string
version_count optional	Amount of versions in dataset. Only supported by datasets.get_all.	integer

datasets.frame

Name	Description	Schema
blob optional	Raw data (blob) for the frame	string
context_id optional	Context ID. Used for the default frames sorting. If not set then it is filled from the uri of the first source.	string
id optional	Frame id. Must be unique within the dataset's version. If already exists, will cause existing frame to be updated	string
meta optional	Additional metadata dictionary for the frame. Please note that using this field effectively defines a schema (dictionary structure and types used as values) - frames within the same dataset cannot use conflicting schemas for this field (see documentation for more details).	object
meta_blob optional	Non searchable metadata dictionary for the frame. The fields in this object cannot be searched by and are not added to the frame schema	object
rois optional	Frame regions of interest	< datasets.roi > array
sources required	Sources of this frame	< datasets.source > array
timestamp optional	Frame's offset in milliseconds, used primarily for video content. Used for the default frames sorting as the secondary key (with the primary key being 'context_id'). For images, this value should typically be 0. If not set, value is filled from the timestamp of the first source. We recommend using this field only in cases concerning the default sorting behavior.	integer

datasets.frame_15

Name	Description	Schema
blob optional	Raw data (blob) for the frame	string
content_type optional	Frame content type (e.g. 'image/jpeg', 'image/png')	string
context_id optional	Context ID. Used for the default frames sorting. If not set then it is filled from the uri of the first source.	string
height optional	Frame height in pixels	integer
id optional	Frame id. Must be unique within the dataset's version. If already exists, will cause existing frame to be updated	string
meta optional	Additional metadata dictionary for the frame. Please note that using this field effectively defines a schema (dictionary structure and types used as values) - frames within the same dataset cannot use conflicting schemas for this field (see documentation for more details).	object
rois optional	Frame regions of interest	< datasets.roi > array
sources required	Sources of this frame	< datasets.source > array
src optional	Frame source data URI	string
timestamp optional	Frame's offset in milliseconds, used primarily for video content. Used for the default frames sorting as the secondary key (with the primary key being 'context_id'). For images, this value should typically be 0. If not set, value is filled from the timestamp of the first source. We recommend using this field only in cases concerning the default sorting behavior.	integer
width optional	Frame width in pixels	integer

datasets.mask

Name	Description	Schema
content_type optional	Content type (e.g. 'image/jpeg', 'image/png')	string
height optional	Height in pixels	integer
id required	unique ID (in this frame)	string
timestamp optional	Timestamp in the source data (for video content. for images, this value should be 0)	integer
uri required	Data URI	string
width optional	Width in pixels	integer

datasets.multi_field_pattern_data

Name	Description	Schema
datetime optional	Date time conditions (applicable only to datetime fields). Either 'pattern' or 'datetime' should be specified	string
fields optional	List of field names	< string > array
pattern optional	Pattern string (regex). Either 'pattern' or 'datetime' should be specified	string

datasets.preview

Name	Description	Schema
content_type optional	Content type (e.g. 'image/jpeg', 'image/png')	string
height optional	Height in pixels	integer
timestamp optional	Timestamp in the source data (for video content. for images, this value should be 0)	integer
uri required	Data URI	string
width optional	Width in pixels	integer

datasets.roi

Name	Description	Schema
confidence optional	ROI confidence	number
id optional	ROI id	string
label required	ROI labels	< string > array
mask optional	Mask info for this ROI	datasets.roi_mask
meta optional	Additional metadata dictionary for the roi	object
poly optional	ROI polygon (x0, y0, ..., xn, yn)	< number > array
sources optional	Source ID	< string > array

datasets.roi_mask

Name	Description	Schema
id required	Mask ID	string
value required	Mask value	< integer > array

datasets.schema_type_enum

Type : enum (frame, source, roi, all)

datasets.source

Name	Description	Schema
content_type optional	Content type (e.g. 'image/jpeg', 'image/png')	string
height optional	Height in pixels	integer
id required	Source unique ID within this DatasetVersion	string
masks optional		< datasets.mask > array
meta optional	Additional metadata dictionary for the source	object
preview optional		datasets.preview
timestamp optional	Timestamp in the source data (for video content. for images, this value should be 0)	integer
uri required	Source data URI	string
width optional	Width in pixels	integer

datasets.stat_count

Name	Description	Schema
count optional	Item name	integer
name optional	Number of appearances	string

datasets.statistics

Name	Schema
content_types optional	< datasets.stat_count > array
frames optional	< datasets.stat_count > array
labels optional	< datasets.stat_count > array

datasets.version

Name	Description	Schema
comment optional	Version comment	string
committed optional	Commit time	string (date-time)
committed_frames_ts optional	Timestamp of last committed frame	number
committed_rois_ts optional	Timestamp of last committed ROI	number
company optional	Company ID	string
created optional	Version creation time (UTC)	string (date-time)
dataset optional	Datset ID	string
es_index optional	Name of elasticsearch index	string
id optional	Version ID	string
last_frames_update optional	Last time version was created, committed or frames were updated or saved	string (date-time)
metadata optional	User-provided metadata	object
name optional	Version name	string
parent optional	Version parent ID	string
published optional	Publish time	string (date-time)
stats optional	Version statistics	datasets.statistics
status optional	Version status	datasets.version_status_enum
system_tags optional	List of system tags. This field is reserved for system use, please don't use it.	< string > array
tags optional	List of user-defined tags	< string > array
task optional	Task ID of the task which created the version	string
user optional	Associated user ID	string

datasets.version_paradigm_enum

Type : enum (single_version, general)

datasets.version_status_enum

Type : enum (draft, committing, committed, published)

dataviews.augmentation

Name	Description	Schema
crop_around_rois optional	Crop image data around all frame ROIs	boolean
sets optional	List of augmentation sets	< dataviews.augmentation_set > array

dataviews.augmentation_set

Name	Description	Schema
arguments optional	Arguments dictionary per custom augmentation type.	< string, object > map
cls optional	Augmentation class	string
strength optional	Augmentation strength. Range [0,). Minimum value : 0	number
types optional	Augmentation type	< string > array

dataviews.dataview

Name	Description	Schema
augmentation optional	Augmentation parameters. Only for training and testing tasks.	dataviews.augmentation
company optional	Company id	string
created optional	Dataview creation time (UTC)	string (date-time)
description optional	Dataview description	string
filters optional	List of FilterRule ('OR' connection)	< dataviews.filter_rule > array
id required	Dataview ID	string
iteration optional	Iteration parameters. Not applicable for register (import) tasks.	dataviews.iteration
labels_enumeration optional	Labels enumerations, specifies numbers to be assigned to ROI labels when getting frames	< string, integer > map
mapping optional	Mapping parameters	dataviews.mapping
name required	Dataview name	string
output_rois optional	'all_in_frame' - all rois for a frame are returned 'only_filtered' - only rois which led this frame to be selected 'frame_per_roi' - single roi per frame. Frame can be returned multiple times with a different roi each time. Note: this should be used for Training tasks only Note: frame_per_roi implies that only filtered rois will be returned	dataviews.output_rois_enum
project optional	Project ID of the project to which this task is assigned	string
system_tags optional	System tags list. This field is reserved for system use, please don't use it.	< string > array
tags optional	User-defined tags list	< string > array
user optional	Associated user id	string
versions optional	List of dataview entries. All tasks must have at least one dataview.	< dataviews.dataview_entry > array

dataviews.dataview_entry

Name	Description	Schema
dataset required	Existing Dataset id	string
merge_with optional	Version ID to merge with	string
version required	Version id of a version belonging to the dataset	string

dataviews.filter_by_roi_enum

Type : enum (disabled, no_rois, label_rules)

dataviews.filter_label_rule

Name	Description	Schema
conf_range optional	Range of ROI confidence level in the frame (min, max). -1 for not applicable Both min and max can be either -1 or positive. 2nd number (max) must be either -1 or larger than or equal to the 1st number (min)	< number > array
count_range optional	Range of times ROI appears in the frame (min, max). -1 for not applicable. Both integers must be larger than or equal to -1. 2nd integer (max) must be either -1 or larger than or equal to the 1st integer (min)	< integer > array
label required	Lucene format query (see lucene query syntax). Default search field is label.keyword and default operator is AND, so searching for: 'Bus Stop' Blue is equivalent to: Label.keyword:'Bus Stop' AND label.keyword:'Blue'	string
must_not optional	If set then the label must not exist or lucene query must not be true. The default value is false Default : false	boolean

dataviews.filter_rule

Name	Description	Schema
dataset required	Dataset ID. Must be a dataset which is in the task's view. If set to '*' all datasets in View are used.	string
filter_by_roi optional	Type of filter. Optional, the default value is 'label_rules'	dataviews.filter_by_roi_enum
frame_query optional	Frame filter, in Lucene query syntax	string
label_rules optional	List of FilterLabelRule ('AND' connection) disabled - No filtering by ROIs. Select all frames, even if they don't have ROIs (all frames) no_rois - Select only frames without ROIs (empty frames) label_rules - Select frames according to label rules	< dataviews.filter_label_rule > array
sources_query optional	Sources filter, in Lucene query syntax. Filters sources in each frame.	string
vector_search optional	Vector search rule	vector_search
version optional	Dataset version to apply rule to. Must belong to the dataset and be in the task's view. If set to '*' all version of the datasets in View are used.	string
weight optional	Rule weight. Default is 1	number

vector_search

Name	Description	Schema
field required	Vector field name	string
min_score optional	Min allowed score	number
similarity_func optional	The function for calculating distance from the search vector	dataviews.similarity_function
sort optional		enum (asc, desc)
vector required	The search vector	< number > array

dataviews.iteration

Sequential Iteration API configuration

Name	Description	Schema
infinite optional	Infinite iteration	boolean
jump optional	Jump entry	dataviews.jump
limit optional	Maximum frames per task. If not passed, frames will end when no more matching frames are found, unless infinite is True.	integer
min_sequence optional	Length (in ms) of video clips to return. This is used in random order, and in sequential order only if jumping is provided and only for video frames	integer
order optional	Input frames order. Values: 'sequential', 'random' In Sequential mode frames will be returned according to the order in which the frames were added to the dataset.	dataviews.iteration_order_enum
random_seed optional	Random seed used when iterating over the dataview	integer

dataviews.iteration_order_enum

Type : enum (sequential, random)

dataviews.jump

Name	Description	Schema
time optional	Max time in milliseconds between frames	integer

dataviews.label_source

Name	Description	Schema
dataset optional	Source dataset id. '*' for all datasets in view	string
labels optional	List of source labels (AND connection). '*' indicates any label. Labels must exist in at least one of the dataset versions in the task's view	< string > array
version optional	Source dataset version id. Default is '*' (for all versions in dataset in the view) Version must belong to the selected dataset, and must be in the task's view[i]	string

dataviews.mapping

Name	Description	Schema
rules optional	Rules list	< dataviews.mapping_rule > array

dataviews.mapping_rule

Name	Description	Schema
source optional	Source label info	dataviews.label_source
target optional	Target label name	string

dataviews.multi_field_pattern_data

Name	Description	Schema
datetime optional	Date time conditions (applicable only to datetime fields). Either 'pattern' or 'datetime' should be specified	string
fields optional	List of field names	< string > array
pattern optional	Pattern string (regex). Either 'pattern' or 'datetime' should be specified	string

dataviews.output_rois_enum

Type : enum (all_in_frame, only_filtered, frame_per_roi)

dataviews.similarity_function

Type : enum (l2_norm, dot_product, cosine)

events.debug_image_sample_response

Name	Description	Schema
event optional	Debug image event	object
max_iteration optional	maximal valid iteration for the variant	integer
min_iteration optional	minimal valid iteration for the variant	integer
scroll_id optional	Scroll ID to pass to the next calls to get_debug_image_sample or next_debug_image_sample	string

events.debug_images_response

Name	Description	Schema
metrics optional	Debug image events grouped by tasks and iterations	< events.debug_images_response_task_metrics > array
scroll_id optional	Scroll ID for getting more results	string

events.debug_images_response_task_metrics

Name	Description	Schema
iterations optional		< iterations > array
task optional	Task ID	string

iterations

Name	Description	Schema
events optional		< object > array
iter optional	Iteration number	integer

events.event_type_enum

Type : enum (training_stats_scalar, training_stats_vector, training_debug_image, plot, log)

events.log_level_enum

Type : enum (notset, debug, verbose, info, warn, warning, error, fatal, critical)

events.metric_variants

Name	Description	Schema
metric optional	The metric name	string
variants optional	The names of the metric variants	< string > array

events.metrics_image_event

An image or video was dumped to storage for debugging

Name	Description	Schema
iter optional	Iteration	integer
key optional	File key	string
metric optional	Metric name, e.g. 'count', 'loss', 'accuracy'	string
task required	Task ID (required)	string
timestamp optional	Epoch milliseconds UTC, will be set by the server if not set.	number
type required	'training_debug_image'	string
url optional	File URL	string
variant optional	E.g. 'class_1', 'total', 'average	string

events.metrics_plot_event

An entire plot (not single datapoint) and it's layout. Used for plotting ROC
curves, confidence matrices, etc. when evaluating the net.

Name	Description	Schema
iter optional	Iteration	integer
metric optional	Metric name, e.g. 'count', 'loss', 'accuracy'	string
plot_str optional	An entire plot (not single datapoint) and it's layout. Used for plotting ROC curves, confidence matrices, etc. when evaluating the net.	string
skip_validation optional	If set then plot_str is not checked for a valid json. The default is False	boolean
task required	Task ID (required)	string
timestamp optional	Epoch milliseconds UTC, will be set by the server if not set.	number
type required	'plot'	string
variant optional	E.g. 'class_1', 'total', 'average	string

events.metrics_scalar_event

Used for reporting scalar metrics during training task

Name	Description	Schema
iter optional	Iteration	integer
metric optional	Metric name, e.g. 'count', 'loss', 'accuracy'	string
task required	Task ID (required)	string
timestamp optional	Epoch milliseconds UTC, will be set by the server if not set.	number
type required	'training_stats_scalar'	string
value optional		number
variant optional	E.g. 'class_1', 'total', 'average'	string
x_axis_label optional	Custom X-Axis label to be used when displaying the scalars histogram	string

events.metrics_vector_event

Used for reporting vector metrics during training task

Name	Description	Schema
iter optional	Iteration	integer
metric optional	Metric name, e.g. 'count', 'loss', 'accuracy'	string
task required	Task ID (required)	string
timestamp optional	Epoch milliseconds UTC, will be set by the server if not set.	number
type optional	'training_stats_vector'	string
values optional	vector of float values	< number > array
variant optional	E.g. 'class_1', 'total', 'average	string

events.plot_sample_response

Name	Description	Schema
events optional	Plot events	< object > array
max_iteration optional	maximal valid iteration for the metric	integer
min_iteration optional	minimal valid iteration for the metric	integer
scroll_id optional	Scroll ID to pass to the next calls to get_plot_sample or next_plot_sample	string

events.plots_response

Name	Description	Schema
metrics optional	Plot events grouped by tasks and iterations	< events.plots_response_task_metrics > array
scroll_id optional	Scroll ID for getting more results	string

events.plots_response_task_metrics

Name	Description	Schema
iterations optional		< iterations > array
task optional	Task ID	string

iterations

Name	Description	Schema
events optional		< object > array
iter optional	Iteration number	integer

events.scalar_key_enum

Type : enum (iter, timestamp, iso_time)

events.single_value_metrics_response

Name	Description	Schema
tasks optional	Single value metrics grouped by task	< events.single_value_task_metrics > array

events.single_value_task_metrics

Name	Description	Schema
task optional	Task ID	string
task_name optional	Task name	string
values optional		< values > array

values

Name	Schema
metric optional	string
timestamp optional	number
value optional	number
variant optional	string

events.task_log_event

A log event associated with a task.

Name	Description	Schema
level optional	Log level.	events.log_level_enum
msg optional	Log message.	string
task required	Task ID (required)	string
timestamp optional	Epoch milliseconds UTC, will be set by the server if not set.	number
type required	'log'	string
worker optional	Name of machine running the task.	string

events.task_metric

Name	Description	Schema
metric optional	Metric name	string
task required	Task ID	string

events.task_metric_variants

Name	Description	Schema
metric optional	Metric name	string
task required	Task ID	string
variants optional	Metric variant names	< string > array

frames.augmentation

Name	Description	Schema
arguments optional	Arguments dictionary, passed to custom augmentations.	object
cls optional	Augmentation class (see global definitions)	string
params optional	Transform parameters, an array ot 3 randomly generated values. Fixed values are passed in case of affine reflect augmentation.	< number > array
strength optional	Transform strength. Required for pixel transforms.	number
trans_mat optional	Transform matrix (list of lists). Required for affine transforms.	< < number > array > array
type optional	Augmentation type (see global definitions)	string

frames.dataset_version

Name	Description	Schema
id optional	Dataset id	string
version optional	Dataset version id	string

frames.dataview

Name	Description	Schema
augmentation optional	Augmentation parameters. Only for training and testing tasks.	frames.dv_augmentation
filters optional	List of FilterRule ('OR' relationship)	< frames.filter_rule > array
iteration optional	Iteration parameters. Not applicable for register (import) tasks.	frames.iteration
labels_enumeration optional	Labels enumerations, specifies numbers to be assigned to ROI labels when getting frames	< string, integer > map
mapping optional	Mapping parameters	frames.mapping
output_rois optional	'all_in_frame' - all rois for a frame are returned 'only_filtered' - only rois which led this frame to be selected 'frame_per_roi' - single roi per frame. Frame can be returned multiple times with a different roi each time. Note: this should be used for Training tasks only Note: frame_per_roi implies that only filtered rois will be returned	frames.output_rois_enum
versions optional	View dataset versions	< frames.view_entry > array

frames.dv_augmentation

Name	Description	Schema
crop_around_rois optional	Crop image data around all frame ROIs	boolean
sets optional	List of augmentation sets	< frames.dv_augmentation_set > array

frames.dv_augmentation_set

Name	Description	Schema
arguments optional	Arguments dictionary per custom augmentation type.	< string, object > map
cls optional	Augmentation class	string
strength optional	Augmentation strength. Range [0,). Minimum value : 0	number
types optional	Augmentation type	< string > array

frames.filter_by_roi_enum

Type : enum (disabled, no_rois, label_rules)

frames.filter_label_rule

Name	Description	Schema
conf_range optional	Range of ROI confidence level in the frame (min, max). -1 for not applicable Both min and max can be either -1 or positive. 2nd number (max) must be either -1 or larger than or equal to the 1st number (min)	< number > array
count_range optional	Range of times ROI appears in the frame (min, max). -1 for not applicable. Both integers must be larger than or equal to -1. 2nd integer (max) must be either -1 or larger than or equal to the 1st integer (min)	< integer > array
label required	Lucene format query (see lucene query syntax). Default search field is label.keyword and default operator is AND, so searching for: 'Bus Stop' Blue is equivalent to: Label.keyword:'Bus Stop' AND label.keyword:'Blue'	string
must_not optional	If set then the label must not exist or lucene query must not be true. The default value is false Default : false	boolean

frames.filter_rule

Name	Description	Schema
dataset required	Dataset ID. Must be a dataset which is in the task's view. If set to '*' all datasets in View are used.	string
filter_by_roi optional	Type of filter. Optional, the default value is 'label_rules'	frames.filter_by_roi_enum
frame_query optional	Frame filter, in Lucene query syntax	string
label_rules optional	List of FilterLabelRule ('AND' connection) disabled - No filtering by ROIs. Select all frames, even if they don't have ROIs (all frames) no_rois - Select only frames without ROIs (empty frames) label_rules - Select frames according to label rules	< frames.filter_label_rule > array
sources_query optional	Sources filter, in Lucene query syntax. Filters sources in each frame.	string
vector_search optional	Vector search rule	vector_search
version optional	Dataset version to apply rule to. Must belong to the dataset and be in the task's view. If set to '*' all version of the datasets in View are used.	string
weight optional	Rule weight. Default is 1	number

vector_search

Name	Description	Schema
field required	Vector field name	string
min_score optional	Min allowed score	number
similarity_func optional	The function for calculating distance from the search vector	frames.similarity_function
sort optional		enum (asc, desc)
vector required	The search vector	< number > array

frames.flow_control

Name	Description	Schema
bidirectional optional	If set then frames retreival can go either forward or backwards. Otherwise only forward. The default is False. The limitations of bidirectional navigation: - Frames are always returned in sequential order - The iteration is finite (no support for infinite iteration)	boolean
navigate_backwards optional	When bidirectional is True, settings this to True navigates backwards duing frames retreival. Default is False	boolean

frames.frame

Name	Description	Schema
augmentation optional	List of augmentations	< frames.augmentation > array
blob optional	Raw data (blob) for the frame	string
context_id optional	Context ID. Used for the default frames sorting. If not set then it is filled from the uri of the first source.	string
dataset optional	Frame's dataset version	frames.dataset_version
deleted optional	Set to 'true' for the deleted frames	boolean
id optional	Frame id	string
is_key_frame optional	Is this a key frame (only applicable in frames who'se src is a video)	boolean
key_frame optional	ID of the key frame that this frame belongs to	string
label_rule_counts optional	The number of matched roi per lable rule	object
labels_size optional	Number of labels returned	integer
meta optional	Additional metadata dictionary for the frame. Please note that using this field effectively defines a schema (dictionary structure and types used as values) - frames within the same dataset cannot use conflicting schemas for this field (see documentation for more details).	object
meta_blob optional	Non searchable metadata dictionary for the frame. The fields in this object cannot be searched by and are not added to the frame schema	object
new_ver optional	Newer version of this frame, if asked to merge	frames.frame
rois optional	Frame regions of interest	< frames.roi > array
rule_name optional	Name of the filtering rule according to which this frame was provided (if applicable)	string
saved optional	Last time frame was saved (timestamp)	integer
saved_in_version optional	Last version this frame was saved in (version ID)	string
sources optional	Sources of this frame	< frames.source > array
timestamp optional	Frame's offset in milliseconds, used primarily for video content. Used for the default frames sorting as the secondary key (with the primary key being 'context_id'). For images, this value should typically be 0. If not set, value is filled from the timestamp of the first source. We recommend using this field only in cases concerning the default sorting behavior.	integer
updated optional	Last time frame was saved (timestamp)	integer
updated_in_version optional	Last version this frame was updated in (version ID)	string
video_gop optional	Video encoding GOP value for the source of this frame. Only valid for video frames	number

frames.frame_15

Name	Description	Schema
augmentation optional	List of augmentations	< frames.augmentation > array
blob optional	Raw data (blob) for the frame	string
content_type optional	Frame content type (e.g. 'image/jpeg', 'image/png')	string
context_id optional	Context ID. Used for the default frames sorting. If not set then it is filled from the uri of the first source.	string
dataset optional	Frame's dataset version	frames.dataset_version
height optional	Frame height in pixels	integer
id optional	Frame id	string
is_key_frame optional	Is this a key frame (only applicable in frames who'se src is a video)	boolean
key_frame optional	ID of the key frame that this frame belongs to	string
label_stats optional	Mapping of label name to number of appearances	object
labels_size optional	Number of labels returned	integer
meta optional	Additional metadata dictionary for the frame. Please note that using this field effectively defines a schema (dictionary structure and types used as values) - frames within the same dataset cannot use conflicting schemas for this field (see documentation for more details).	object
new_ver optional	Newer version of this frame, if asked to merge	frames.frame_15
rois optional	Frame regions of interest	< frames.roi > array
rule_name optional	Name of the filtering rule according to which this frame was provided (if applicable)	string
saved optional	Last time frame was saved (timestamp)	integer
saved_in_version optional	Last version this frame was saved in (version ID)	string
sources optional	Sources of this frame	< frames.source > array
src optional	Frame data URI	string
task optional	Task which created the frame	string
timestamp optional	Frame's offset in milliseconds, used primarily for video content. Used for the default frames sorting as the secondary key (with the primary key being 'context_id'). For images, this value should typically be 0. If not set, value is filled from the timestamp of the first source. We recommend using this field only in cases concerning the default sorting behavior.	integer
updated optional	Last time frame was saved (timestamp)	integer
updated_in_version optional	Last version this frame was updated in (version ID)	string
video_gop optional	Video encoding GOP value for the source of this frame. Only valid for video frames	number
width optional	Frame width in pixels	integer

frames.iteration

Sequential Iteration API configuration

Name	Description	Schema
infinite optional	Infinite iteration	boolean
jump optional	Jump entry	frames.jump
limit optional	Maximum frames per task. If not passed, frames will end when no more matching frames are found, unless infinite is True.	integer
min_sequence optional	Length (in ms) of video clips to return. This is used in random order, and in sequential order only if jumping is provided and only for video frames	integer
order optional	Input frames order. Values: 'sequential', 'random' In Sequential mode frames will be returned according to the order in which the frames were added to the dataset.	frames.iteration_order_enum
random_seed optional	Random seed used when iterating over the dataview	integer

frames.iteration_order_enum

Type : enum (sequential, random)

frames.jump

Name	Description	Schema
time optional	Max time in milliseconds between frames	integer

frames.label_source

Name	Description	Schema
dataset optional	Source dataset id. '*' for all datasets in view	string
labels optional	List of source labels (AND connection). '*' indicates any label. Labels must exist in at least one of the dataset versions in the task's view	< string > array
version optional	Source dataset version id. Default is '*' (for all versions in dataset in the view) Version must belong to the selected dataset, and must be in the task's view[i]	string

frames.mapping

Name	Description	Schema
rules optional	Rules list	< frames.mapping_rule > array

frames.mapping_rule

Name	Description	Schema
source optional	Source label info	frames.label_source
target optional	Target label name	string

frames.mask

Name	Description	Schema
content_type optional	Content type (e.g. 'image/jpeg', 'image/png')	string
height optional	Height in pixels	integer
id optional	unique ID (in this frame)	string
timestamp optional	Timestamp in the source data (for video content. for images, this value should be 0)	integer
uri optional	Data URI	string
width optional	Width in pixels	integer

frames.output_rois_enum

Type : enum (all_in_frame, only_filtered, frame_per_roi)

frames.preview

Name	Description	Schema
content_type optional	Content type (e.g. 'image/jpeg', 'image/png')	string
height optional	Height in pixels	integer
timestamp optional	Timestamp in the source data (for video content. for images, this value should be 0)	integer
uri optional	Data URI	string
width optional	Width in pixels	integer

frames.roi

Name	Description	Schema
area optional	ROI area (not used)	integer
confidence optional	ROI confidence	number
id optional	ROI id	string
label optional	ROI labels	< string > array
label_num optional	Label number according to the specified labels mapping Used only when ROI is returned as part of a task's frame.	integer
mask optional	Mask info for this ROI	frames.roi_mask
meta optional	Additional metadata dictionary for the roi	object
poly optional	ROI polygon (x0, y0, ..., xn, yn)	< number > array
sources optional	Sources that this ROI belongs to	< string > array

frames.roi_mask

Name	Description	Schema
id required	Mask ID	string
value required	Mask value	< integer > array

frames.rule_count

Name	Description	Schema
accurate optional	True if the provided count is accurate. If False, 'reason' will contain the reason why.	boolean
count optional	Number of frames matching this rule	integer
name optional	Rule name	string
reason optional	Reason for the count being inaccurate if 'accurate' is True, empty otherwise.	string
rule_index optional	Rule index	integer

frames.similarity_function

Type : enum (l2_norm, dot_product, cosine)

frames.snippet

Name	Description	Schema
_key optional	The grouping key for the agggregated frames	string
_score optional	For vector search return the similarity score that frame vector field got relative to the input vector	number
augmentation optional	List of augmentations	< frames.augmentation > array
blob optional	Raw data (blob) for the frame	string
context_id optional	Context ID. Used for the default frames sorting. If not set then it is filled from the uri of the first source.	string
dataset optional	Frame's dataset version	frames.dataset_version
deleted optional	Set to 'true' for the deleted frames	boolean
id optional	Frame id	string
is_key_frame optional	Is this a key frame (only applicable in frames who'se src is a video)	boolean
key_frame optional	ID of the key frame that this frame belongs to	string
label_rule_counts optional	The number of matched roi per lable rule	object
labels_size optional	Number of labels returned	integer
meta optional	Additional metadata dictionary for the frame. Please note that using this field effectively defines a schema (dictionary structure and types used as values) - frames within the same dataset cannot use conflicting schemas for this field (see documentation for more details).	object
meta_blob optional	Non searchable metadata dictionary for the frame. The fields in this object cannot be searched by and are not added to the frame schema	object
new_ver optional	Newer version of this frame, if asked to merge	frames.frame
num_frames optional	Number of frames represented by this snippet	integer
rois optional	Frame regions of interest	< frames.roi > array
rule_name optional	Name of the filtering rule according to which this frame was provided (if applicable)	string
saved optional	Last time frame was saved (timestamp)	integer
saved_in_version optional	Last version this frame was saved in (version ID)	string
sources optional	Sources of this frame	< frames.source > array
timestamp optional	Frame's offset in milliseconds, used primarily for video content. Used for the default frames sorting as the secondary key (with the primary key being 'context_id'). For images, this value should typically be 0. If not set, value is filled from the timestamp of the first source. We recommend using this field only in cases concerning the default sorting behavior.	integer
updated optional	Last time frame was saved (timestamp)	integer
updated_in_version optional	Last version this frame was updated in (version ID)	string
video_gop optional	Video encoding GOP value for the source of this frame. Only valid for video frames	number

frames.source

Name	Description	Schema
content_type optional	Content type (e.g. 'image/jpeg', 'image/png')	string
height optional	Height in pixels	integer
id optional	unique ID (in this frame)	string
masks optional		< frames.mask > array
meta optional	Additional metadata dictionary for the source	object
preview optional		frames.preview
timestamp optional	Timestamp in the source data (for video content. for images, this value should be 0)	integer
uri optional	Data URI	string
width optional	Width in pixels	integer

frames.stat_count

Name	Description	Schema
count optional	Item name	integer
name optional	Number of appearances	string

frames.view_entry

Name	Description	Schema
dataset optional	Existing Dataset id	string
merge_with optional	Version ID to merge with	string
version optional	Version id of a version belonging to the dataset	string

login.choose_company

Name	Description	Schema
companies optional	Companies info	< companies > array
session_id optional	Login session ID	string
tenant optional	External tenant ID	string

companies

Name	Description	Schema
id optional	Company ID	string
logo optional	Company logo	string
logo_fmt optional	Company logo format	string
name optional	Company Name	string

login.login_status_enum

Type : enum (logged_in, signup_required, choose_company)

login.login_white_list

Name	Description	Schema
company optional	Company	string
domain optional	Email domain name (all addresses under the domain are included in this whitelist entry)	string (hostname)
emails optional	List of email addresses (all addresses in this list are included in this whitelist entry)	< login.login_white_list_email_entry > array
group optional	Group ID to be assigned to users added through this whitelist	string
id optional	Whitelist entry ID	string

login.login_white_list_email_entry

Name	Description	Schema
added optional	The time this email entry was added	string (date-time)
email optional	Email address	string (email)

login.login_white_list_v1_5

Name	Description	Schema
company optional	Company	string
domain optional	Email domain name (all addresses under the domain are included in this whitelist entry)	string (hostname)
emails optional	List of email addresses (all addresses in this list are included in this whitelist entry)	< login.login_white_list_email_entry > array
group optional	Group ID to be assigned to users added through this whitelist	string
id optional	Whitelist entry ID	string

login.role

Type : enum (admin, superuser, user, annotator)

login.signup_info

Name	Description	Schema
avatar optional	The user avatar as received from auth provider	string
company_name optional	Company name for the user. In case the user was invited to join the company this field cannot be changed	string
crm_form optional	The crm form template for the user signup	string
email optional	The user email as received from auth provider	string
email_verify_state optional	App state stored until email was verified	string
family_name optional	The user family name as received from auth provider	string
given_name optional	The user given name as received from auth provider	string
name optional	The user full name as received from auth provide	string
signup_token optional	Sign-up token. Should be passed back to the Signup call	string

login.whitelist_entry

Name	Description	Schema
accepted optional	Time the entry was accepted	string (date-time)
added optional	Time that the entry was added	string (date-time)
email optional	Email address	string (email)
status optional	Entry status	enum (pending, accepted)
user optional	The user info (if the user was created)	user

user

Name	Description	Schema
id optional	The user ID	string
name optional	The user full name	string
role optional	The user role	login.role

models.last_metrics_event

Name	Description	Schema
count optional	The total count of reported values	integer
first_value optional	First value reported	number
first_value_iteration optional	The iteration at which the first value was reported	integer
max_value optional	Maximum value reported	number
max_value_iteration optional	The iteration at which the maximum value was reported	integer
mean_value optional	The mean value	number
metric optional	Metric name	string
min_value optional	Minimum value reported	number
min_value_iteration optional	The iteration at which the minimum value was reported	integer
value optional	Last value reported	number
variant optional	Variant name	string
x_axis_label optional	The user defined value for the X-Axis name stored with the event	string

models.last_metrics_variants

Last metric events, one for each variant hash

Type : < string, models.last_metrics_event > map

models.metadata_item

Name	Description	Schema
key optional	The key uniquely identifying the metadata item inside the given entity	string
type optional	The type of the metadata item	string
value optional	The value stored in the metadata item	string

models.model

Name	Description	Schema
comment optional	Model comment	string
company optional	Company id	string
created optional	Model creation time	string (date-time)
design optional	Json object representing the model design. Should be identical to the network design of the task which created the model	object
framework optional	Framework on which the model is based. Should be identical to the framework of the task which created the model	string
id optional	Model id	string
labels optional	Json object representing the ids of the labels in the model. The keys are the layers' names and the values are the ids.	< string, integer > map
last_iteration optional	Last iteration reported for this model	integer
last_metrics optional	Last metric variants (hash to events), one for each metric hash	< string, models.last_metrics_variants > map
last_update optional	Model last update time	string (date-time)
metadata optional	Model metadata	< string, models.metadata_item > map
name optional	Model name	string
parent optional	Parent model ID	string
project optional	Associated project ID	string
ready optional	Indication if the model is final and can be used by other tasks	boolean
stats optional	Model statistics	stats
system_tags optional	System tags. This field is reserved for system use, please don't use it.	< string > array
tags optional	User-defined tags	< string > array
task optional	Task ID of task in which the model was created	string
ui_cache optional	UI cache for this model	object
uri optional	URI for the model, pointing to the destination storage.	string
user optional	Associated user id	string

stats

Name	Description	Schema
labels_count optional	Number of the model labels	integer

models.multi_field_pattern_data

Name	Description	Schema
datetime optional	Date time conditions (applicable only to datetime fields). Either 'pattern' or 'datetime' should be specified	string
fields optional	List of field names	< string > array
pattern optional	Pattern string (regex). Either 'pattern' or 'datetime' should be specified	string

organization.field_mapping

Name	Description	Schema
field required	The source field name as specified in the only_fields	string
name optional	The column name in the exported csv file	string
values optional		< organization.value_mapping > array

organization.invite

Name	Description	Schema
company optional	Company ID	string
created optional	Invite creation time (UTC)	string (date-time)
emails optional	Invited emails	< string > array
expires optional	Invite expiration time (UTC)	string (date-time)
id optional	Invite id	string
user optional	Associated user id	string

organization.match_set

Name	Schema
rules optional	< organization.match_spec > array

organization.match_spec

Name	Description	Schema
field optional	Match field. Denotes the object field path this spec references.	string
obj_type optional	Type of object this match spec refers to (e.g. frame)	string
regex optional	Python-style regex. This spec matches the field if the field's value is matched by thie regex.	string

organization.service_info

Name	Description	Schema
match_sets optional	A list of match specs sets. Each nested set represents a set of specs - a nested set is matched if all specs in this nested set match (AND relation). Nested sets have an OR relation, meaning that if at least one of them is matched, the service can be used.	< organization.match_set > array
type optional	Service type	string
url optional	Service URL	string
use_fallback optional	If set and url is not responding then the original url will be contacted	boolean

organization.ui_action

Name	Description	Schema
action optional	Action request details	action
name optional	Action name	string
tooltip optional	Action tooltip	string

action

Name	Description	Schema
headers optional	Additional request headers	< string, string > map
method optional	HTTP method	enum (get, GET, post, POST, delete, DELETE)
payload optional	Request payload	string
url optional	Request URL	string

organization.user_details

Name	Description	Schema
avatar optional	User avatar (URL or base64-encoded data)	string
id optional	User ID	string
name optional	User Name	string
support optional	Set to 'true' for the support users. Only internal users can see other support users	boolean

organization.value_mapping

Name	Description	Schema
key required	Original value	object
value required	Translated value	object

organization.workloads

Name	Schema
series optional	< series > array
total optional	< total > array

series

Name	Description	Schema
cpu_usage optional	Tasks running task multiplied by cpu resource	< number > array
cpu_usage_artifical_weights optional	Indicate whether artificial cpu resource weights were used	boolean
dates optional	Date timestamp in seconds	< number > array
duration optional	Tasks running time in seconds	< number > array
gpu_usage optional	Tasks running task multiplied by gpu resource	< number > array
gpu_usage_artifical_weights optional	Indicate whether artificial gpu resource weights were used	boolean
id optional		string
name optional		string

total

Name	Description	Schema
cpu_artificial_weights optional	Indicate whether artificial cpu resource weights were used	boolean
cpu_usage optional	Tasks running task multiplied by cpu resource	number
duration optional	Tasks running time in seconds	integer
gpu_artificial_weights optional	Indicate whether artificial gpu resource weights were used	boolean
gpu_usage optional	Tasks running task multiplied by gpu resource	number
id optional		string
name optional		string

permissions.access_permission_enum

Type : enum (read, read_write)

permissions.entity_type_enum

Type : enum (task, model, project, queue, dataset, dataview, route)

permissions.user

Name	Description	Schema
email optional	User email	string
id optional	User ID	string
name optional	User name	string
role optional	User role	string

projects.metric_variant_result

Name	Description	Schema
metric optional	Metric name	string
metric_hash optional	Metric name hash. Used instead of the metric name when categorizing last metrics events in task objects.	string
variant optional	Variant name	string
variant_hash optional	Variant name hash. Used instead of the variant name when categorizing last metrics events in task objects.	string

projects.multi_field_pattern_data

Name	Description	Schema
datetime optional	Date time conditions (applicable only to datetime fields). Either 'pattern' or 'datetime' should be specified	string
fields optional	List of field names	< string > array
pattern optional	Pattern string (regex). Either 'pattern' or 'datetime' should be specified	string

projects.project

Name	Description	Schema
basename optional	Project base name	string
company optional	Company id	string
created optional	Creation time	string (date-time)
default_output_destination optional	The default output destination URL for new tasks under this project	string
description optional	Project description	string
id optional	Project id	string
last_update optional	Last project update time. Reflects the last time the project metadata was changed or a task in this project has changed status	string (date-time)
name optional	Project name	string
system_tags optional	System tags. This field is reserved for system use, please don't use it.	< string > array
tags optional	User-defined tags	< string > array
user optional	Associated user id	string

projects.projects_get_all_response_single

Name	Description	Schema
basename optional	Project base name	string
company optional	Company id	string
created optional	Creation time	string (date-time)
dataset_stats optional	Project dataset statistics	dataset_stats
default_output_destination optional	The default output destination URL for new tasks under this project	string
description optional	Project description	string
hidden optional	Returned if the search_hidden flag was specified in the get_all_ex call and the project is hidden	boolean
id optional	Project id	string
last_update optional	Last project update time. Reflects the last time the project metadata was changed or a task in this project has changed status	string (date-time)
name optional	Project name	string
own_datasets optional	The amount of datasets/hyperdatasers under this project (without children projects). Returned if 'check_own_contents' flag is set in the request and children_type is set to 'dataset' or 'hyperdataset'	integer
own_dataviews optional	The amount of dataviews under this project (without children projects). Returned if 'check_own_contents' flag is set in the request	integer
own_models optional	The amount of models under this project (without children projects). Returned if 'check_own_contents' flag is set in the request	integer
own_tasks optional	The amount of tasks under this project (without children projects). Returned if 'check_own_contents' flag is set in the request	integer
stats optional	Additional project stats	projects.stats
sub_projects optional	The list of sub projects	< sub_projects > array
system_tags optional	System tags. This field is reserved for system use, please don't use it.	< string > array
tags optional	User-defined tags	< string > array
user optional	Associated user id	string

dataset_stats

Name	Description	Schema
file_count optional	The number of files stored in the dataset	integer
total_size optional	The total dataset size in bytes	integer

sub_projects

Name	Description	Schema
id optional	Subproject ID	string
name optional	Subproject name	string

projects.stats

Name	Description	Schema
active optional	Stats for active tasks	projects.stats_status_count
archived optional	Stats for archived tasks	projects.stats_status_count
datasets optional	Stats for childrent datasets	projects.stats_datasets

projects.stats_datasets

Name	Description	Schema
count optional	Number of datasets	integer
tags optional	Dataset tags	< string > array

projects.stats_status_count

Name	Description	Schema
completed_tasks_24h optional	Number of tasks completed in the last 24 hours	integer
last_task_run optional	The most recent started time of a task	integer
status_count optional	Status counts	status_count
total_runtime optional	Total run time of all tasks in project (in seconds)	integer
total_tasks optional	Number of tasks	integer

status_count

Name	Description	Schema
closed optional	Number of 'closed' tasks in project	integer
completed optional	Number of 'completed' tasks in project	integer
created optional	Number of 'created' tasks in project	integer
failed optional	Number of 'failed' tasks in project	integer
in_progress optional	Number of 'in_progress' tasks in project	integer
published optional	Number of 'published' tasks in project	integer
queued optional	Number of 'queued' tasks in project	integer
stopped optional	Number of 'stopped' tasks in project	integer
unknown optional	Number of 'unknown' tasks in project	integer

projects.urls

Name	Schema
artifact_urls optional	< string > array
event_urls optional	< string > array
model_urls optional	< string > array

queues.entry

Name	Description	Schema
added optional	Time this entry was added to the queue	string (date-time)
task optional	Queued task ID	string

queues.metadata_item

Name	Description	Schema
key optional	The key uniquely identifying the metadata item inside the given entity	string
type optional	The type of the metadata item	string
value optional	The value stored in the metadata item	string

queues.queue

Name	Description	Schema
company optional	Company id	string
created optional	Queue creation time	string (date-time)
display_name optional	Display name	string
entries optional	List of ordered queue entries	< queues.entry > array
id optional	Queue id	string
last_update optional	Queue last update	string (date-time)
metadata optional	Queue metadata	< string, queues.metadata_item > map
name optional	Queue name	string
profile_connection optional	Profile connection for policy queues	profile_connection
system_tags optional	System tags. This field is reserved for system use, please don't use it.	< string > array
tags optional	User-defined tags	< string > array
user optional	Associated user id	string

profile_connection

Name	Description	Schema
policy optional	Policy ID	string
policy_name optional	Policy Name. Returned only for admins or members of the corresponding policy group	string
profile optional	Profile ID	string
user_group optional	Policy group	string

queues.queue_metrics

Name	Description	Schema
avg_waiting_times optional	List of average waiting times for tasks in the queue. The points correspond to the timestamps in the dates list. If more than one value exists for the given interval then the maximum value is taken.	< number > array
dates optional	List of timestamps (in seconds from epoch) in the acceding order. The timestamps are separated by the requested interval. Timestamps where no queue status change was recorded are omitted.	< integer > array
queue optional	ID of the queue	string
queue_lengths optional	List of tasks counts in the queue. The points correspond to the timestamps in the dates list. If more than one value exists for the given interval then the count that corresponds to the maximum average value is taken.	< integer > array

reports.artifact

Name	Description	Schema
content_size optional	Raw data length in bytes	integer
display_data optional	User-defined list of key/value pairs, sorted	< < string > array > array
hash optional	Hash of entire raw data	string
key required	Entry key	string
mode optional	System defined input/output indication	reports.artifact_mode_enum
timestamp optional	Epoch time when artifact was created	integer
type required	System defined type	string
type_data optional	Additional fields defined by the system	reports.artifact_type_data
uri optional	Raw data location	string

reports.artifact_mode_enum

Type : enum (input, output)

reports.artifact_type_data

Name	Description	Schema
content_type optional	System defined raw data content type	string
data_hash optional	Hash of raw data, without any headers or descriptive parts	string
preview optional	Description or textual data	string

reports.augmentation

Name	Description	Schema
crop_around_rois optional	Crop image data around all frame ROIs	boolean
sets optional	List of augmentation sets	< reports.augmentation_set > array

reports.augmentation_set

Name	Description	Schema
arguments optional	Arguments dictionary per custom augmentation type.	< string, object > map
cls optional	Augmentation class	string
strength optional	Augmentation strength. Range [0,). Minimum value : 0	number
types optional	Augmentation type	< string > array

reports.configuration_item

Name	Description	Schema
description optional	The parameter description. Optional	string
name optional	Name of the parameter. Should be unique	string
type optional	Type of the parameter. Optional	string
value optional	Value of the parameter	string

reports.debug_images_response_task_metrics

Name	Description	Schema
iterations optional		< iterations > array
task optional	Task ID	string

iterations

Name	Description	Schema
events optional		< object > array
iter optional	Iteration number	integer

reports.execution

Name	Description	Schema
artifacts optional	Task artifacts	< reports.artifact > array
dataviews optional	Additional dataviews for the task	< object > array
docker_cmd optional	Command for running docker script for the execution of the task	string
framework optional	Framework related to the task. Case insensitive. Mandatory for Training tasks.	string
model optional	Execution input model ID Not applicable for Register (Import) tasks	string
model_desc optional	Json object representing the Model descriptors	object
model_labels optional	Json object representing the ids of the labels in the model. The keys are the layers' names and the values are the IDs. Not applicable for Register (Import) tasks. Mandatory for Training tasks	< string, integer > map
parameters optional	Json object containing the Task parameters	object
queue optional	Queue ID where task was queued.	string
test_split optional	Percentage of frames to use for testing only	integer

reports.filter_by_roi_enum

Type : enum (disabled, no_rois, label_rules)

reports.filter_label_rule

Name	Description	Schema
conf_range optional	Range of ROI confidence level in the frame (min, max). -1 for not applicable Both min and max can be either -1 or positive. 2nd number (max) must be either -1 or larger than or equal to the 1st number (min)	< number > array
count_range optional	Range of times ROI appears in the frame (min, max). -1 for not applicable. Both integers must be larger than or equal to -1. 2nd integer (max) must be either -1 or larger than or equal to the 1st integer (min)	< integer > array
label required	Lucene format query (see lucene query syntax). Default search field is label.keyword and default operator is AND, so searching for: 'Bus Stop' Blue is equivalent to: Label.keyword:'Bus Stop' AND label.keyword:'Blue'	string
must_not optional	If set then the label must not exist or lucene query must not be true. The default value is false Default : false	boolean

reports.filter_rule

Name	Description	Schema
dataset required	Dataset ID. Must be a dataset which is in the task's view. If set to '*' all datasets in View are used.	string
filter_by_roi optional	Type of filter. Optional, the default value is 'label_rules'	reports.filter_by_roi_enum
frame_query optional	Frame filter, in Lucene query syntax	string
label_rules optional	List of FilterLabelRule ('AND' connection) disabled - No filtering by ROIs. Select all frames, even if they don't have ROIs (all frames) no_rois - Select only frames without ROIs (empty frames) label_rules - Select frames according to label rules	< reports.filter_label_rule > array
sources_query optional	Sources filter, in Lucene query syntax. Filters sources in each frame.	string
vector_search optional	Vector search rule	vector_search
version optional	Dataset version to apply rule to. Must belong to the dataset and be in the task's view. If set to '*' all version of the datasets in View are used.	string
weight optional	Rule weight. Default is 1	number

vector_search

Name	Description	Schema
field required	Vector field name	string
min_score optional	Min allowed score	number
similarity_func optional	The function for calculating distance from the search vector	reports.similarity_function
sort optional		enum (asc, desc)
vector required	The search vector	< number > array

reports.filtering

Name	Description	Schema
filtering_rules optional	List of FilterRule ('OR' connection)	< reports.filter_rule > array
output_rois optional	'all_in_frame' - all rois for a frame are returned 'only_filtered' - only rois which led this frame to be selected 'frame_per_roi' - single roi per frame. Frame can be returned multiple times with a different roi each time. Note: this should be used for Training tasks only Note: frame_per_roi implies that only filtered rois will be returned	reports.output_rois_enum

reports.input

Task input params. (input view must be provided).

Name	Description	Schema
augmentation optional	Augmentation parameters. Only for training and testing tasks.	reports.augmentation
dataviews optional	Key to DataView ID Mapping	< string, string > map
frames_filter optional	Filtering params	reports.filtering
iteration optional	Iteration parameters. Not applicable for register (import) tasks.	reports.iteration
mapping optional	Mapping params (see common definitions section)	reports.mapping
view optional	View params	reports.view

reports.iteration

Sequential Iteration API configuration

Name	Description	Schema
infinite optional	Infinite iteration	boolean
jump optional	Jump entry	reports.jump
limit optional	Maximum frames per task. If not passed, frames will end when no more matching frames are found, unless infinite is True.	integer
min_sequence optional	Length (in ms) of video clips to return. This is used in random order, and in sequential order only if jumping is provided and only for video frames	integer
order optional	Input frames order. Values: 'sequential', 'random' In Sequential mode frames will be returned according to the order in which the frames were added to the dataset.	string
random_seed required	Random seed used during iteration	integer

reports.jump

Name	Description	Schema
time optional	Max time in milliseconds between frames	integer

reports.label_source

Name	Description	Schema
dataset optional	Source dataset id. '*' for all datasets in view	string
labels optional	List of source labels (AND connection). '*' indicates any label. Labels must exist in at least one of the dataset versions in the task's view	< string > array
version optional	Source dataset version id. Default is '*' (for all versions in dataset in the view) Version must belong to the selected dataset, and must be in the task's view[i]	string

reports.last_metrics_event

Name	Description	Schema
count optional	The total count of reported values	integer
first_value optional	First value reported	number
first_value_iteration optional	The iteration at which the first value was reported	integer
max_value optional	Maximum value reported	number
max_value_iteration optional	The iteration at which the maximum value was reported	integer
mean_value optional	The mean value	number
metric optional	Metric name	string
min_value optional	Minimum value reported	number
min_value_iteration optional	The iteration at which the minimum value was reported	integer
value optional	Last value reported	number
variant optional	Variant name	string
x_axis_label optional	The user defined value for the X-Axis name stored with the event	string

reports.last_metrics_variants

Last metric events, one for each variant hash

Type : < string, reports.last_metrics_event > map

reports.mapping

Name	Description	Schema
rules optional	Rules list	< reports.mapping_rule > array

reports.mapping_rule

Name	Description	Schema
source optional	Source label info	reports.label_source
target optional	Target label name	string

reports.metric_variants

Name	Description	Schema
metric optional	The metric name	string
variants optional	The names of the metric variants	< string > array

reports.multi_field_pattern_data

Name	Description	Schema
datetime optional	Date time conditions (applicable only to datetime fields). Either 'pattern' or 'datetime' should be specified	string
fields optional	List of field names	< string > array
pattern optional	Pattern string (regex). Either 'pattern' or 'datetime' should be specified	string

reports.output

Name	Description	Schema
destination optional	Storage id. This is where output files will be stored.	string
error optional	Last error text	string
model optional	Model id.	string
result optional	Task result. Values: 'success', 'failure'	string
view optional	View params	reports.view

reports.output_rois_enum

Type : enum (all_in_frame, only_filtered, frame_per_roi)

reports.params_item

Name	Description	Schema
description optional	The parameter description. Optional	string
name optional	Name of the parameter. The combination of section and name should be unique	string
section optional	Section that the parameter belongs to	string
type optional	Type of the parameter. Optional	string
value optional	Value of the parameter	string

reports.report

Name	Description	Schema
comment optional	Free text comment	string
company optional	Company ID	string
created optional	Report creation time (UTC)	string (date-time)
id optional	Report id	string
last_update optional	Last time this report was created, edited, changed	string (date-time)
name optional	Report Name	string
project optional	Project ID of the project to which this report is assigned	string
published optional	Report publish time	string (date-time)
report optional	Report template	string
report_assets optional	List of the external report assets	< string > array
status optional		reports.report_status_enum
status_changed optional	Last status change time	string (date-time)
status_message optional	free text string representing info about the status	string
status_reason optional	Reason for last status change	string
system_tags optional	System tags list. This field is reserved for system use, please don't use it.	< string > array
tags optional	User-defined tags list	< string > array
user optional	Associated user id	string

reports.report_status_enum

Type : enum (created, published)

reports.scalar_key_enum

Type : enum (iter, timestamp, iso_time)

reports.script

Name	Description	Schema
binary optional	Binary to use when running the script Default : "python"	string
branch optional	Repository branch id If not provided and tag not provided, default repository branch is used.	string
diff optional	Uncommitted changes found in the repository when task was run	string
entry_point optional	Path to execute within the repository	string
repository optional	Name of the repository where the script is located	string
requirements optional	A JSON object containing requirements strings by key	object
tag optional	Repository tag	string
version_num optional	Version (changeset) number. Optional (default is head version) Unused if tag is provided.	string
working_dir optional	Path to the folder from which to run the script Default - root folder of repository	string

reports.section_params

Task section params

Type : < string, reports.params_item > map

reports.similarity_function

Type : enum (l2_norm, dot_product, cosine)

reports.single_value_task_metrics

Name	Description	Schema
task optional	Task ID	string
task_name optional	Task name	string
values optional		< values > array

values

Name	Schema
metric optional	string
timestamp optional	number
value optional	number
variant optional	string

reports.task

Name	Description	Schema
active_duration optional	Task duration time (seconds)	integer
comment optional	Free text comment	string
company optional	Company ID	string
completed optional	Task end time (UTC)	string (date-time)
configuration optional	Task configuration params	< string, reports.configuration_item > map
container optional	Docker container parameters	< string, string > map
created optional	Task creation time (UTC)	string (date-time)
execution optional	Task execution params	reports.execution
hyperparams optional	Task hyper params per section	< string, reports.section_params > map
id optional	Task id	string
input optional	Task input params	reports.input
last_change optional	Last time any update was done to the task	string (date-time)
last_iteration optional	Last iteration reported for this task	integer
last_metrics optional	Last metric variants (hash to events), one for each metric hash	< string, reports.last_metrics_variants > map
last_update optional	Last time this task was created, edited, changed or events for this task were reported	string (date-time)
last_worker optional	ID of last worker that handled the task	string
last_worker_report optional	Last time a worker reported while working on this task	string (date-time)
models optional	Task models	reports.task_models
name optional	Task Name	string
output optional	Task output params	reports.output
parent optional	Parent task id	string
project optional	Project ID of the project to which this task is assigned	string
published optional	Task publish time	string (date-time)
runtime optional	Task runtime mapping	object
script optional	Script info	reports.script
started optional	Task start time (UTC)	string (date-time)
status optional		reports.task_status_enum
status_changed optional	Last status change time	string (date-time)
status_message optional	free text string representing info about the status	string
status_reason optional	Reason for last status change	string
system_tags optional	System tags list. This field is reserved for system use, please don't use it.	< string > array
tags optional	User-defined tags list	< string > array
type optional	Type of task. Values: 'dataset_import', 'annotation', 'training', 'testing'	reports.task_type_enum
user optional	Associated user id	string

reports.task_model_item

Name	Description	Schema
model required	The model ID	string
name required	The task model name	string

reports.task_models

Name	Description	Schema
input optional	The list of task input models	< reports.task_model_item > array
output optional	The list of task output models	< reports.task_model_item > array

reports.task_status_enum

Type : enum (created, queued, in_progress, stopped, published, publishing, closed, failed, completed, unknown)

reports.task_type_enum

Type of task

Type : enum (dataset_import, annotation, annotation_manual, training, testing, inference, data_processing, application, monitor, controller, optimizer, service, qc, custom)

reports.view

Name	Description	Schema
entries optional	List of view entries. All tasks must have at least one view.	< reports.view_entry > array

reports.view_entry

Name	Description	Schema
dataset optional	Existing Dataset id	string
merge_with optional	Version ID to merge with	string
version optional	Version id of a version belonging to the dataset	string

resources.task_status_enum

Type : enum (created, queued, in_progress, stopped, published, publishing, closed, failed, completed, unknown)

resources.task_type_enum

Type of task

Type : enum (dataset_import, annotation, annotation_manual, training, testing, inference, data_processing, application, monitor, controller, optimizer, service, qc, custom)

serving.container_info

Name	Description	Schema
age_sec optional	Amount of seconds since the container registration	integer
endpoint optional	Endpoint name	string
id optional	Container ID	string
input_size optional	Input size	string
input_type optional	Input type	string
last_update optional	The latest time when the container instance sent update	string (date-time)
model optional	Model name	string
model_source optional	Model source	string
model_version optional	Model version	string
preprocess_artifact optional	Preprocess Artifact	string
uptime_sec optional	Model instance uptime in seconds	integer
url optional	Model url	string

serving.container_instance_stats

Name	Description	Schema
cpu_count optional	CPU Count	integer
gpu_count optional	GPU Count	integer
id optional	Container ID	string
last_update optional	The latest time when the container instance sent update	string (date-time)
latency_ms optional	Average request latency in ms	integer
reference optional	Array of reference items provided by the container instance. Can contain multiple reference items with the same type	< reference > array
requests optional	Number of requests	integer
requests_min optional	Average requests per minute	number
uptime_sec optional	Uptime in seconds	integer

reference

Name	Description	Schema
type required	The type of the reference item	enum (app_id, app_instance, model, task, url)
value required	The reference item value	string

serving.endpoint_stats

Name	Description	Schema
endpoint optional	Endpoint name	string
instances optional	The number of model serving instances	integer
last_update optional	The latest time when one of the model instances was updated	string (date-time)
latency_ms optional	Average of latency of model instances in ms	integer
model optional	Model name	string
requests optional	Total requests processed by model instances	integer
requests_min optional	Average of request rate of model instances per minute	number
uptime_sec optional	Max of model instance uptime in seconds	integer
url optional	Model url	string

serving.machine_stats

Name	Description	Schema
cpu_temperature optional	CPU temperature	< number > array
cpu_usage optional	Average CPU usage per core	< number > array
disk_free_home optional	Free space in % of /home drive	number
disk_free_temp optional	Free space in % of /tmp drive	number
disk_read optional	Mbytes read per second	number
disk_write optional	Mbytes write per second	number
gpu_fraction optional	GPU fraction	< number > array
gpu_memory_free optional	GPU free memory MBs	< number > array
gpu_memory_used optional	GPU used memory MBs	< number > array
gpu_temperature optional	GPU temperature	< number > array
gpu_usage optional	Average GPU usage per GPU card	< number > array
memory_free optional	Free memory MBs	number
memory_used optional	Used memory MBs	number
network_rx optional	Mbytes per second	number
network_tx optional	Mbytes per second	number

sso.configuration

Name	Description	Schema
active optional	Configuration status	boolean
category optional	The category of the provider	sso.provider_category
display_name optional	The display name of the configuraton	string
id optional	ID of the configuration	string
last_update optional	The UTC time of the last editing	string (date-time)
provider optional	ID of the provider	string
readonly optional	If set then the configuration cannot be viewed or edited	boolean

sso.provider

Name	Description	Schema
category optional	The category of the provider	sso.provider_category
display_name optional	The display name of the provider	string
icon optional	The icon url	string
id optional	ID of the provider	string

sso.provider_category

Type : enum (saml, oidc)

storage.aws

AWS S3 storage settings

Name	Description	Schema
buckets optional	Credential settings per bucket	< storage.aws_bucket > array
key optional	Access key	string
region optional	AWS region	string
secret optional	Secret key	string
token optional	Access token	string
use_credentials_chain optional	If set then use host credentials Default : false	boolean

storage.aws_bucket

Settings per S3 bucket

Name	Description	Schema
acl optional	ACL	string
bucket optional	The name of the bucket	string
host optional	Host address (for minio servers)	string
key optional	Access key	string
multipart optional	Multipart upload Default : true	boolean
region optional	AWS Region	string
secret optional	Secret key	string
secure optional	Use SSL connection Default : true	boolean
subdir optional	The path to match	string
token optional	Access token	string
use_credentials_chain optional	Use host configured credentials Default : false	boolean
verify optional	Verify server certificate Default : true	boolean

storage.azure

Azure storage settings

Name	Description	Schema
containers optional	Credentials per container	< storage.azure_container > array

storage.azure_container

Azure container settings

Name	Description	Schema
account_key optional	Account key	string
account_name optional	Account name	string
container_name optional	The name of the container	string

storage.google

Google storage settings

Name	Description	Schema
buckets optional	Credentials per bucket	< storage.google_bucket > array
credentials_json optional	The contents of the credentials json file	string
project optional	Project name	string

storage.google_bucket

Settings per Google storage bucket

Name	Description	Schema
bucket optional	The name of the bucket	string
credentials_json optional	The contents of the credentials json file	string
project optional	The name of the project	string
subdir optional	The path to match	string

system.basic_company_info

Name	Description	Schema
active optional	Company status	boolean
id optional	Company ID	string
name optional	Company Name	string

system.company_defaults

Company configuration defaults

Name	Description	Schema
allowed_users optional	Maximum allowed number of users for this company	integer
cluster optional	Cluster in which dataset indices for this company will be created	string
kibana_space optional	Link to user-hosted kibana space	string
sso optional	sso config	object

system.dataset

Name	Description	Schema
comment optional		string
company optional	Company ID	string
created optional	Dataset creation time (UTC)	string (date-time)
id optional	Dataset ID	string
last_update optional	Time of last update (UTC). Updated on dataset update; on any version operation: when version is created, modified, committed, published or deleted; and on any frame operation: when frames are added, modified or deleted.	string (date-time)
metadata optional	User-provided metadata	object
name optional	Dataset name	string
project optional	Associated project ID	string
system_tags optional	List of system tags. This field is reserved for system use, please don't use it.	< string > array
tags optional	List of user-defined tags	< string > array
terms_of_use optional	Terms of use string	string
user optional	Associated user ID	string

system.features_enum

Type : enum (user_management, user_management_advanced, permissions, applications, experiments, queues, queue_management, data_management, config_vault, app_management, pipelines, reports, show_dashboard, show_model_view, show_projects, resource_dashboard, sso_management, service_users, resource_policy, show_datasets, show_orchestration, model_serving, show_app_gateways, project_workloads, tenant_usages)

system.match_set

Name	Schema
rules optional	< system.match_spec > array

system.match_spec

Name	Description	Schema
field optional	Match field. Denotes the object field path this spec references.	string
obj_type optional	Type of object this match spec refers to (e.g. frame)	string
regex optional	Python-style regex. This spec matches the field if the field's value is matched by thie regex.	string

system.service_info

Name	Description	Schema
match_sets optional	A list of match specs sets. Each nested set represents a set of specs - a nested set is matched if all specs in this nested set match (AND relation). Nested sets have an OR relation, meaning that if at least one of them is matched, the service can be used.	< system.match_set > array
type optional	Service type	string
url optional	Service URL	string
use_fallback optional	If set and url is not responding then the original url will be contacted	boolean

system.version

Name	Description	Schema
comment optional	Version comment	string
committed optional	Commit time	string (date-time)
committed_frames_ts optional	Timestamp of last committed frame	number
committed_rois_ts optional	Timestamp of last committed ROI	number
company optional	Company ID	string
created optional	Version creation time (UTC)	string (date-time)
dataset optional	Datset ID	string
es_index optional	Name of elasticsearch index	string
id optional	Version ID	string
last_frames_update optional	Last time version was created, committed or frames were updated or saved	string (date-time)
metadata optional	User-provided metadata	object
name optional	Version name	string
parent optional	Version parent ID	string
published optional	Publish time	string (date-time)
status optional	Version status	system.version_status_enum
system_tags optional	List of system tags. This field is reserved for system use, please don't use it.	< string > array
tags optional	List of user-defined tags	< string > array
task optional	Task ID of the task which created the version	string
user optional	Associated user ID	string

system.version_status_enum

Type : enum (draft, committing, committed, published)

tasks.artifact

Name	Description	Schema
content_size optional	Raw data length in bytes	integer
display_data optional	User-defined list of key/value pairs, sorted	< < string > array > array
hash optional	Hash of entire raw data	string
key required	Entry key	string
mode optional	System defined input/output indication	tasks.artifact_mode_enum
timestamp optional	Epoch time when artifact was created	integer
type required	System defined type	string
type_data optional	Additional fields defined by the system	tasks.artifact_type_data
uri optional	Raw data location	string

tasks.artifact_id

Name	Description	Schema
key required	Entry key	string
mode optional	System defined input/output indication	tasks.artifact_mode_enum

tasks.artifact_mode_enum

Type : enum (input, output)

tasks.artifact_type_data

Name	Description	Schema
content_type optional	System defined raw data content type	string
data_hash optional	Hash of raw data, without any headers or descriptive parts	string
preview optional	Description or textual data	string

tasks.augmentation

Name	Description	Schema
crop_around_rois optional	Crop image data around all frame ROIs	boolean
sets optional	List of augmentation sets	< tasks.augmentation_set > array

tasks.augmentation_set

Name	Description	Schema
arguments optional	Arguments dictionary per custom augmentation type.	< string, object > map
cls optional	Augmentation class	string
strength optional	Augmentation strength. Range [0,). Minimum value : 0	number
types optional	Augmentation type	< string > array

tasks.configuration_item

Name	Description	Schema
description optional	The parameter description. Optional	string
name optional	Name of the parameter. Should be unique	string
type optional	Type of the parameter. Optional	string
value optional	Value of the parameter	string

tasks.execution

Name	Description	Schema
artifacts optional	Task artifacts	< tasks.artifact > array
dataviews optional	Additional dataviews for the task	< object > array
docker_cmd optional	Command for running docker script for the execution of the task	string
framework optional	Framework related to the task. Case insensitive. Mandatory for Training tasks.	string
model optional	Execution input model ID Not applicable for Register (Import) tasks	string
model_desc optional	Json object representing the Model descriptors	object
model_labels optional	Json object representing the ids of the labels in the model. The keys are the layers' names and the values are the IDs. Not applicable for Register (Import) tasks. Mandatory for Training tasks	< string, integer > map
parameters optional	Json object containing the Task parameters	object
queue optional	Queue ID where task was queued.	string
test_split optional	Percentage of frames to use for testing only	integer

tasks.execution_15

Task execution params

Name	Description	Schema
dataviews optional	key to embedded Dataview mapping	object
framework optional	Framework related to the task. Case insensitive. Mandatory for Training tasks.	string
model optional	Execution input model ID Not applicable for Register (Import) tasks	string
model_desc optional	Json object representing the Model descriptors	object
model_labels optional	Json object representing the ids of the labels in the model. The keys are the layers' names and the values are the IDs. Not applicable for Register (Import) tasks. Mandatory for Training tasks	< string, integer > map
parameters optional	Json object containing the Task parameters	object
queue optional	Queue ID where task was queued.	string
test_split optional	Percentage of frames to use for testing only	integer

tasks.filter_by_roi_enum

Type : enum (disabled, no_rois, label_rules)

tasks.filter_label_rule

Name	Description	Schema
conf_range optional	Range of ROI confidence level in the frame (min, max). -1 for not applicable Both min and max can be either -1 or positive. 2nd number (max) must be either -1 or larger than or equal to the 1st number (min)	< number > array
count_range optional	Range of times ROI appears in the frame (min, max). -1 for not applicable. Both integers must be larger than or equal to -1. 2nd integer (max) must be either -1 or larger than or equal to the 1st integer (min)	< integer > array
label required	Lucene format query (see lucene query syntax). Default search field is label.keyword and default operator is AND, so searching for: 'Bus Stop' Blue is equivalent to: Label.keyword:'Bus Stop' AND label.keyword:'Blue'	string
must_not optional	If set then the label must not exist or lucene query must not be true. The default value is false Default : false	boolean

tasks.filter_rule

Name	Description	Schema
dataset required	Dataset ID. Must be a dataset which is in the task's view. If set to '*' all datasets in View are used.	string
filter_by_roi optional	Type of filter. Optional, the default value is 'label_rules'	tasks.filter_by_roi_enum
frame_query optional	Frame filter, in Lucene query syntax	string
label_rules optional	List of FilterLabelRule ('AND' connection) disabled - No filtering by ROIs. Select all frames, even if they don't have ROIs (all frames) no_rois - Select only frames without ROIs (empty frames) label_rules - Select frames according to label rules	< tasks.filter_label_rule > array
sources_query optional	Sources filter, in Lucene query syntax. Filters sources in each frame.	string
vector_search optional	Vector search rule	vector_search
version optional	Dataset version to apply rule to. Must belong to the dataset and be in the task's view. If set to '*' all version of the datasets in View are used.	string
weight optional	Rule weight. Default is 1	number

vector_search

Name	Description	Schema
field required	Vector field name	string
min_score optional	Min allowed score	number
similarity_func optional	The function for calculating distance from the search vector	tasks.similarity_function
sort optional		enum (asc, desc)
vector required	The search vector	< number > array

tasks.filtering

Name	Description	Schema
filtering_rules optional	List of FilterRule ('OR' connection)	< tasks.filter_rule > array
output_rois optional	'all_in_frame' - all rois for a frame are returned 'only_filtered' - only rois which led this frame to be selected 'frame_per_roi' - single roi per frame. Frame can be returned multiple times with a different roi each time. Note: this should be used for Training tasks only Note: frame_per_roi implies that only filtered rois will be returned	tasks.output_rois_enum

tasks.input

Task input params. (input view must be provided).

Name	Description	Schema
augmentation optional	Augmentation parameters. Only for training and testing tasks.	tasks.augmentation
dataviews optional	Key to DataView ID Mapping	< string, string > map
frames_filter optional	Filtering params	tasks.filtering
iteration optional	Iteration parameters. Not applicable for register (import) tasks.	tasks.iteration
mapping optional	Mapping params (see common definitions section)	tasks.mapping
view optional	View params	tasks.view

tasks.iteration

Sequential Iteration API configuration

Name	Description	Schema
infinite optional	Infinite iteration	boolean
jump optional	Jump entry	tasks.jump
limit optional	Maximum frames per task. If not passed, frames will end when no more matching frames are found, unless infinite is True.	integer
min_sequence optional	Length (in ms) of video clips to return. This is used in random order, and in sequential order only if jumping is provided and only for video frames	integer
order optional	Input frames order. Values: 'sequential', 'random' In Sequential mode frames will be returned according to the order in which the frames were added to the dataset.	string
random_seed required	Random seed used during iteration	integer

tasks.jump

Name	Description	Schema
time optional	Max time in milliseconds between frames	integer

tasks.label_source

Name	Description	Schema
dataset optional	Source dataset id. '*' for all datasets in view	string
labels optional	List of source labels (AND connection). '*' indicates any label. Labels must exist in at least one of the dataset versions in the task's view	< string > array
version optional	Source dataset version id. Default is '*' (for all versions in dataset in the view) Version must belong to the selected dataset, and must be in the task's view[i]	string

tasks.last_metrics_event

Name	Description	Schema
count optional	The total count of reported values	integer
first_value optional	First value reported	number
first_value_iteration optional	The iteration at which the first value was reported	integer
max_value optional	Maximum value reported	number
max_value_iteration optional	The iteration at which the maximum value was reported	integer
mean_value optional	The mean value	number
metric optional	Metric name	string
min_value optional	Minimum value reported	number
min_value_iteration optional	The iteration at which the minimum value was reported	integer
value optional	Last value reported	number
variant optional	Variant name	string
x_axis_label optional	The user defined value for the X-Axis name stored with the event	string

tasks.last_metrics_variants

Last metric events, one for each variant hash

Type : < string, tasks.last_metrics_event > map

tasks.mapping

Name	Description	Schema
rules optional	Rules list	< tasks.mapping_rule > array

tasks.mapping_rule

Name	Description	Schema
source optional	Source label info	tasks.label_source
target optional	Target label name	string

tasks.model_type_enum

Type : enum (input, output)

tasks.multi_field_pattern_data

Name	Description	Schema
datetime optional	Date time conditions (applicable only to datetime fields). Either 'pattern' or 'datetime' should be specified	string
fields optional	List of field names	< string > array
pattern optional	Pattern string (regex). Either 'pattern' or 'datetime' should be specified	string

tasks.output

Name	Description	Schema
destination optional	Storage id. This is where output files will be stored.	string
error optional	Last error text	string
model optional	Model id.	string
result optional	Task result. Values: 'success', 'failure'	string
view optional	View params	tasks.view

tasks.output_rois_enum

Type : enum (all_in_frame, only_filtered, frame_per_roi)

tasks.param_key

Name	Description	Schema
name optional	Name of the parameter. If the name is ommitted then the corresponding operation is performed on the whole section	string
section optional	Section that the parameter belongs to	string

tasks.params_item

Name	Description	Schema
description optional	The parameter description. Optional	string
name optional	Name of the parameter. The combination of section and name should be unique	string
section optional	Section that the parameter belongs to	string
type optional	Type of the parameter. Optional	string
value optional	Value of the parameter	string

tasks.replace_hyperparams_enum

Type : enum (none, section, all)

tasks.script

Name	Description	Schema
binary optional	Binary to use when running the script Default : "python"	string
branch optional	Repository branch id If not provided and tag not provided, default repository branch is used.	string
diff optional	Uncommitted changes found in the repository when task was run	string
entry_point optional	Path to execute within the repository	string
repository optional	Name of the repository where the script is located	string
requirements optional	A JSON object containing requirements strings by key	object
tag optional	Repository tag	string
version_num optional	Version (changeset) number. Optional (default is head version) Unused if tag is provided.	string
working_dir optional	Path to the folder from which to run the script Default - root folder of repository	string

tasks.section_params

Task section params

Type : < string, tasks.params_item > map

tasks.similarity_function

Type : enum (l2_norm, dot_product, cosine)

tasks.task

Name	Description	Schema
active_duration optional	Task duration time (seconds)	integer
comment optional	Free text comment	string
company optional	Company ID	string
completed optional	Task end time (UTC)	string (date-time)
configuration optional	Task configuration params	< string, tasks.configuration_item > map
container optional	Docker container parameters	< string, string > map
created optional	Task creation time (UTC)	string (date-time)
execution optional	Task execution params	tasks.execution
hyperparams optional	Task hyper params per section	< string, tasks.section_params > map
id optional	Task id	string
input optional	Task input params	tasks.input
last_change optional	Last time any update was done to the task	string (date-time)
last_iteration optional	Last iteration reported for this task	integer
last_metrics optional	Last metric variants (hash to events), one for each metric hash	< string, tasks.last_metrics_variants > map
last_update optional	Last time this task was created, edited, changed or events for this task were reported	string (date-time)
last_worker optional	ID of last worker that handled the task	string
last_worker_report optional	Last time a worker reported while working on this task	string (date-time)
models optional	Task models	tasks.task_models
name optional	Task Name	string
output optional	Task output params	tasks.output
parent optional	Parent task id	string
project optional	Project ID of the project to which this task is assigned	string
published optional	Task publish time	string (date-time)
runtime optional	Task runtime mapping	object
script optional	Script info	tasks.script
started optional	Task start time (UTC)	string (date-time)
status optional		tasks.task_status_enum
status_changed optional	Last status change time	string (date-time)
status_message optional	free text string representing info about the status	string
status_reason optional	Reason for last status change	string
system_tags optional	System tags list. This field is reserved for system use, please don't use it.	< string > array
tags optional	User-defined tags list	< string > array
type optional	Type of task. Values: 'dataset_import', 'annotation', 'training', 'testing'	tasks.task_type_enum
user optional	Associated user id	string

tasks.task_15

Name	Description	Schema
comment optional	Free text comment	string
company optional	Company ID	string
completed optional	Task end time (UTC)	string (date-time)
created optional	Task creation time (UTC)	string (date-time)
execution optional		tasks.execution_15
id optional	Task id	string
input optional		tasks.input
last_change optional	Last time any update was done to the task	string (date-time)
last_iteration optional	Last iteration reported for this task	integer
last_metrics optional	Last metric variants (hash to events), one for each metric hash	< string, tasks.last_metrics_variants > map
last_update optional	Last time this task was created, edited, changed or events for this task were reported	string (date-time)
last_worker optional	ID of last worker that handled the task	string
last_worker_report optional	Last time a worker reported while working on this task	string (date-time)
name optional	Task Name	string
output optional	Task output params	tasks.output
parent optional	Parent task id	string
project optional	Project ID of the project to which this task is assigned	string
published optional	Last status change time	string (date-time)
script optional		tasks.script
started optional	Task start time (UTC)	string (date-time)
status optional		tasks.task_status_enum
status_changed optional	Last status change time	string (date-time)
status_message optional	free text string representing info about the status	string
status_reason optional	Reason for last status change	string
system_tags optional	System tags list. This field is reserved for system use, please don't use it.	< string > array
tags optional	User-defined tags list	< string > array
type optional	Type of task. Values: 'dataset_import', 'annotation', 'training', 'testing'	tasks.task_type_enum
user optional	Associated user id	string

tasks.task_model_item

Name	Description	Schema
model required	The model ID	string
name required	The task model name	string

tasks.task_models

Name	Description	Schema
input optional	The list of task input models	< tasks.task_model_item > array
output optional	The list of task output models	< tasks.task_model_item > array

tasks.task_status_enum

Type : enum (created, queued, in_progress, stopped, published, publishing, closed, failed, completed, unknown)

tasks.task_type_enum

Type of task

Type : enum (dataset_import, annotation, annotation_manual, training, testing, inference, data_processing, application, monitor, controller, optimizer, service, qc, custom)

tasks.task_urls

Name	Schema
artifact_urls optional	< string > array
event_urls optional	< string > array
model_urls optional	< string > array

tasks.view

Name	Description	Schema
entries optional	List of view entries. All tasks must have at least one view.	< tasks.view_entry > array

tasks.view_entry

Name	Description	Schema
dataset optional	Existing Dataset id	string
merge_with optional	Version ID to merge with	string
version optional	Version id of a version belonging to the dataset	string

users.features_enum

Type : enum (user_management, user_management_advanced, permissions, applications, experiments, queues, queue_management, data_management, config_vault, app_management, pipelines, reports, show_dashboard, show_model_view, show_projects, resource_dashboard, sso_management, service_users, resource_policy, show_datasets, show_orchestration, model_serving, show_app_gateways, project_workloads, tenant_usages)

users.get_current_user_response_user_object

like user, but returns company object instead of ID

Name	Description	Schema
avatar optional		string
companies optional		< companies > array
company optional		company
created optional	User creation time	string (date-time)
created_in_version optional	Server version at user creation time	string
email optional	User email	string
family_name optional		string
given_name optional		string
id optional		string
name optional		string
preferences optional	User preferences	object
role optional		string
terms_of_use_ver_accepted optional		number

companies

Name	Schema
active optional	boolean
id optional	string
name optional	string
tier optional	enum (free, paid, suspended)

company

Name	Schema
id optional	string
name optional	string
tier optional	enum (free, paid, suspended)

users.get_current_user_response_user_object_v1_5

like user, but returns company object instead of ID

Name	Description	Schema
avatar optional		string
companies optional		< companies > array
company optional		company
email optional	User email	string
family_name optional		string
given_name optional		string
id optional		string
name optional		string
preferences optional	User preferences	object
role optional		string
terms_of_use_ver_accepted optional		number

companies

Name	Schema
active optional	boolean
id optional	string
name optional	string
tier optional	enum (free, paid, suspended)

company

Name	Schema
id optional	string
name optional	string
tier optional	enum (free, paid, suspended)

users.get_current_user_response_user_object_v_2_2_0

like user, but returns company object instead of ID

Name	Description	Schema
avatar optional		string
companies optional		< companies > array
company optional		company
created optional	User creation time	string (date-time)
email optional	User email	string
family_name optional		string
given_name optional		string
id optional		string
name optional		string
preferences optional	User preferences	object
role optional		string
terms_of_use_ver_accepted optional		number

companies

Name	Schema
active optional	boolean
id optional	string
name optional	string
tier optional	enum (free, paid, suspended)

company

Name	Schema
id optional	string
name optional	string
tier optional	enum (free, paid, suspended)

users.login_white_list_v1_5

Name	Description	Schema
company optional	Company	string
domain optional	Email domain name (all addresses under the domain are included in this whitelist entry)	string (hostname)
emails optional	List of email addresses (all addresses in this list are included in this whitelist entry)	< string (email) > array
group optional	Group ID to be assigned to users added through this whitelist	string
id optional	Whitelist entry ID	string

users.role

Type : enum (admin, superuser, user, annotator)

users.terms_of_use

Terms of use for the allegro.ai platform

Name	Description	Schema
created optional	Create time	string (date-time)
deprecated optional	Indicates whether this version has been deprecated	boolean
text optional	Terms of use text	string
update optional	Last update time	string (date-time)
version optional	Version number	number

users.user

Name	Description	Schema
activity optional		activity
avatar optional	Avatar URL	string
company optional	Company ID	string
created optional	User creation date	string (date-time)
email optional	User email	string (email)
family_name optional	Family name	string
given_name optional	Given name	string
id optional	User ID	string
name optional	Full name	string
providers optional	Providers uses has logged-in with	object
read_only optional	Whether the user can be deleted or his role edited	boolean
role optional	User's role (admin only)	string
sec_groups optional	The list of security groups that the user is member of	< string > array
support optional	Whether the user is a support user	boolean
terms_of_use_ver_accepted optional	Terms of Use version number accepted by the user	number

activity

Name	Description	Schema
last_credentials_login optional	The last time when user credentials were used	string (date-time)
last_provider optional	The provider that was used for the last login	string
last_provider_login optional	The last time when provider login was used used	string (date-time)
last_provider_name optional	The last provider name	string
last_ui_access optional	The last time when UI was accessed by the user	string (date-time)

users.vault

Name	Description	Schema
data optional	Vault data	string
description optional	Vault description	string
enabled optional	Is the vaule enabled or disabled Default : true	boolean
format optional	Vault data format Default : "hocon"	string
id optional	Vault ID	string
scope optional	Vault scope	enum (organization, group, user)
type optional	Vault document type Default : "config"	string

users.vault_data

Name	Description	Schema
data optional	Vault data	string
description optional	Vault description	string
editable optional	Whether the vault can be edited. False when server encryption is disabled and the vault contains encrypted data	boolean
enabled optional	Is the vaule enabled or disabled Default : true	boolean
format optional	Vault data format Default : "hocon"	string
group optional	ID of the group that the vault belongs to	string
group_name optional	The name of the vault group. Returned only for the group vaults	string
id optional	Vault ID	string
last_update optional	Last vault update time. Reflects the time when the vault was created or last updated	string (date-time)
scope optional	Vault scope	enum (organization, group, user)
type optional	Vault document type Default : "config"	string
user optional	ID of the user that the vault belongs to	string

variables.increment_command

Name	Description	Schema
allow_partial optional	If set then incrementing by a value that is smaller then requested is allowed Default : true	boolean
expiration_sec optional	Expiration period in seconds to retain the variable. If not set then the variable will never expire	integer
increment optional	The number to be added to the global var	string
key optional	The key of the variable to increment. The variable should hold an integer value	integer
max_allowed_value optional	The maximum allowed value for the variable after the increment. If not set then the operation is not limited	integer
min_allowed_value optional	The minimum allowed value for the variable after the increment. If not set then the operation is not limited	integer

variables.variable

Name	Description	Schema
expiration_sec optional	Expiration period in seconds to retain the variable. If not set then the variable will never expire	integer
key optional	Variable key	string
value optional	Variable value	string

workers.activity_series

Name	Description	Schema
counts optional	List of counts corresponding to the timestamps in the dates list.	< integer > array
dates optional	List of timestamps (in seconds from epoch) in the acceding order. The timestamps are separated by the requested interval.	< integer > array

workers.aggregation_stats

Name	Description	Schema
aggregation optional		workers.aggregation_type
dates optional	List of timestamps (in seconds from epoch) in the acceding order. The timestamps are separated by the requested interval. Timestamps where no workers activity was recorded are omitted.	< integer > array
resource_series optional	Metric data per single resource. Return only if split_by_resource request parameter is set to True	< workers.metric_resource_series > array
values optional	List of values corresponding to the dates in metric statistics	< number > array

workers.aggregation_type

Metric aggregation type

Type : enum (avg, min, max)

workers.current_task_entry

Name	Description	Schema
id optional	Worker ID	string
last_iteration optional	Last task iteration	integer
name optional	Worker name	string
running_time optional	Task running time	integer

workers.id_name_entry

Name	Description	Schema
id optional	Worker ID	string
name optional	Worker name	string

workers.machine_stats

Name	Description	Schema
cpu_temperature optional	CPU temperature	< number > array
cpu_usage optional	Average CPU usage per core	< number > array
disk_free_home optional	Free space in % of /home drive	number
disk_free_temp optional	Free space in % of /tmp drive	number
disk_read optional	Mbytes read per second	number
disk_write optional	Mbytes write per second	number
gpu_fraction optional	GPU fraction	< number > array
gpu_memory_free optional	GPU free memory MBs	< number > array
gpu_memory_used optional	GPU used memory MBs	< number > array
gpu_temperature optional	GPU temperature	< number > array
gpu_usage optional	Average GPU usage per GPU card	< number > array
memory_free optional	Free memory MBs	number
memory_used optional	Used memory MBs	number
network_rx optional	Mbytes per second	number
network_tx optional	Mbytes per second	number

workers.metric_resource_series

Name	Description	Schema
name optional	Resource name	string
values optional	List of values corresponding to the dates in metric statistics	< number > array

workers.metric_stats

Name	Description	Schema
metric optional	Name of the metric (cpu_usage, memory_used etc.)	string
stats optional	Statistics data by type	< workers.aggregation_stats > array
variant optional	Name of the metric component. Set only if 'split_by_variant' was set in the request	string

workers.metrics_category

Name	Description	Schema
metric_keys optional	The names of the metrics in the category.	< string > array
name optional	Name of the metrics category.	string

workers.queue_entry

Name	Description	Schema
display_name optional	Display name for the queue (if defined)	string
id optional	Worker ID	string
name optional	Worker name	string
next_task optional	Next task in the queue	workers.id_name_entry
num_tasks optional	Number of task entries in the queue	integer

workers.resource_usage_series

Name	Description	Schema
dates optional	List of timestamps (in seconds from epoch) in the acceding order. The timestamps are separated by the requested interval.	< integer > array
title optional	The title of the series	string
values optional	List of values corresponding to the timestamps in the dates list.	< number > array

workers.stat_item

Name	Description	Schema
category optional		workers.aggregation_type
key optional	Name of a metric	enum (cpu_usage, cpu_temperature, memory_used, memory_free, gpu_usage, gpu_temperature, gpu_fraction, gpu_memory_free, gpu_memory_used, network_tx, network_rx, disk_free_home, disk_free_temp, disk_read, disk_write)

workers.worker

Name	Description	Schema
company optional	Associated company	workers.id_name_entry
id optional	Worker ID	string
ip optional	IP of the worker	string
key optional	Worker entry key	string
last_activity_time optional	Last activity time (even if an error occurred)	string (date-time)
last_report_time optional	Last successful report time	string (date-time)
project optional	Project in which currently executing task resides	workers.id_name_entry
queue optional	Queue from which running task was taken	workers.queue_entry
queues optional	List of queues on which the worker is listening	< workers.queue_entry > array
register_time optional	Registration time	string (date-time)
system_tags optional	System tags for the worker	< string > array
tags optional	User tags for the worker	< string > array
task optional	Task currently being run by the worker	workers.current_task_entry
user optional	Associated user (under whose credentials are used by the worker daemon)	workers.id_name_entry

workers.worker_stats

Name	Description	Schema
metrics optional	List of the metrics statistics for the worker	< workers.metric_stats > array
worker optional	ID of the worker	string

workers.worker_v1_5

Name	Description	Schema
company optional	Associated company	workers.id_name_entry
id optional	Worker ID	string
ip optional	IP of the worker	string
last_activity_time optional	Last activity time (even if an error occurred)	string (date-time)
last_report_time optional	Last successful report time	string (date-time)
queue optional	ID of the queue from which task was received	string
queues optional	List of queue IDs on which the worker is listening	< string > array
register_time optional	Registration time	string (date-time)
task optional	Task currently being run by the worker	workers.id_name_entry
user optional	Associated user (under whose credentials are used by the worker daemon)	workers.id_name_entry