Skip to main content

REST API

Resources#

Auth#

This service provides authentication management and authorization validation for the entire system.

Debug#

debugging utilities

POST /debug.ping#

Description#

Ping server

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyobject

Responses#

HTTP CodeSchema
200object

Events#

Provides an API for running tasks to report events collected by the system.

POST /events.add#

Description#

Adds a single event

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyobject

Responses#

HTTP CodeSchema
200object

POST /events.add_batch#

Description#

Adds a batch of events in a single call (json-lines format, stream-friendly)

Parameters#

TypeNameDescriptionSchema
Bodyrequests
required
Json encoded newline-terminated lines, each representing an event in the batch and uses the same parameters used for events.add< object > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
added
optional
integer
errors
optional
integer
errors_info
optional
object

POST /events.debug_images#

Description#

Get the debug image events for the requested amount of iterations per each task

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
iters
optional
Max number of latest iterations for which to return debug imagesinteger
metrics
required
List of metrics and variants< events.task_metric_variants > array
navigate_earlier
optional
If set then events are retreived from latest iterations to earliest ones.
Otherwise from earliest iterations to the latest. The default is True
boolean
refresh
optional
If set then scroll will be moved to the latest iterations. The default is Falseboolean
scroll_id
optional
Scroll ID of previous call (used for getting more results)string

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
metrics
optional
Debug image events grouped by task metrics and iterations< object > array
scroll_id
optional
Scroll ID for getting more resultsstring

POST /events.delete_for_task#

Description#

Delete all task event. This cannot be undone!

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
allow_locked
optional
Allow deleting events even if the task is locked
Default : false
boolean
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
deleted
optional
Number of deleted eventsboolean

POST /events.download_task_log#

Description#

Get an attachment containing the task's log

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
line_format
optional
Line string format. Used if the line type is 'text'
Default : "{asctime} {worker} {level} {msg}"
string
line_type
optional
Line format typeenum (json, text)
task
required
Task IDstring

Responses#

HTTP CodeSchema
200string

POST /events.get_debug_image_sample#

Description#

Return the debug image per metric and variant for the provided iteration

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
iteration
optional
The iteration to bring debug image from. If not specified then the latest
reported image is retrieved
integer
metric
required
Metric namestring
refresh
optional
If set then scroll state will be refreshed to reflect the latest changes in the
debug images
boolean
scroll_id
optional
Scroll ID from the previous call to get_debug_image_sample or emptystring
task
required
Task IDstring
variant
required
Metric variantstring

Responses#

HTTP CodeSchema
200events.debug_image_sample_reposnse

POST /events.get_multi_task_plots#

Description#

Get 'plot' events for the given tasks

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
iters
optional
Max number of latest iterations for which to return debug imagesinteger
scroll_id
optional
Scroll ID of previous call (used for getting more results)string
tasks
required
List of task IDs< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
plots
optional
Plots mapping (keyed by task name)object
returned
optional
Number of results returnedinteger
scroll_id
optional
Scroll ID for getting more resultsstring
total
optional
Total number of results available for this querynumber

POST /events.get_scalar_metric_data#

Description#

get scalar metric data for task

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
metric
optional
type of metricstring
task
optional
task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
events
optional
task scalar metric events< object > array
returned
optional
amount of events returnedinteger
scroll_id
optional
Scroll ID of previous call (used for getting more results)string
total
optional
amount of events in taskinteger

POST /events.get_scalar_metrics_and_variants#

Description#

get task scalar metrics and variants

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
task
required
task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
metrics
optional
object

POST /events.get_task_events#

Description#

Scroll through task events, sorted by timestamp

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
batch_size
optional
Number of events to return each time (default 500)integer
event_type
optional
Return only events of this typestring
order
optional
'asc' (default) or 'desc'.enum (asc, desc)
scroll_id
optional
Pass this value on next call to get next pagestring
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
events
optional
Events list< object > array
returned
optional
Number of results returnedinteger
scroll_id
optional
Scroll ID for getting more resultsstring
total
optional
Total number of results available for this querynumber

POST /events.get_task_latest_scalar_values#

Description#

Get the tasks's latest scalar values

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
metrics
optional
< metrics > array

metrics

NameDescriptionSchema
name
optional
Metric namestring
variants
optional
< variants > array

variants

NameDescriptionSchema
last_100_value
optional
Average of 100 last reported valuesnumber
last_value
optional
Last reported valuenumber
name
optional
Variant namestring

POST /events.get_task_log#

Description#

Get 'log' events for this task

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
batch_size
optional
The amount of log events to returninteger
from_timestamp
optional
Epoch time in UTC ms to use as the navigation start. Optional. If not provided,
reference timestamp is determined by the 'navigate_earlier' parameter (if true,
reference timestamp is the last timestamp and if false, reference timestamp is
the first timestamp)
number
navigate_earlier
optional
If set then log events are retreived from the latest to the earliest ones (in
timestamp descending order, unless order='asc'). Otherwise from the earliest to
the latest ones (in timestamp ascending order, unless order='desc'). The
default is True
boolean
order
optional
If set, changes the order in which log events are returned based on the value
of 'navigate_earlier'
enum (asc, desc)
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
events
optional
Log items list< object > array
returned
optional
Number of log events returnedinteger
total
optional
Total number of log events available for this querynumber

POST /events.get_task_metrics#

Description#

For each task, get a list of metrics for which the requested event type was
reported

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
event_type
optional
Event typeevents.event_type_enum
tasks
required
Task IDs< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
metrics
optional
List of task with their metrics< object > array

POST /events.get_task_plots#

Description#

Get all 'plot' events for this task

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
iters
optional
Max number of latest iterations for which to return debug imagesinteger
metrics
optional
List of metrics and variants< events.metric_variants > array
scroll_id
optional
Scroll ID of previous call (used for getting more results)string
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
plots
optional
Plots list< object > array
returned
optional
Number of results returnedinteger
scroll_id
optional
Scroll ID for getting more resultsstring
total
optional
Total number of results available for this querynumber

POST /events.get_vector_metrics_and_variants#

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
metrics
optional
< object > array

POST /events.multi_task_scalar_metrics_iter_histogram#

Description#

Used to compare scalar stats histogram of multiple tasks

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
key
optional
Histogram x axis to use: iter - iteration number iso_time - event time as ISO
formatted string timestamp - event timestamp as milliseconds since epoch
events.scalar_key_enum
samples
optional
The amount of histogram points to return. Optional, the default value is 6000integer
tasks
required
List of task Task IDs. Maximum amount of tasks is 10< string > array

Responses#

HTTP CodeSchema
200object

POST /events.next_debug_image_sample#

Description#

Get the image for the next variant for the same iteration or for the next
iteration

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
navigate_earlier
optional
If set then get the either previous variant event from the current iteration or
(if does not exist) the last variant event from the previous iteration.
Otherwise next variant event from the current iteration or first variant event
from the next iteration
boolean
scroll_id
required
Scroll ID from the previous call to get_debug_image_samplestring
task
required
Task IDstring

Responses#

HTTP CodeSchema
200events.debug_image_sample_reposnse

POST /events.scalar_metrics_iter_histogram#

Description#

Get histogram data of all the vector metrics and variants in the task

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
key
optional
Histogram x axis to use: iter - iteration number iso_time - event time as ISO
formatted string timestamp - event timestamp as milliseconds since epoch
events.scalar_key_enum
metrics
optional
List of metrics and variants< events.metric_variants > array
samples
optional
The amount of histogram points to return (0 to return all the points).
Optional, the default value is 6000.
integer
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
images
optional
< object > array

POST /events.vector_metrics_iter_histogram#

Description#

Get histogram data of all the scalar metrics and variants in the task

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
metric
required
string
task
required
Task IDstring
variant
required
string

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
images
optional
< object > array

Login#

This service provides an administrator management interface to the company's users login information.

POST /login.logout#

Description#

Logout (including SSO, if used))

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyobject

Responses#

HTTP CodeSchema
200object

POST /login.supported_modes#

Description#

Return supported login modes.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
callback_url_prefix
optional
URL prefix used to generate the callback URL for each supported SSO providerstring
state
optional
ASCII base64 encoded application statestring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
authenticated
optional
Is user authenticatedboolean
basic
optional
basic
server_errors
optional
Server initialization errorsserver_errors
sso
optional
SSO authentication providers< string, string > map
sso_providers
optional
The list of SSO authentication providers< object > array

basic

