Skip to main content

API Definitions

Definitions#

auth.credential_key#

NameSchema
access_key
optional
string
last_used
optional
string (date-time)

auth.credentials#

NameDescriptionSchema
access_key
optional
Credentials access keystring
secret_key
optional
Credentials secret keystring

auth.role#

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

events.debug_image_sample_reposnse#

NameDescriptionSchema
event
optional
Debug image eventobject
max_iteration
optional
maximal valid iteration for the variantinteger
min_iteration
optional
minimal valid iteration for the variantinteger
scroll_id
optional
Scroll ID to pass to the next calls to get_debug_image_sample or next_debug_image_samplestring

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#

Type : object

events.metrics_image_event#

An image or video was dumped to storage for debugging

NameDescriptionSchema
iter
optional
Iterationinteger
key
optional
File keystring
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
url
optional
File URLstring
variant
optional
E.g. 'class_1', 'total', 'averagestring

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.

NameDescriptionSchema
iter
optional
Iterationinteger
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 Falseboolean
task
required
Task ID (required)string
timestamp
optional
Epoch milliseconds UTC, will be set by the server if not set.number
variant
optional
E.g. 'class_1', 'total', 'averagestring

events.metrics_scalar_event#

Used for reporting scalar metrics during training task

NameDescriptionSchema
iter
optional
Iterationinteger
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
value
optional
number
variant
optional
E.g. 'class_1', 'total', 'averagestring

events.metrics_vector_event#

Used for reporting vector metrics during training task

NameDescriptionSchema
iter
optional
Iterationinteger
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
values
optional
vector of float values< number > array
variant
optional
E.g. 'class_1', 'total', 'averagestring

events.scalar_key_enum#

Type : enum (iter, timestamp, iso_time)

events.task_log_event#

A log event associated with a task.

NameDescriptionSchema
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
worker
optional
Name of machine running the task.string

events.task_metric#

NameDescriptionSchema
metric
optional
Metric namestring
task
required
Task IDstring

events.task_metric_variants#

NameDescriptionSchema
metric
optional
Metric namestring
task
required
Task IDstring
variants
optional
Metric variant names< string > array

models.metadata_item#

NameDescriptionSchema
key
optional
The key uniquely identifying the metadata item inside the given entitystring
type
optional
The type of the metadata itemstring
value
optional
The value stored in the metadata itemstring

models.model#

NameDescriptionSchema
comment
optional
Model commentstring
company
optional
Company idstring
created
optional
Model creation timestring (date-time)
design
optional
Json object representing the model design. Should be identical to the network design of the task which created the modelobject
framework
optional
Framework on which the model is based. Should be identical to the framework of the task which created the modelstring
id
optional
Model idstring
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_update
optional
Model last update timestring (date-time)
metadata
optional
Model metadata< models.metadata_item > array
name
optional
Model namestring
parent
optional
Parent model IDstring
project
optional
Associated project IDstring
ready
optional
Indication if the model is final and can be used by other tasksboolean
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
task
optional
Task ID of task in which the model was createdstring
ui_cache
optional
UI cache for this modelobject
uri
optional
URI for the model, pointing to the destination storage.string
user
optional
Associated user idstring

models.multi_field_pattern_data#

NameDescriptionSchema
fields
optional
List of field names< string > array
pattern
optional
Pattern string (regex)string

projects.metric_variant_result#

NameDescriptionSchema
metric
optional
Metric namestring
metric_hash
optional
Metric name hash. Used instead of the metric name when categorizing
last metrics events in task objects.
string
variant
optional
Variant namestring
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#

NameDescriptionSchema
fields
optional
List of field names< string > array
pattern
optional
Pattern string (regex)string

projects.project#

NameDescriptionSchema
company
optional
Company idstring
created
optional
Creation timestring (date-time)
default_output_destination
optional
The default output destination URL for new tasks under this projectstring
description
optional
Project descriptionstring
id
optional
Project idstring
last_update
optional
Last project update time. Reflects the last time the project metadata was changed or a task in this project has changed statusstring (date-time)
name
optional
Project namestring
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 idstring

projects.projects_get_all_response_single#

NameDescriptionSchema
company
optional
Company idstring
created
optional
Creation timestring (date-time)
default_output_destination
optional
The default output destination URL for new tasks under this projectstring
description
optional
Project descriptionstring
id
optional
Project idstring
name
optional
Project namestring
stats
optional
Additional project statsprojects.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 idstring

sub_projects

NameDescriptionSchema
id
optional
Subproject IDstring
name
optional
Subproject namestring

projects.stats#

NameDescriptionSchema
active
optional
Stats for active tasksprojects.stats_status_count
archived
optional
Stats for archived tasksprojects.stats_status_count

projects.stats_status_count#

NameDescriptionSchema
status_count
optional
Status countsstatus_count
total_runtime
optional
Total run time of all tasks in project (in seconds)integer

status_count