NameDescriptionSchema
enabled
optional
Basic aothentication (fixed users mode) mode enabledboolean
guest
optional
guest

guest

NameDescriptionSchema
enabled
optional
Basic aothentication guest mode enabledboolean
name
optional
Guest namestring
password
optional
Guest passwordstring
username
optional
Guest usernamestring

server_errors

NameDescriptionSchema
es_connection_error
optional
Indicate an error communicating to Elasticsearchboolean
missed_es_upgrade
optional
Indicate that Elasticsearch database was not upgraded from version 5boolean

Models#

This service provides a management interface for models (results of training tasks) stored in the system.

POST /models.add_or_update_metadata#

Description#

Add or update model metadata

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
metadata
required
Metadata items to add or update< models.metadata_item > array
model
required
ID of the modelstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of models updated (0 or 1)integer

POST /models.archive_many#

Description#

Archive models

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
ids
required
IDs of models to archive< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
failed
optional
< failed > array
succeeded
optional
< succeeded > array

failed

NameDescriptionSchema
error
optional
Error infoerror
id
optional
ID of the failed entitystring

error

NameSchema
codes
optional
< integer > array
data
optional
object
msg
optional
string

succeeded

NameDescriptionSchema
archived
optional
Indicates whether the model was archivedboolean
id
optional
ID of the succeeded entitystring

POST /models.create#

Description#

Create a new model not associated with a task

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
comment
optional
Model commentstring
design
optional
Json[d] 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. Case insensitive. Should be identical to
the framework of the task which created the model.
string
labels
optional
Json object< string, integer > map
name
required
Model name Unique within the company.string
parent
optional
Parent modelstring
project
optional
Project to which to model belongsstring
public
optional
Create a public model Default is false.
Default : false
boolean
ready
optional
Indication if the model is final and can be used by other tasks. Default is
false.
Default : false
boolean
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
Associated task IDstring
uri
required
URI for the modelstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
created
optional
Was the model createdboolean
id
optional
ID of the modelstring

POST /models.delete#

Description#

Delete a model.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
Force. Required if there are tasks that use the model as an execution model, or
if the model's creating task is published.
boolean
model
required
Model IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
deleted
optional
Indicates whether the model was deletedboolean
url
optional
The url of the model filestring

POST /models.delete_many#

Description#

Delete models

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
Force. Required if there are tasks that use the model as an execution model, or
if the model's creating task is published.
boolean
ids
required
IDs of models to delete< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
failed
optional
< failed > array
succeeded
optional
< succeeded > array

failed

NameDescriptionSchema
error
optional
Error infoerror
id
optional
ID of the failed entitystring

error

NameSchema
codes
optional
< integer > array
data
optional
object
msg
optional
string

succeeded

NameDescriptionSchema
deleted
optional
Indicates whether the model was deletedboolean
id
optional
ID of the succeeded entitystring
url
optional
The url of the model filestring

POST /models.delete_metadata#

Description#

Delete metadata from model

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
keys
required
The list of metadata keys to delete< string > array
model
required
ID of the modelstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of models updated (0 or 1)integer

POST /models.edit#

Description#

Edit an existing model

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
comment
optional
Model commentstring
design
optional
Json[d] 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. Case insensitive. Should be identical to
the framework of the task which created the model.
string
iteration
optional
Iteration (used to update task statistics)integer
labels
optional
Json object< string, integer > map
model
required
Model IDstring
name
optional
Model name Unique within the company.string
parent
optional
Parent modelstring
project
optional
Project to which to model belongsstring
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
Associated task IDstring
uri
optional
URI for the modelstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of models updated (0 or 1)integer

POST /models.get_all#

Description#

Get all models

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
all
optional
Multi-field pattern condition (all fields match pattern)models.multi_field_pattern_data
any
optional
Multi-field pattern condition (any field matches pattern)models.multi_field_pattern_data
framework
optional
List of frameworks< string > array
id
optional
List of model IDs< string > array
name
optional
Get only models whose name matches this pattern (python regular expression
syntax)
string
only_fields
optional
List of model field names (if applicable, nesting is supported using '.'). If
provided, this list defines the query's projection (only these fields will be
returned for each result entry)
< string > array
order_by
optional
List of field names to order by. When search_text is used, '@text_score' can be
used as a field representing the text score of returned documents. Use '-'
prefix to specify descending order. Optional, recommended when using page
< string > array
page
optional
Page number, returns a specific page out of the resulting list of models
Minimum value : 0
integer
page_size
optional
Page size, specifies the number of results returned in each page (last page may
contain fewer results)
Minimum value : 1
integer
project
optional
List of associated project IDs< string > array
ready
optional
Indication whether to retrieve only models that are marked ready If not
supplied returns both ready and not-ready projects.
boolean
search_text
optional
Free text search querystring
system_tags
optional
System tags list used to filter results. Prepend '-' to system tag name to
indicate exclusion
< string > array
tags
optional
User-defined tags list used to filter results. Prepend '-' to tag name to
indicate exclusion
< string > array
task
optional
List of associated task IDs< string > array
uri
optional
List of model URIs< string > array
user
optional
List of user IDs used to filter results by the model's creating user< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
models
optional
Models list< models.model > array

POST /models.get_all_ex#

Description#

Get all models

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
all
optional
Multi-field pattern condition (all fields match pattern)models.multi_field_pattern_data
any
optional
Multi-field pattern condition (any field matches pattern)models.multi_field_pattern_data
framework
optional
List of frameworks< string > array
id
optional
List of model IDs< string > array
include_subprojects
optional
If set to 'true' and project field is set then models from the subprojects are
searched too
Default : false
boolean
name
optional
Get only models whose name matches this pattern (python regular expression
syntax)
string
only_fields
optional
List of model field names (if applicable, nesting is supported using '.'). If
provided, this list defines the query's projection (only these fields will be
returned for each result entry)
< string > array
order_by
optional
List of field names to order by. When search_text is used, '@text_score' can be
used as a field representing the text score of returned documents. Use '-'
prefix to specify descending order. Optional, recommended when using page
< string > array
page
optional
Page number, returns a specific page out of the resulting list of models
Minimum value : 0
integer
page_size
optional
Page size, specifies the number of results returned in each page (last page may
contain fewer results)
Minimum value : 1
integer
project
optional
List of associated project IDs< string > array
ready
optional
Indication whether to retrieve only models that are marked ready If not
supplied returns both ready and not-ready projects.
boolean
search_text
optional
Free text search querystring
system_tags
optional
System tags list used to filter results. Prepend '-' to system tag name to
indicate exclusion
< string > array
tags
optional
User-defined tags list used to filter results. Prepend '-' to tag name to
indicate exclusion
< string > array
task
optional
List of associated task IDs< string > array
uri
optional
List of model URIs< string > array
user
optional
List of user IDs used to filter results by the model's creating user< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
models
optional
Models list< models.model > array

POST /models.get_by_id#

Description#

Gets model information

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
model
required
Model idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
model
optional
Model infomodels.model

POST /models.get_by_id_ex#

Description#

Get all models

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
all
optional
Multi-field pattern condition (all fields match pattern)models.multi_field_pattern_data
any
optional
Multi-field pattern condition (any field matches pattern)models.multi_field_pattern_data
framework
optional
List of frameworks< string > array
id
optional
List of model IDs< string > array
name
optional
Get only models whose name matches this pattern (python regular expression
syntax)
string
only_fields
optional
List of model field names (if applicable, nesting is supported using '.'). If
provided, this list defines the query's projection (only these fields will be
returned for each result entry)
< string > array
order_by
optional
List of field names to order by. When search_text is used, '@text_score' can be
used as a field representing the text score of returned documents. Use '-'
prefix to specify descending order. Optional, recommended when using page
< string > array
page
optional
Page number, returns a specific page out of the resulting list of models
Minimum value : 0
integer
page_size
optional
Page size, specifies the number of results returned in each page (last page may
contain fewer results)
Minimum value : 1
integer
project
optional
List of associated project IDs< string > array
ready
optional
Indication whether to retrieve only models that are marked ready If not
supplied returns both ready and not-ready projects.
boolean
search_text
optional
Free text search querystring
system_tags
optional
System tags list used to filter results. Prepend '-' to system tag name to
indicate exclusion
< string > array
tags
optional
User-defined tags list used to filter results. Prepend '-' to tag name to
indicate exclusion
< string > array
task
optional
List of associated task IDs< string > array
uri
optional
List of model URIs< string > array
user
optional
List of user IDs used to filter results by the model's creating user< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
models
optional
Models list< models.model > array

POST /models.get_by_task_id#

Description#

Gets model information

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
task
optional
Task idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
model
optional
Model infomodels.model

POST /models.get_frameworks#

Description#

Get the list of frameworks used in the company models

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
projects
optional
The list of projects which models will be analyzed. If not passed or empty then
all the company and public models will be analyzed
< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
frameworks
optional
Unique list of the frameworks used in the company models< string > array

POST /models.make_private#

Description#

Convert public models to private

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
ids
optional
Ids of the models to convert. Only the models originated by the company can be
converted
< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of models updatedinteger

POST /models.make_public#

Description#

Convert company models to public

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
ids
optional
Ids of the models to convert< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of models updatedinteger

POST /models.move#

Description#

Move models to a project

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
ids
required
Models to move< string > array
project
optional
Target project ID. If not provided, project_name must be provided.string
project_name
optional
Target project name. If provided and a project with this name does not exist, a
new project will be created. If not provided, project must be provided.
string

Responses#

HTTP CodeSchema
200object

POST /models.publish_many#

Description#

Publish models

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force_publish_task
optional
Publish the associated tasks (if exist) even if they are not in the 'stopped'
state. Optional, the default value is False.
boolean
ids
required
IDs of models to publish< string > array
publish_tasks
optional
Indicates that the associated tasks (if exist) should be published. Optional,
the default value is True.
boolean

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
failed
optional
< failed > array
succeeded
optional
< succeeded > array

failed

NameDescriptionSchema
error
optional
Error infoerror
id
optional
ID of the failed entitystring

error

NameSchema
codes
optional
< integer > array
data
optional
object
msg
optional
string

succeeded

NameDescriptionSchema
id
optional
ID of the succeeded entitystring
published_task
optional
Result of publishing of the model's associated task (if exists). Returned only if the task was published successfully as part of the model publishing.published_task
updated
optional
Indicates whether the model was updatedboolean

published_task

NameDescriptionSchema
data
optional
Data returned from the task publishing operation.data
id
optional
Task idstring

data

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of tasks updated (0 or 1)integer

POST /models.set_ready#

Description#

Set the model ready flag to True. If the model is an output model of a task
then try to publish the task.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force_publish_task
optional
Publish the associated task (if exists) even if it is not in the 'stopped'
state. Optional, the default value is False.
boolean
model
required
Model idstring
publish_task
optional
Indicates that the associated task (if exists) should be published. Optional,
the default value is True.
boolean

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
published_task
optional
Result of publishing of the model's associated task (if exists). Returned only
if the task was published successfully as part of the model publishing.
published_task
updated
optional
Number of models updated (0 or 1)integer

published_task

NameDescriptionSchema
data
optional
Data returned from the task publishing operation.data
id
optional
Task idstring

data

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of tasks updated (0 or 1)integer

POST /models.unarchive_many#

Description#

Unarchive models

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
ids
required
IDs of the models to unarchive< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
failed
optional
< failed > array
succeeded
optional
< succeeded > array

failed

NameDescriptionSchema
error
optional
Error infoerror
id
optional
ID of the failed entitystring

error

NameSchema
codes
optional
< integer > array
data
optional
object
msg
optional
string

succeeded

NameDescriptionSchema
id
optional
ID of the succeeded entitystring
unarchived
optional
Indicates whether the model was unarchivedboolean

POST /models.update#

Description#

Update a model

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
comment
optional
Model commentstring
created
optional
Model creation time (UTC)string (date-time)
iteration
optional
Iteration (used to update task statistics if an associated task is reported)integer
model
required
Model idstring
name
optional
Model name Unique within the company.string
project
optional
Project to which to model belongsstring
ready
optional
Indication if the model is final and can be used by other tasks Default is
false.
Default : false
boolean
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
Associated task IDstring
ui_cache
optional
UI cache for this modelobject

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of models updated (0 or 1)integer

POST /models.update_for_task#

Description#

Create or update a new model for a task

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
comment
optional
Model commentstring
iteration
optional
Iteration (used to update task statistics)integer
name
optional
Model name Unique within the company.string
override_model_id
optional
Override model ID. If provided, this model is updated in the task. Exactly one
of override_model_id or uri is required.
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
task
required
Task idstring
uri
optional
URI for the model. Exactly one of uri or override_model_id is a required.string

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
created
optional
Was the model createdboolean
fields
optional
Updated fields names and valuesobject
id
optional
ID of the modelstring
updated
optional
Number of models updated (0 or 1)integer

Organization#

This service provides organization level operations

POST /organization.get_tags#

Description#

Get all the user and system tags used for the company tasks and models

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
filter
optional
Filter on entities to collect tags fromfilter
include_system
optional
If set to 'true' then the list of the system tags is also returned. The default
value is 'false'
Default : false
boolean

filter

NameDescriptionSchema
system_tags
optional
The list of system tag values to filter by. Use 'null' value to specify empty system tags. Use '__Snot' value to specify that the following value should be excluded< string > array
tags
optional
The list of tag values to filter by. Use 'null' value to specify empty tags. Use '__Snot' value to specify that the following value should be excluded< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
system_tags
optional
The list of unique system tag values. Returned only if 'include_system' is set
to 'true' in the request
< string > array
tags
optional
The list of unique tag values< string > array

POST /organization.get_user_companies#

Description#

Get details for all companies associated with the current user

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyobject

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
companies
optional
List of company information entries. First company is the user's own company< companies > array

companies

NameDescriptionSchema
allocated
optional
Number of users allocated for companyinteger
id
optional
Company IDstring
name
optional
Company namestring
owners
optional
Company owners< owners > array

owners

NameDescriptionSchema
avatar
optional
User avatar (URL or base64-encoded data)string
id
optional
User IDstring
name
optional
User Namestring

Projects#

Provides support for defining Projects containing Tasks, Models and Dataset Versions.

POST /projects.create#

Description#

Create a new project

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
default_output_destination
optional
The default output destination URL for new tasks under this projectstring
description
optional
Project description.string
name
required
Project name Unique within the company.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

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
id
optional
Project idstring

POST /projects.delete#

Description#

Deletes a project

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
delete_contents
optional
If set to 'true' then the project tasks and models will be deleted. Otherwise
their project property will be unassigned. Default value is 'false'
boolean
force
optional
If not true, fails if project has tasks. If true, and project has tasks, they
will be unassigned
Default : false
boolean
project
required
Project IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
deleted
optional
Number of projects deleted (0 or 1)integer
deleted_models
optional
Number of models deletedinteger
deleted_tasks
optional
Number of tasks deletedinteger
disassociated_tasks
optional
Number of tasks disassociated from the deleted projectinteger
urls
optional
The urls of the files that were uploaded by the project tasks and models.
Returned if the 'delete_contents' was set to 'true'
projects.urls

POST /projects.get_all#

Description#

Get all the company's projects and all public projects

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
all
optional
Multi-field pattern condition (all fields match pattern)projects.multi_field_pattern_data
any
optional
Multi-field pattern condition (any field matches pattern)projects.multi_field_pattern_data
description
optional
Get only projects whose description matches this pattern (python regular
expression syntax)
string
id
optional
List of IDs to filter by< string > array
name
optional
Get only projects whose name matches this pattern (python regular expression
syntax)
string
only_fields
optional
List of document's field names (nesting is supported using '.', e.g.
execution.model_labels). If provided, this list defines the query's projection
(only these fields will be returned for each result entry)
< string > array
order_by
optional
List of field names to order by. When search_text is used, '@text_score' can be
used as a field representing the text score of returned documents. Use '-'
prefix to specify descending order. Optional, recommended when using page
< string > array
page
optional
Page number, returns a specific page out of the resulting list of projects
Minimum value : 0
integer
page_size
optional
Page size, specifies the number of results returned in each page (last page may
contain fewer results)
Minimum value : 1
integer
search_text
optional
Free text search querystring
shallow_search
optional
If set to 'true' then the search with the specified criteria is performed among
top level projects only (or if parents specified, among the direct children of
the these parents). Otherwise the search is performed among all the company
projects (or among all of the descendants of the specified parents).
Default : false
boolean
system_tags
optional
System tags list used to filter results. Prepend '-' to system tag name to
indicate exclusion
< string > array
tags
optional
User-defined tags list used to filter results. Prepend '-' to tag name to
indicate exclusion
< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
projects
optional
Projects list< projects.projects_get_all_response_single > array

POST /projects.get_all_ex#

Description#