NameDescriptionSchema
closed
optional
Number of 'closed' tasks in projectinteger
created
optional
Number of 'created' tasks in projectinteger
failed
optional
Number of 'failed' tasks in projectinteger
in_progress
optional
Number of 'in_progress' tasks in projectinteger
published
optional
Number of 'published' tasks in projectinteger
queued
optional
Number of 'queued' tasks in projectinteger
stopped
optional
Number of 'stopped' tasks in projectinteger
unknown
optional
Number of 'unknown' tasks in projectinteger

projects.urls#

NameSchema
artifact_urls
optional
< string > array
event_urls
optional
< string > array
model_urls
optional
< string > array

queues.entry#

NameDescriptionSchema
added
optional
Time this entry was added to the queuestring (date-time)
task
optional
Queued task IDstring

queues.metadata_item#

NameDescriptionSchema
key
optional
The key uniquely identifying the metadata item inside the given entitystring
type
optional
The type of the metadata itemstring
value
optional
The value stored in the metadata itemstring

queues.queue#

NameDescriptionSchema
company
optional
Company idstring
created
optional
Queue creation timestring (date-time)
entries
optional
List of ordered queue entries< queues.entry > array
id
optional
Queue idstring
metadata
optional
Queue metadata< queues.metadata_item > array
name
optional
Queue namestring
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 idstring

queues.queue_metrics#

NameDescriptionSchema
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 queuestring
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

tasks.artifact#

NameDescriptionSchema
content_size
optional
Raw data length in bytesinteger
display_data
optional
User-defined list of key/value pairs, sorted< < string > array > array
hash
optional
Hash of entire raw datastring
key
required
Entry keystring
mode
optional
System defined input/output indicationtasks.artifact_mode_enum
timestamp
optional
Epoch time when artifact was createdinteger
type
required
System defined typestring
type_data
optional
Additional fields defined by the systemtasks.artifact_type_data
uri
optional
Raw data locationstring

tasks.artifact_id#

NameDescriptionSchema
key
required
Entry keystring
mode
optional
System defined input/output indicationtasks.artifact_mode_enum

tasks.artifact_mode_enum#

Type : enum (input, output)

tasks.artifact_type_data#

NameDescriptionSchema
content_type
optional
System defined raw data content typestring
data_hash
optional
Hash of raw data, without any headers or descriptive partsstring
preview
optional
Description or textual datastring

tasks.configuration_item#

NameDescriptionSchema
description
optional
The parameter description. Optionalstring
name
optional
Name of the parameter. Should be uniquestring
type
optional
Type of the parameter. Optionalstring
value
optional
Value of the parameterstring

tasks.execution#

NameDescriptionSchema
artifacts
optional
Task artifacts< tasks.artifact > array
docker_cmd
optional
Command for running docker script for the execution of the taskstring
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) tasksstring
model_desc
optional
Json object representing the Model descriptorsobject
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 parametersobject
queue
optional
Queue ID where task was queued.string

tasks.last_metrics_event#

NameDescriptionSchema
max_value
optional
Maximum value reportednumber
metric
optional
Metric namestring
min_value
optional
Minimum value reportednumber
value
optional
Last value reportednumber
variant
optional
Variant namestring

tasks.last_metrics_variants#

Last metric events, one for each variant hash

Type : < string, tasks.last_metrics_event > map

tasks.model_type_enum#

Type : enum (input, output)

tasks.multi_field_pattern_data#

NameDescriptionSchema
fields
optional
List of field names< string > array
pattern
optional
Pattern string (regex)string

tasks.output#

NameDescriptionSchema
destination
optional
Storage id. This is where output files will be stored.string
error
optional
Last error textstring
model
optional
Model id.string
result
optional
Task result. Values: 'success', 'failure'string

tasks.param_key#

NameDescriptionSchema
name
optional
Name of the parameter. If the name is ommitted then the corresponding operation is performed on the whole sectionstring
section
optional
Section that the parameter belongs tostring

tasks.params_item#

NameDescriptionSchema
description
optional
The parameter description. Optionalstring
name
optional
Name of the parameter. The combination of section and name should be uniquestring
section
optional
Section that the parameter belongs tostring
type
optional
Type of the parameter. Optionalstring
value
optional
Value of the parameterstring

tasks.replace_hyperparams_enum#

Type : enum (none, section, all)

tasks.script#

NameDescriptionSchema
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 runstring
entry_point
optional
Path to execute within the repositorystring
repository
optional
Name of the repository where the script is locatedstring
requirements
optional
A JSON object containing requirements strings by keyobject
tag
optional
Repository tagstring
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 repositorystring

tasks.section_params#

Task section params

Type : < string, tasks.params_item > map

tasks.task#