Get all the company's projects and all public projects

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
all
optional
Multi-field pattern condition (all fields match pattern)projects.multi_field_pattern_data
any
optional
Multi-field pattern condition (any field matches pattern)projects.multi_field_pattern_data
active_users
optional
< string > array
check_own_contents
optional
If set to 'true' and project ids are passed to the query then for these projects their own tasks and models are counted
Default : false
boolean
description
optional
Get only projects whose description matches this pattern (python regular
expression syntax)
string
id
optional
List of IDs to filter by< string > array
include_stats
optional
If true, include project statistic in response.
Default : false
boolean
name
optional
Get only projects whose name matches this pattern (python regular expression
syntax)
string
non_public
optional
Return only non-public projects
Default : false
boolean
only_fields
optional
List of document's field names (nesting is supported using '.', e.g.
execution.model_labels). If provided, this list defines the query's projection
(only these fields will be returned for each result entry)
< string > array
order_by
optional
List of field names to order by. When search_text is used, '@text_score' can be
used as a field representing the text score of returned documents. Use '-'
prefix to specify descending order. Optional, recommended when using page
< string > array
page
optional
Page number, returns a specific page out of the resulting list of projects
Minimum value : 0
integer
page_size
optional
Page size, specifies the number of results returned in each page (last page may
contain fewer results)
Minimum value : 1
integer
search_text
optional
Free text search querystring
shallow_search
optional
If set to 'true' then the search with the specified criteria is performed among top level projects only (or if parents specified, among the direct children of the these parents). Otherwise the search is performed among all the company projects (or among all of the descendants of the specified parents).
Default : false
boolean
stats_for_state
optional
Report stats include only statistics for tasks in the specified state. If Null
is provided, stats for all task states will be returned.
Default : "active"
enum (active, archived)
system_tags
optional
System tags list used to filter results. Prepend '-' to system tag name to
indicate exclusion
< string > array
tags
optional
User-defined tags list used to filter results. Prepend '-' to tag name to
indicate exclusion
< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
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
projects
optional
Projects list< projects.projects_get_all_response_single > array

POST /projects.get_by_id#

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
project
required
Project idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
project
optional
Project infoprojects.project

POST /projects.get_hyper_parameters#

Description#

Get a list of all hyper parameter sections and names used in tasks within the
given project.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
include_subprojects
optional
If set to 'true' and the project field is set then the result includes hyper
parameters from the subproject tasks
Default : true
boolean
page
optional
Page numberinteger
page_size
optional
Page sizeinteger
project
optional
Project IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
parameters
optional
A list of parameter sections and names< object > array
remaining
optional
Remaining resultsinteger
total
optional
Total number of resultsinteger

POST /projects.get_hyperparam_values#

Description#

Get a list of distinct values for the chosen hyperparameter

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
allow_public
optional
If set to 'true' then collect values from both company and public tasks
otherwise company tasks only. The default is 'true'
boolean
include_subprojects
optional
If set to 'true' and the project field is set then the result includes hyper
parameters values from the subproject tasks
Default : true
boolean
name
required
Hyperparameter namestring
projects
optional
Project IDs< string > array
section
required
Hyperparameter section namestring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
total
optional
Total number of distinct parameter valuesinteger
values
optional
The list of the unique values for the parameter< string > array

POST /projects.get_model_tags#

Description#

Get user and system tags used for the models under the specified projects

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
filter
optional
Filter on entities to collect tags fromfilter
include_system
optional
If set to 'true' then the list of the system tags is also returned. The default
value is 'false'
Default : false
boolean
projects
optional
The list of projects under which the tags are searched. If not passed or empty
then all the projects are searched
< string > array

filter

NameDescriptionSchema
system_tags
optional
The list of system tag values to filter by. Use 'null' value to specify empty system tags. Use '__Snot' value to specify that the following value should be excluded< string > array
tags
optional
The list of tag values to filter by. Use 'null' value to specify empty tags. Use '__Snot' value to specify that the following value should be excluded< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
system_tags
optional
The list of unique system tag values. Returned only if 'include_system' is set
to 'true' in the request
< string > array
tags
optional
The list of unique tag values< string > array

POST /projects.get_task_parents#

Description#

Get unique parent tasks for the tasks in the specified projects

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
include_subprojects
optional
If set to 'true' and the projects field is not empty then the result includes
tasks parents from the subproject tasks
Default : true
boolean
projects
optional
The list of projects which task parents are retieved. If not passed or empty
then all the projects are searched
< string > array
tasks_state
optional
Return parents for tasks in the specified state. If Null is provided, parents
for all task states will be returned.
Default : "active"
enum (active, archived)

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
parents
optional
The list of unique task parents sorted by their names< parents > array

parents

NameDescriptionSchema
id
optional
The ID of the parent taskstring
name
optional
The name of the parent taskstring
project
optional
object

POST /projects.get_task_tags#

Description#

Get user and system tags used for the tasks under the specified projects

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
filter
optional
Filter on entities to collect tags fromfilter
include_system
optional
If set to 'true' then the list of the system tags is also returned. The default
value is 'false'
Default : false
boolean
projects
optional
The list of projects under which the tags are searched. If not passed or empty
then all the projects are searched
< string > array

filter

NameDescriptionSchema
system_tags
optional
The list of system tag values to filter by. Use 'null' value to specify empty system tags. Use '__Snot' value to specify that the following value should be excluded< string > array
tags
optional
The list of tag values to filter by. Use 'null' value to specify empty tags. Use '__Snot' value to specify that the following value should be excluded< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
system_tags
optional
The list of unique system tag values. Returned only if 'include_system' is set
to 'true' in the request
< string > array
tags
optional
The list of unique tag values< string > array

POST /projects.get_unique_metric_variants#

Description#

Get all metric/variant pairs reported for tasks in a specific project. If no
project is specified, metrics/variant paris reported for all tasks will be
returned. If the project does not exist, an empty list will be returned.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
include_subprojects
optional
If set to 'true' and the project field is set then the result includes
metrics/variants from the subproject tasks
Default : true
boolean
project
optional
Project IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
metrics
optional
A list of metric variants reported for tasks in this project< projects.metric_variant_result > array

POST /projects.make_private#

Description#

Convert public projects to private

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
ids
optional
Ids of the projects to convert. Only the projects originated by the company can
be converted
< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of projects updatedinteger

POST /projects.make_public#

Description#

Convert company projects to public

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
ids
optional
Ids of the projects to convert< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of projects updatedinteger

POST /projects.merge#

Description#

Moves all the source project's contents to the destination project and remove
the source project

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
destination_project
optional
The ID of the destination projectstring
project
required
Project idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
moved_entities
optional
The number of tasks and models moved from the merged project into the
destination
integer
moved_projects
optional
The number of child projects moved from the merged project into the destinationinteger

POST /projects.move#

Description#

Moves a project and all of its subprojects under the different location

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
new_location
optional
The name location for the projectstring
project
required
Project idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
moved
optional
The number of projects movedinteger

POST /projects.update#

Description#

Update project information

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
default_output_destination
optional
The default output destination URL for new tasks under this projectstring
description
optional
Project descriptionstring
name
optional
Project name. Unique within the company.string
project
required
Project idstring
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

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of projects updated (0 or 1)integer

POST /projects.validate_delete#

Description#

Validates that the project existis and can be deleted

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
project
required
Project IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
models
optional
The total number of models under the project and all its childreninteger
non_archived_models
optional
The total number of non-archived models under the project and all its childreninteger
non_archived_tasks
optional
The total number of non-archived tasks under the project and all its childreninteger
tasks
optional
The total number of tasks under the project and all its childreninteger

Queues#

Provides a management API for queues of tasks waiting to be executed by workers deployed anywhere (see Workers Service).

POST /queues.add_or_update_metadata#

Description#

Add or update queue metadata

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
metadata
required
Metadata items to add or update< queues.metadata_item > array
queue
required
ID of the queuestring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of queues updated (0 or 1)integer

POST /queues.add_task#

Description#

Adds a task entry to the queue.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
queue
required
Queue idstring
task
required
Task idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
added
optional
Number of tasks added (0 or 1)integer

POST /queues.create#

Description#

Create a new queue

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
name
required
Queue name Unique within the company.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

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
id
optional
New queue IDstring

POST /queues.delete#

Description#

Deletes a queue. If the queue is not empty and force is not set to true, queue
will not be deleted.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
Force delete of non-empty queue. Defaults to false
Default : false
boolean
queue
required
Queue idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
deleted
optional
Number of queues deleted (0 or 1)integer

POST /queues.delete_metadata#

Description#

Delete metadata from queue

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
keys
required
The list of metadata keys to delete< string > array
queue
required
ID of the queuestring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of queues updated (0 or 1)integer

POST /queues.get_all#

Description#

Get all queues

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
id
optional
List of Queue IDs used to filter results< string > array
name
optional
Get only queues whose name matches this pattern (python regular expression
syntax)
string
only_fields
optional
List of document field names (nesting is supported using '.', e.g.
execution.model_labels). If provided, this list defines the query's projection
(only these fields will be returned for each result entry)
< string > array
order_by
optional
List of field names to order by. When search_text is used, '@text_score' can be
used as a field representing the text score of returned documents. Use '-'
prefix to specify descending order. Optional, recommended when using page
< string > array
page
optional
Page number, returns a specific page out of the result list of results.
Minimum value : 0
integer
page_size
optional
Page size, specifies the number of results returned in each page (last page may
contain fewer results)
Minimum value : 1
integer
search_text
optional
Free text search querystring
system_tags
optional
System tags list used to filter results. Prepend '-' to system tag name to
indicate exclusion
< string > array
tags
optional
User-defined tags list used to filter results. Prepend '-' to tag name to
indicate exclusion
< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
queues
optional
Queues list< queues.queue > array

POST /queues.get_all_ex#

Description#

Get all queues

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
id
optional
List of Queue IDs used to filter results< string > array
name
optional
Get only queues whose name matches this pattern (python regular expression
syntax)
string
only_fields
optional
List of document field names (nesting is supported using '.', e.g.
execution.model_labels). If provided, this list defines the query's projection
(only these fields will be returned for each result entry)
< string > array
order_by
optional
List of field names to order by. When search_text is used, '@text_score' can be
used as a field representing the text score of returned documents. Use '-'
prefix to specify descending order. Optional, recommended when using page
< string > array
page
optional
Page number, returns a specific page out of the result list of results.
Minimum value : 0
integer
page_size
optional
Page size, specifies the number of results returned in each page (last page may
contain fewer results)
Minimum value : 1
integer
search_text
optional
Free text search querystring
system_tags
optional
System tags list used to filter results. Prepend '-' to system tag name to
indicate exclusion
< string > array
tags
optional
User-defined tags list used to filter results. Prepend '-' to tag name to
indicate exclusion
< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
queues
optional
Queues list< queues.queue > array

POST /queues.get_by_id#

Description#

Gets queue information

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
queue
required
Queue IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
queue
optional
Queue infoqueues.queue

POST /queues.get_default#

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyobject

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
id
optional
Queue idstring
name
optional
Queue namestring

POST /queues.get_next_task#

Description#

Gets the next task from the top of the queue (FIFO). The task entry is removed
from the queue.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
queue
required
Queue idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
entry
optional
Entry informationqueues.entry

POST /queues.get_queue_metrics#

Description#

Returns metrics of the company queues. The metrics are avaraged in the
specified interval.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
from_date
required
Starting time (in seconds from epoch) for collecting metricsnumber
interval
required
Time interval in seconds for a single metrics point. The minimal value is 1integer
queue_ids
optional
List of queue ids to collect metrics for. If not provided or empty then all
then average metrics across all the company queues will be returned.
< string > array
to_date
required
Ending time (in seconds from epoch) for collecting metricsnumber

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
queues
optional
List of the requested queues with their metrics. If no queue ids were requested
then 'all' queue is returned with the metrics averaged accross all the company
queues.
< queues.queue_metrics > array

POST /queues.move_task_backward#

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
count
optional
Number of positions in the queue to move the task forward relative to the
current position. Optional, the default value is 1.
integer
queue
required
Queue idstring
task
required
Task idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
position
optional
The new position of the task entry in the queue (index, -1 represents bottom of
queue)
integer

POST /queues.move_task_forward#

Description#

Moves a task entry one step forward towards the top of the queue.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
count
optional
Number of positions in the queue to move the task forward relative to the
current position. Optional, the default value is 1.
integer
queue
required
Queue idstring
task
required
Task idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
position
optional
The new position of the task entry in the queue (index, -1 represents bottom of
queue)
integer

POST /queues.move_task_to_back#

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
queue
required
Queue idstring
task
required
Task idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
position
optional
The new position of the task entry in the queue (index, -1 represents bottom of
queue)
integer

POST /queues.move_task_to_front#

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
queue
required
Queue idstring
task
required
Task idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
position
optional
The new position of the task entry in the queue (index, -1 represents bottom of
queue)
integer

POST /queues.remove_task#

Description#

Removes a task entry from the queue.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
queue
required
Queue idstring
task
required
Task idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
removed
optional
Number of tasks removed (0 or 1)integer

POST /queues.update#

Description#

Update queue information

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
name
optional
Queue name Unique within the company.string
queue
required
Queue idstring
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

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of queues updated (0 or 1)integer

Server#

server utilities

Tasks#

Provides a management API for tasks in the system.

POST /tasks.add_or_update_artifacts#

Description#

Update existing artifacts (search by key/mode) and add new ones

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
artifacts
required
Artifacts to add or update< tasks.artifact > array
force
optional
If set to True then both new and running task artifacts can be edited.
Otherwise only the new task ones. Default is False
boolean
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Indicates if the task was updated successfullyinteger

POST /tasks.add_or_update_model#

Description#

Add or update task model

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
iteration
optional
Iteration (used to update task statistics)integer
model
required
The model IDstring
name
required
The task model namestring
task
required
ID of the taskstring
type
required
The task model typetasks.model_type_enum

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.archive#

Description#

Archive tasks. If a task is queued it will first be dequeued and then archived.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring
tasks
required
List of task ids< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
archived
optional
Indicates number of archived tasksinteger

POST /tasks.archive_many#

Description#

Archive tasks

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
ids
required
IDs of the tasks to archive< string > array
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
failed
optional
< failed > array
succeeded
optional
< succeeded > array

failed

NameDescriptionSchema
error
optional
Error infoerror
id
optional
ID of the failed entitystring

error

NameSchema
codes
optional
< integer > array
data
optional
object
msg
optional
string

succeeded

NameDescriptionSchema
id
optional
ID of the succeeded entitystring

POST /tasks.clone#

Description#

Clone an existing task

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
execution_overrides
optional
The execution params for the cloned task. The params not specified are taken
from the original task
tasks.execution
new_project_name
optional
Clone task to a new project by this name (only if new_task_project is not
provided). If a project by this name already exists, task will be cloned to
existing project.
string
new_task_comment
optional
The comment of the cloned task. If not provided then taken from the original
task
string
new_task_configuration
optional
The configuration for the new task. If not provided then taken from the
original task
< string, tasks.configuration_item > map
new_task_container
optional
The docker container properties for the new task. If not provided then taken
from the original task
< string, string > map
new_task_hyperparams
optional
The hyper params for the new task. If not provided then taken from the original
task
< string, tasks.section_params > map
new_task_input_models
optional
The list of input models for the cloned task. If not specifed then copied from
the original task
< tasks.task_model_item > array
new_task_name
optional
The name of the cloned task. If not provided then taken from the original taskstring
new_task_parent
optional
The parent of the cloned task. If not provided then taken from the original
task
string
new_task_project
optional
The project of the cloned task. If not provided then taken from the original
task
string
new_task_system_tags
optional
The system tags of the cloned task. If not provided then empty< string > array
new_task_tags
optional
The user-defined tags of the cloned task. If not provided then taken from the
original task
< string > array
task
required
ID of the taskstring
validate_references
optional
If set to 'false' then the task fields that are copied from the original task
are not validated. The default is false.
boolean

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
id
optional
ID of the new taskstring
new_project
optional
In case the new_project_name was specified returns the target project detailsnew_project

new_project

NameDescriptionSchema
id
optional
The ID of the target projectstring
name
optional
The name of the target projectstring

POST /tasks.close#

Description#

Indicates that task is closed

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
Allows forcing state change even if transition is not supported
Default : false
boolean
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.completed#

Description#

Signal a task has completed

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
If not true, call fails if the task status is not in_progress/stopped
Default : false
boolean
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.create#

Description#