NameDescriptionSchema
active_duration
optional
Task duration time (seconds)integer
comment
optional
Free text commentstring
company
optional
Company IDstring
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 paramstasks.execution
hyperparams
optional
Task hyper params per section< string, tasks.section_params > map
id
optional
Task idstring
last_change
optional
Last time any update was done to the taskstring (date-time)
last_iteration
optional
Last iteration reported for this taskinteger
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, updated, changed or events for this task were reportedstring (date-time)
last_worker
optional
ID of last worker that handled the taskstring
last_worker_report
optional
Last time a worker reported while working on this taskstring (date-time)
models
optional
Task modelstasks.task_models
name
optional
Task Namestring
output
optional
Task output paramstasks.output
parent
optional
Parent task idstring
project
optional
Project ID of the project to which this task is assignedstring
published
optional
Last status change timestring (date-time)
runtime
optional
Task runtime mappingobject
script
optional
Script infotasks.script
started
optional
Task start time (UTC)string (date-time)
status
optional
tasks.task_status_enum
status_changed
optional
Last status change timestring (date-time)
status_message
optional
free text string representing info about the statusstring
status_reason
optional
Reason for last status changestring
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: 'training', 'testing'tasks.task_type_enum
user
optional
Associated user idstring

tasks.task_model_item#

NameDescriptionSchema
model
required
The model IDstring
name
required
The task model namestring

tasks.task_models#

NameDescriptionSchema
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 : enum (training, testing, inference, data_processing, application, monitor, controller, optimizer, service, qc, custom)

tasks.task_urls#

NameSchema
artifact_urls
optional
< string > array
event_urls
optional
< string > array
model_urls
optional
< string > array

users.get_current_user_response_user_object#

like user, but returns company object instead of ID

NameDescriptionSchema
avatar
optional
string
company
optional
company
family_name
optional
string
given_name
optional
string
id
optional
string
name
optional
string
preferences
optional
User preferencesobject
role
optional
string

company

NameSchema
id
optional
string
name
optional
string

users.user#

NameDescriptionSchema
avatar
optional
Avatar URLstring
company
optional
Company IDstring
created
optional
User creation datestring (date-time)
email
optional
User emailstring (email)
family_name
optional
Family namestring
given_name
optional
Given namestring
id
optional
User IDstring
name
optional
Full namestring
providers
optional
Providers uses has logged-in withobject
role
optional
User's role (admin only)string

workers.activity_series#

NameDescriptionSchema
counts
optional
List of worker counts corresponding to the timestamps in the dates list. None values are returned for the dates with no workers.< 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#

NameDescriptionSchema
aggregation
optional
workers.aggregation_type
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#

NameDescriptionSchema
id
optional
IDstring
last_iteration
optional
Last task iterationinteger
name
optional
Namestring
running_time
optional
Task running timeinteger

workers.id_name_entry#

NameDescriptionSchema
id
optional
IDstring
name
optional
Namestring

workers.machine_stats#

NameDescriptionSchema
cpu_temperature
optional
CPU temperature< number > array
cpu_usage
optional
Average CPU usage per core< number > array
disk_free_home
optional
Mbytes free space of /home driveinteger
disk_free_temp
optional
Mbytes free space of /tmp driveinteger
disk_read
optional
Mbytes read per secondinteger
disk_write
optional
Mbytes write per secondinteger
gpu_memory_free
optional
GPU free memory MBs< integer > array
gpu_memory_used
optional
GPU used memory MBs< integer > array
gpu_temperature
optional
GPU temperature< number > array
gpu_usage
optional
Average GPU usage per GPU card< number > array
memory_free
optional
Free memory MBsinteger
memory_used
optional
Used memory MBsinteger
network_rx
optional
Mbytes per secondinteger
network_tx
optional
Mbytes per secondinteger

workers.metric_stats#

NameDescriptionSchema
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
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 requeststring

workers.metrics_category#

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

workers.queue_entry#

NameDescriptionSchema
id
optional
IDstring
name
optional
Namestring
next_task
optional
Next task in the queueworkers.id_name_entry
num_tasks
optional
Number of task entries in the queueinteger

workers.stat_item#

NameDescriptionSchema
category
optional
workers.aggregation_type
key
optional
Name of a metricstring

workers.worker#

NameDescriptionSchema
company
optional
Associated companyworkers.id_name_entry
id
optional
Worker IDstring
ip
optional
IP of the workerstring
last_activity_time
optional
Last activity time (even if an error occurred)string (date-time)
last_report_time
optional
Last successful report timestring (date-time)
project
optional
Project in which currently executing task residesworkers.id_name_entry
queue
optional
Queue from which running task was takenworkers.queue_entry
queues
optional
List of queues on which the worker is listening< workers.queue_entry > array
register_time
optional
Registration timestring (date-time)
tags
optional
User tags for the worker< string > array
task
optional
Task currently being run by the workerworkers.current_task_entry
user
optional
Associated user (under whose credentials are used by the worker daemon)workers.id_name_entry

workers.worker_stats#

NameDescriptionSchema
metrics
optional
List of the metrics statistics for the worker< workers.metric_stats > array
worker
optional
ID of the workerstring