Create a new task

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
comment
optional
Free text commentstring
configuration
optional
Task configuration params< string, tasks.configuration_item > map
container
optional
Docker container parameters< string, string > map
execution
optional
Task execution paramstasks.execution
hyperparams
optional
Task hyper params per section< string, tasks.section_params > map
models
optional
Task modelstasks.task_models
name
required
Task name. Unique within the company.string
output_dest
optional
Output storage id Must be a reference to an existing storage.string
parent
optional
Parent task id Must be a completed task.string
project
optional
Project ID of the project to which this task is assigned Must exist[ab]string
script
optional
Script infotasks.script
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
required
Type of tasktasks.task_type_enum

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
id
optional
ID of the taskstring

POST /tasks.delete#

Description#

Delete a task along with any information stored for it (statistics, frame
updates etc.) Unless Force flag is provided, operation will fail if task has
objects associated with it - i.e. children tasks and projects. Models that
refer to the deleted task will be updated with a task ID indicating a deleted
task.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
If not true, call fails if the task status is 'in_progress'
Default : false
boolean
move_to_trash
optional
Move task to trash instead of deleting it. For internal use only, tasks in the
trash are not visible from the API and cannot be restored!
Default : false
boolean
return_file_urls
optional
If set to 'true' then return the urls of the files that were uploaded by this
task. Default value is 'false'
boolean
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
deleted
optional
Indicates whether the task was deletedboolean
events
optional
Response from events.delete_for_taskobject
updated_children
optional
Number of child tasks whose parent property was updatedinteger
updated_models
optional
Number of models whose task property was updatedinteger
urls
optional
The urls of the files that were uploaded by this task. Returned if the
'return_file_urls' was set to 'true'
tasks.task_urls

POST /tasks.delete_artifacts#

Description#

Delete existing artifacts (search by key/mode)

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
artifacts
required
Artifacts to delete< tasks.artifact_id > array
force
optional
If set to True then both new and running task artifacts can be deleted.
Otherwise only the new task ones. Default is False
boolean
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
deleted
optional
Indicates if the task was updated successfullyinteger

POST /tasks.delete_configuration#

Description#

Delete task configuration items

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
configuration
required
List of configuration itemss to delete< string > array
force
optional
If set to True then both new and running task configuration can be deleted.
Otherwise only the new task ones. Default is False
boolean
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
deleted
optional
Indicates if the task was updated successfullyinteger

POST /tasks.delete_hyper_params#

Description#

Delete task hyper parameters

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
If set to True then both new and running task hyper params can be deleted.
Otherwise only the new task ones. Default is False
boolean
hyperparams
required
List of hyper parameters to delete. In case a parameter with an empty name is
passed all the section will be deleted
< tasks.param_key > array
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
deleted
optional
Indicates if the task was updated successfullyinteger

POST /tasks.delete_many#

Description#

Delete tasks

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
delete_output_models
optional
If set to 'true' then delete output models of the tasks that are not referenced
by other tasks. Default value is 'true'
boolean
force
optional
If not true, call fails if the task status is 'in_progress'
Default : false
boolean
ids
required
IDs of the tasks to delete< string > array
move_to_trash
optional
Move task to trash instead of deleting it. For internal use only, tasks in the
trash are not visible from the API and cannot be restored!
Default : false
boolean
return_file_urls
optional
If set to 'true' then return the urls of the files that were uploaded by the
tasks. Default value is 'false'
boolean

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
failed
optional
< failed > array
succeeded
optional
< succeeded > array

failed

NameDescriptionSchema
error
optional
Error infoerror
id
optional
ID of the failed entitystring

error

NameSchema
codes
optional
< integer > array
data
optional
object
msg
optional
string

succeeded

NameDescriptionSchema
deleted
optional
Indicates whether the task was deletedboolean
deleted_models
optional
Number of deleted output modelsinteger
id
optional
ID of the succeeded entitystring
updated_children
optional
Number of child tasks whose parent property was updatedinteger
updated_models
optional
Number of models whose task property was updatedinteger
urls
optional
The urls of the files that were uploaded by the task. Returned if the 'return_file_urls' was set to 'true'tasks.task_urls

POST /tasks.delete_models#

Description#

Delete models from task

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
models
required
The list of models to delete< models > array
task
required
ID of the taskstring

models

NameDescriptionSchema
name
required
The task model namestring
type
required
The task model typetasks.model_type_enum

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.dequeue#

Description#

Remove a task from its queue. Fails if task status is not queued.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
dequeued
optional
Number of tasks dequeued (0 or 1)integer
fields
optional
Updated fields names and valuesobject
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.dequeue_many#

Description#

Dequeue tasks

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
ids
required
IDs of the tasks to dequeue< string > array
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
failed
optional
< failed > array
succeeded
optional
< succeeded > array

failed

NameDescriptionSchema
error
optional
Error infoerror
id
optional
ID of the failed entitystring

error

NameSchema
codes
optional
< integer > array
data
optional
object
msg
optional
string

succeeded

NameDescriptionSchema
dequeued
optional
Indicates whether the task was dequeuedboolean
fields
optional
Updated fields names and valuesobject
id
optional
ID of the succeeded entitystring
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.edit#

Description#

Edit task's details.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
comment
optional
Free text commentstring
configuration
optional
Task configuration params< string, tasks.configuration_item > map
container
optional
Docker container parameters< string, string > map
execution
optional
Task execution paramstasks.execution
force
optional
If not true, call fails if the task status is not 'created'
Default : false
boolean
hyperparams
optional
Task hyper params per section< string, tasks.section_params > map
models
optional
Task modelstasks.task_models
name
optional
Task name Unique within the company.string
output_dest
optional
Output storage id Must be a reference to an existing storage.string
parent
optional
Parent task id Must be a completed task.string
project
optional
Project ID of the project to which this task is assigned Must exist[ab]string
runtime
optional
Task runtime mappingobject
script
optional
Script infotasks.script
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
required
ID of the taskstring
type
optional
Type of tasktasks.task_type_enum

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.edit_configuration#

Description#

Add or update task configuration

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
configuration
required
Task configuration items. The new ones will be added and the already existing
ones will be updated
< tasks.configuration_item > array
force
optional
If set to True then both new and running task configuration can be edited.
Otherwise only the new task ones. Default is False
boolean
replace_configuration
optional
If set then the all the configuration items will be replaced with the provided
ones. Otherwise only the provided configuration items will be updated or added
boolean
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Indicates if the task was updated successfullyinteger

POST /tasks.edit_hyper_params#

Description#

Add or update task hyper parameters

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
If set to True then both new and running task hyper params can be edited.
Otherwise only the new task ones. Default is False
boolean
hyperparams
required
Task hyper parameters. The new ones will be added and the already existing ones
will be updated
< tasks.params_item > array
replace_hyperparams
optional
Can be set to one of the following: 'all' - all the hyper parameters will be
replaced with the provided ones 'section' - the sections that present in the
new parameters will be replaced with the provided parameters 'none' (the
default value) - only the specific parameters will be updated or added
tasks.replace_hyperparams_enum
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Indicates if the task was updated successfullyinteger

POST /tasks.enqueue#

Description#

Adds a task into a queue.
Fails if task state is not 'created'.
Fails if the following parameters in the task were not filled:

  • execution.script.repository
  • execution.script.entrypoint

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
queue
optional
Queue id. If not provided, task is added to the default queue.string
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
queued
optional
Number of tasks queued (0 or 1)integer
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.enqueue_many#

Description#

Enqueue tasks

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
ids
required
IDs of the tasks to enqueue< string > array
queue
optional
Queue id. If not provided, tasks are added to the default queue.string
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring
validate_tasks
optional
If set then tasks are validated before enqueue
Default : false
boolean

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
failed
optional
< failed > array
succeeded
optional
< succeeded > array

failed

NameDescriptionSchema
error
optional
Error infoerror
id
optional
ID of the failed entitystring

error

NameSchema
codes
optional
< integer > array
data
optional
object
msg
optional
string

succeeded

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
id
optional
ID of the succeeded entitystring
queued
optional
Indicates whether the task was queuedboolean
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.failed#

Description#

Indicates that task has failed

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
Allows forcing state change even if transition is not supported
Default : false
boolean
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.get_all#

Description#

Get all the company's tasks and all public tasks

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
all
optional
Multi-field pattern condition (all fields match pattern)tasks.multi_field_pattern_data
any
optional
Multi-field pattern condition (any field matches pattern)tasks.multi_field_pattern_data
id
optional
List of IDs to filter by< string > array
name
optional
Get only tasks whose name matches this pattern (python regular expression
syntax)
string
only_fields
optional
List of task field names (nesting is supported using '.', e.g.
execution.model_labels). If provided, this list defines the query's projection
(only these fields will be returned for each result entry)
< string > array
order_by
optional
List of field names to order by. When search_text is used, '@text_score' can be
used as a field representing the text score of returned documents. Use '-'
prefix to specify descending order. Optional, recommended when using page. If
the first order field is a hyper parameter or metric then string values are
ordered according to numeric ordering rules where applicable
< string > array
page
optional
Page number, returns a specific page out of the resulting list of tasks
Minimum value : 0
integer
page_size
optional
Page size, specifies the number of results returned in each page (last page may
contain fewer results)
Minimum value : 1
integer
parent
optional
Parent IDstring
project
optional
List of project IDs< string > array
search_text
optional
Free text search querystring
status
optional
List of task status.< tasks.task_status_enum > array
status_changed
optional
List of status changed constraint strings (utcformat, epoch) with an optional
prefix modifier (>, >=, <, <=)
< string > array
system_tags
optional
List of task system tags. Use '-' prefix to exclude system tags< string > array
tags
optional
List of task user-defined tags. Use '-' prefix to exclude tags< string > array
type
optional
List of task types. One or more of: 'import', 'annotation', 'training' or
'testing' (case insensitive)
< string > array
user
optional
List of user IDs used to filter results by the task's creating user< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
tasks
optional
List of tasks< tasks.task > array

POST /tasks.get_all_ex#

Description#

Get all the company's tasks and all public tasks

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
all
optional
Multi-field pattern condition (all fields match pattern)tasks.multi_field_pattern_data
any
optional
Multi-field pattern condition (any field matches pattern)tasks.multi_field_pattern_data
id
optional
List of IDs to filter by< string > array
include_subprojects
optional
If set to 'true' and project field is set then tasks from the subprojects are
searched too
Default : false
boolean
name
optional
Get only tasks whose name matches this pattern (python regular expression
syntax)
string
only_fields
optional
List of task field names (nesting is supported using '.', e.g.
execution.model_labels). If provided, this list defines the query's projection
(only these fields will be returned for each result entry)
< string > array
order_by
optional
List of field names to order by. When search_text is used, '@text_score' can be
used as a field representing the text score of returned documents. Use '-'
prefix to specify descending order. Optional, recommended when using page. If
the first order field is a hyper parameter or metric then string values are
ordered according to numeric ordering rules where applicable
< string > array
page
optional
Page number, returns a specific page out of the resulting list of tasks
Minimum value : 0
integer
page_size
optional
Page size, specifies the number of results returned in each page (last page may
contain fewer results)
Minimum value : 1
integer
parent
optional
Parent IDstring
project
optional
List of project IDs< string > array
search_text
optional
Free text search querystring
status
optional
List of task status.< tasks.task_status_enum > array
status_changed
optional
List of status changed constraint strings (utcformat, epoch) with an optional
prefix modifier (>, >=, <, <=)
< string > array
system_tags
optional
List of task system tags. Use '-' prefix to exclude system tags< string > array
tags
optional
List of task user-defined tags. Use '-' prefix to exclude tags< string > array
type
optional
List of task types. One or more of: 'import', 'annotation', 'training' or
'testing' (case insensitive)
< string > array
user
optional
List of user IDs used to filter results by the task's creating user< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
tasks
optional
List of tasks< tasks.task > array

POST /tasks.get_by_id#

Description#

Gets task information

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
task
optional
Task infotasks.task

POST /tasks.get_by_id_ex#

Description#

Get all the company's tasks and all public tasks

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
all
optional
Multi-field pattern condition (all fields match pattern)tasks.multi_field_pattern_data
any
optional
Multi-field pattern condition (any field matches pattern)tasks.multi_field_pattern_data
id
optional
List of IDs to filter by< string > array
name
optional
Get only tasks whose name matches this pattern (python regular expression
syntax)
string
only_fields
optional
List of task field names (nesting is supported using '.', e.g.
execution.model_labels). If provided, this list defines the query's projection
(only these fields will be returned for each result entry)
< string > array
order_by
optional
List of field names to order by. When search_text is used, '@text_score' can be
used as a field representing the text score of returned documents. Use '-'
prefix to specify descending order. Optional, recommended when using page. If
the first order field is a hyper parameter or metric then string values are
ordered according to numeric ordering rules where applicable
< string > array
page
optional
Page number, returns a specific page out of the resulting list of tasks
Minimum value : 0
integer
page_size
optional
Page size, specifies the number of results returned in each page (last page may
contain fewer results)
Minimum value : 1
integer
parent
optional
Parent IDstring
project
optional
List of project IDs< string > array
search_text
optional
Free text search querystring
status
optional
List of task status.< tasks.task_status_enum > array
status_changed
optional
List of status changed constraint strings (utcformat, epoch) with an optional
prefix modifier (>, >=, <, <=)
< string > array
system_tags
optional
List of task system tags. Use '-' prefix to exclude system tags< string > array
tags
optional
List of task user-defined tags. Use '-' prefix to exclude tags< string > array
type
optional
List of task types. One or more of: 'import', 'annotation', 'training' or
'testing' (case insensitive)
< string > array
user
optional
List of user IDs used to filter results by the task's creating user< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
tasks
optional
List of tasks< tasks.task > array

POST /tasks.get_configuration_names#

Description#

Get the list of task configuration items names

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
skip_empty
optional
If set to 'true' then the names for configurations with missing values are not
returned
Default : true
boolean
tasks
required
Task IDs< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
configurations
optional
Names of task configuration items (keyed by task ID)configurations

configurations

NameDescriptionSchema
names
optional
Configuration names< string > array
task
optional
Task IDstring

POST /tasks.get_configurations#

Description#

Get the list of task configurations

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
names
optional
Names of the configuration items to retreive. If not passed or empty then all
the configurations will be retreived.
< string > array
tasks
required
Task IDs< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
configurations
optional
Configurations (keyed by task ID)< configurations > array

configurations

NameDescriptionSchema
configuration
optional
Configuration list< tasks.configuration_item > array
task
optional
Task IDstring

POST /tasks.get_hyper_params#

Description#

Get the list of task hyper parameters

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
tasks
required
Task IDs< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
params
optional
Hyper parameters (keyed by task ID)< params > array

params

NameDescriptionSchema
hyperparams
optional
Hyper parameters< tasks.params_item > array
task
optional
Task IDstring

POST /tasks.get_types#

Description#

Get the list of task types used in the specified projects

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
projects
optional
The list of projects which tasks will be analyzed. If not passed or empty then
all the company and public tasks will be analyzed
< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
types
optional
Unique list of the task types used in the requested projects< string > array

POST /tasks.make_private#

Description#

Convert public tasks to private

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
ids
optional
Ids of the tasks to convert. Only the tasks originated by the company can be
converted
< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of tasks updatedinteger

POST /tasks.make_public#

Description#

Convert company tasks to public

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
ids
optional
Ids of the tasks to convert< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of tasks updatedinteger

POST /tasks.move#

Description#

Move tasks to a project

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
ids
required
Tasks to move< string > array
project
optional
Target project ID. If not provided, project_name must be provided.string
project_name
optional
Target project name. If provided and a project with this name does not exist, a
new project will be created. If not provided, project must be provided.
string

Responses#

HTTP CodeSchema
200object

POST /tasks.ping#

Description#

Refresh the task's last update time

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
task
required
Task IDstring

Responses#

HTTP CodeSchema
200object

POST /tasks.publish#

Description#

Mark a task status as published.
For Annotation tasks - if any changes were committed by this task, a
new version in the dataset together with an output view are created.
For Training tasks - if a model was created, it should be set to ready.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
If not true, call fails if the task status is not 'stopped'
Default : false
boolean
publish_model
optional
Indicates that the task output model (if exists) should be published. Optional,
the default value is True.
boolean
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.publish_many#

Description#

Publish tasks

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
If not true, call fails if the task status is not 'stopped'
Default : false
boolean
ids
required
IDs of the tasks to publish< string > array
publish_model
optional
Indicates that the task output model (if exists) should be published. Optional,
the default value is True.
boolean
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
failed
optional
< failed > array
succeeded
optional
< succeeded > array

failed

NameDescriptionSchema
error
optional
Error infoerror
id
optional
ID of the failed entitystring

error

NameSchema
codes
optional
< integer > array
data
optional
object
msg
optional
string

succeeded

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
id
optional
ID of the succeeded entitystring
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.reset#

Description#

Reset a task to its initial state, along with any information stored for it
(statistics, frame updates etc.).

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
clear_all
optional
Clear script and execution sections completely
Default : false
boolean
force
optional
If not true, call fails if the task status is 'completed'
Default : false
boolean
return_file_urls
optional
If set to 'true' then return the urls of the files that were uploaded by this
task. Default value is 'false'
boolean
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
deleted_models
optional
Number of output models deleted by the resetinteger
dequeued
optional
Response from queues.remove_taskobject
events
optional
Response from events.delete_for_taskobject
fields
optional
Updated fields names and valuesobject
updated
optional
Number of tasks updated (0 or 1)integer
urls
optional
The urls of the files that were uploaded by this task. Returned if the
'return_file_urls' was set to 'true'
tasks.task_urls

POST /tasks.reset_many#

Description#

Reset tasks

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
clear_all
optional
Clear script and execution sections completely
Default : false
boolean
delete_output_models
optional
If set to 'true' then delete output models of the tasks that are not referenced
by other tasks. Default value is 'true'
boolean
force
optional
If not true, call fails if the task status is 'completed'
Default : false
boolean
ids
required
IDs of the tasks to reset< string > array
return_file_urls
optional
If set to 'true' then return the urls of the files that were uploaded by the
tasks. Default value is 'false'
boolean

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
failed
optional
< failed > array
succeeded
optional
< succeeded > array

failed

NameDescriptionSchema
error
optional
Error infoerror
id
optional
ID of the failed entitystring

error

NameSchema
codes
optional
< integer > array
data
optional
object
msg
optional
string

succeeded

NameDescriptionSchema
deleted_models
optional
Number of output models deleted by the resetinteger
dequeued
optional
Indicates whether the task was dequeuedboolean
fields
optional
Updated fields names and valuesobject
id
optional
ID of the succeeded entitystring
updated
optional
Number of tasks updated (0 or 1)integer
urls
optional
The urls of the files that were uploaded by the task. Returned if the 'return_file_urls' was set to 'true'tasks.task_urls

POST /tasks.set_requirements#

Description#

Set the script requirements for a task

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
requirements
required
A JSON object containing requirements strings by keyobject
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.started#

Description#

Mark a task status as in_progress. Optionally allows to set the task's
execution progress.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
If not true, call fails if the task status is not 'not_started'
Default : false
boolean
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
started
optional
Number of tasks started (0 or 1)integer
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.stop#

Description#

Request to stop a running task

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
If not true, call fails if the task status is not 'in_progress'
Default : false
boolean
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.stop_many#

Description#

Request to stop running tasks

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
If not true, call fails if the task status is not 'in_progress'
Default : false
boolean
ids
required
IDs of the tasks to stop< string > array
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
failed
optional
< failed > array
succeeded
optional
< succeeded > array

failed

NameDescriptionSchema
error
optional
Error infoerror
id
optional
ID of the failed entitystring

error

NameSchema
codes
optional
< integer > array
data
optional
object
msg
optional
string

succeeded

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
id
optional
ID of the succeeded entitystring
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.stopped#

Description#

Signal a task has stopped

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
force
optional
If not true, call fails if the task status is not 'stopped'
Default : false
boolean
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring
task
required
Task IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.unarchive_many#

Description#

Unarchive tasks

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
ids
required
IDs of the tasks to unarchive< string > array
status_message
optional
Extra information regarding status changestring
status_reason
optional
Reason for status changestring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
failed
optional
< failed > array
succeeded
optional
< succeeded > array

failed

NameDescriptionSchema
error
optional
Error infoerror
id
optional
ID of the failed entitystring

error

NameSchema
codes
optional
< integer > array
data
optional
object
msg
optional
string

succeeded

NameDescriptionSchema
id
optional
ID of the succeeded entitystring
unarchived
optional
Indicates whether the task was unarchivedboolean

POST /tasks.update#

Description#

Update task's runtime parameters

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
comment
optional
Free text commentstring
created
optional
Task creation time (UTC)string (date-time)
name
optional
Task name Unique within the company.string
output__error
optional
Free text errorstring
project
optional
Project ID of the project to which this task is assignedstring
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
required
ID of the taskstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
fields
optional
Updated fields names and valuesobject
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.update_batch#

Description#

Updates a batch of tasks. Headers Content type should be 'application/json-
lines'.

Parameters#

TypeNameDescriptionSchema
Bodyrequests
required
Json encoded newline-terminated lines, each representing an event in the batch and uses the same parameters used for tasks.update< object > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of tasks updated (0 or 1)integer

POST /tasks.validate#

Description#

Validate task properties (before create)

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
comment
optional
Free text commentstring
configuration
optional
Task configuration params< string, tasks.configuration_item > map
container
optional
Docker container parameters< string, string > map
execution
optional
Task execution paramstasks.execution
hyperparams
optional
Task hyper params per section< string, tasks.section_params > map
models
optional
Task modelstasks.task_models
name
required
Task name. Unique within the company.string
output_dest
optional
Output storage id Must be a reference to an existing storage.string
parent
optional
Parent task id Must be a completed task.string
project
optional
Project ID of the project to which this task is assigned Must exist[ab]string
script
optional
Script infotasks.script
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
required
Type of tasktasks.task_type_enum

Responses#

HTTP CodeSchema
200object

Users#

This service provides a management interface to users information and new users login restrictions.

Workers#

Provides an API for worker machines, allowing workers to report status and get tasks for execution

POST /workers.get_activity_report#

Description#

Returns count of active company workers in the selected time range.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
from_date
required
Starting time (in seconds from epoch) for collecting statisticsnumber
interval
required
Time interval in seconds for a single statistics point. The minimal value is 1integer
to_date
required
Ending time (in seconds from epoch) for collecting statisticsnumber

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
active
optional
Activity series that include only workers that worked on a task in the given
time interval.
workers.activity_series
total
optional
Activity series that include all the workers that sent reports in the given
time interval.
workers.activity_series

POST /workers.get_all#

Description#

Returns information on all registered workers.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
last_seen
optional
Filter out workers not active for more than last_seen seconds. A value or 0 or
'none' will disable the filter.
integer

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameSchema
workers
optional
< workers.worker > array

POST /workers.get_metric_keys#

Description#

Returns worker statistics metric keys grouped by categories.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
worker_ids
optional
List of worker ids to collect metrics for. If not provided or empty then all
the company workers metrics are analyzed.
< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
categories
optional
List of unique metric categories found in the statistics of the requested
workers.
< workers.metrics_category > array

POST /workers.get_stats#

Description#

Returns statistics for the selected workers and time range aggregated by date
intervals.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
from_date
required
Starting time (in seconds from epoch) for collecting statisticsnumber
interval
required
Time interval in seconds for a single statistics point. The minimal value is 1integer
items
required
List of metric keys and requested statistics< workers.stat_item > array
split_by_variant
optional
If true then break statistics by hardware sub types
Default : false
boolean
to_date
required
Ending time (in seconds from epoch) for collecting statisticsnumber
worker_ids
optional
List of worker ids to collect metrics for. If not provided or empty then all
the company workers metrics are analyzed.
< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
workers
optional
List of the requested workers with their statistics< workers.worker_stats > array

POST /workers.register#

Description#

Register a worker in the system. Called by the Worker Daemon.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
queues
optional
List of queue IDs on which the worker is listening.< string > array
tags
optional
User tags for the worker< string > array
timeout
optional
Registration timeout in seconds. If timeout seconds have passed since the
worker's last call to register or status_report, the worker is automatically
removed from the list of registered workers.
integer
worker
required
Worker id. Must be unique in company.string

Responses#

HTTP CodeSchema
200object

POST /workers.status_report#

Description#

Called periodically by the worker daemon to report machine status

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
machine_stats
optional
The machine statistics.workers.machine_stats
queue
optional
ID of the queue from which task was received. If no queue is sent, the worker's
queue field will be cleared.
string
queues
optional
List of queue IDs on which the worker is listening. If null, the worker's
queues list will not be updated.
< string > array
tags
optional
New user tags for the worker< string > array
task
optional
ID of a task currently being run by the worker. If no task is sent, the
worker's task field will be cleared.
string
timestamp
required
UNIX time in seconds since epoch.integer
worker
required
Worker id.string

Responses#

HTTP CodeSchema
200object

POST /workers.unregister#

Description#

Unregister a worker in the system. Called by the Worker Daemon.

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
worker
required
Worker id. Must be unique in company.string

Responses#

HTTP CodeSchema
200object