ClearML Server API

POST /auth.login

Internal. Get a token based on supplied credentials (key/secret). Intended for use by users with key/secret credentials that wish to obtain a token for use with other services.

Request JSON Object

  • expiration_sec (integer) – Requested token expiration time in seconds. Not guaranteed, might be overridden by the service

Status Codes
Response JSON Object

  • token (string) – Token string

POST /auth.logout

Internal. Removes the authentication cookie from the current session

Status Codes
POST /auth.get_token_for_user

Internal. Get a token for the specified user. Intended for internal use.

Request JSON Object

  • company (string) – Company ID

  • expiration_sec (integer) – Requested token expiration time in seconds. Not guaranteed, might be overridden by the service

  • user (string) – User ID (required)

Status Codes
Response JSON Object

  • token (string) –

POST /auth.validate_token

Internal. Validate a token and return user identity if valid. Intended for internal use.

Request JSON Object

  • token (string) – Token string (required)

Status Codes
Response JSON Object

  • company (string) – Associated company ID

  • user (string) – Associated user ID

  • valid (boolean) – Boolean indicating if the token is valid

POST /auth.create_user

Internal. Creates a new user auth entry. Intended for internal use.

Request JSON Object

  • avatar (string) – Avatar URL

  • company (string) – Associated company ID (required)

  • email (string) – Email address uniquely identifying the user (required)

  • family_name (string) – Family name

  • given_name (string) – Given name

  • name (string) – User name (makes the auth entry more readable) (required)

  • role (string) –

Status Codes
Response JSON Object

  • id (string) – New user ID

POST /auth.create_credentials

Internal. Creates a new set of credentials for the authenticated user. New key/secret is returned. Note: Secret will never be returned in any other API call. If a secret is lost or compromised, the key should be revoked and a new set of credentials can be created.

Status Codes
Response JSON Object

  • credentials.access_key (string) – Credentials access key

  • credentials.secret_key (string) – Credentials secret key

POST /auth.get_credentials

Internal. Returns all existing credential keys for the authenticated user. Note: Only credential keys are returned.

Status Codes
Response JSON Object

  • credentials[].access_key (string) –

  • credentials[].last_used (string) –

POST /auth.revoke_credentials

Internal. Revokes (and deletes) a set (key, secret) of credentials for the authenticated user.

Request JSON Object

  • access_key (string) – Credentials key

Status Codes
Response JSON Object

  • revoked (integer) – Number of credentials revoked

POST /auth.edit_user

Internal. Edit a users’ auth data properties

Request JSON Object

  • role (string) – The new user’s role within the company

  • user (string) – User ID

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (number) – Number of users updated (0 or 1)

POST /auth.fixed_users_mode

Internal. Return fixed users mode status

Status Codes
Response JSON Object

  • enabled (boolean) – Fixed users mode enabled

  • server_errors (object) – Server initialization errors

POST /debug.ping

Ping server

Status Codes
POST /events.add

Adds a single event

Status Codes
POST /events.add_batch

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

Request JSON Object

  • [] (object) –

Status Codes
Response JSON Object

  • added (integer) –

  • errors (integer) –

  • errors_info (object) –

POST /events.delete_for_task

Delete all task event. This cannot be undone!

Request JSON Object

  • allow_locked (boolean) – Allow deleting events even if the task is locked

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • deleted (boolean) – Number of deleted events

POST /events.debug_images

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

Request JSON Object

  • iters (integer) – Max number of latest iterations for which to return debug images

  • metrics[].task (string) – Task ID (required)

  • navigate_earlier (boolean) – If set then events are retreived from latest iterations to earliest ones. Otherwise from earliest iterations to the latest. The default is True

  • refresh (boolean) – If set then scroll will be moved to the latest iterations. The default is False

  • scroll_id (string) – Scroll ID of previous call (used for getting more results)

Status Codes
Response JSON Object

  • metrics[] (object) –

  • scroll_id (string) – Scroll ID for getting more results

POST /events.get_debug_image_sample

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

Request JSON Object

  • iteration (integer) – The iteration to bring debug image from. If not specified then the latest reported image is retrieved

  • metric (string) – Metric name (required)

  • refresh (boolean) – If set then scroll state will be refreshed to reflect the latest changes in the debug images

  • scroll_id (string) – Scroll ID from the previous call to get_debug_image_sample or empty

  • task (string) – Task ID (required)

  • variant (string) – Metric variant (required)

Status Codes
Response JSON Object

  • event (object) – Debug image event

  • max_iteration (integer) – maximal valid iteration for the variant

  • min_iteration (integer) – minimal valid iteration for the variant

  • scroll_id (string) – Scroll ID to pass to the next calls to get_debug_image_sample or next_debug_image_sample

POST /events.next_debug_image_sample

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

Request JSON Object

  • navigate_earlier (boolean) – 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

  • scroll_id (string) – Scroll ID from the previous call to get_debug_image_sample (required)

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • event (object) – Debug image event

  • max_iteration (integer) – maximal valid iteration for the variant

  • min_iteration (integer) – minimal valid iteration for the variant

  • scroll_id (string) – Scroll ID to pass to the next calls to get_debug_image_sample or next_debug_image_sample

POST /events.get_task_metrics

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

Request JSON Object

  • event_type (string) –

  • tasks[] (string) –

Status Codes
Response JSON Object

  • metrics[] (object) –

POST /events.get_task_log

Get ‘log’ events for this task

Request JSON Object

  • batch_size (integer) – The amount of log events to return

  • from_timestamp (number) – 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)

  • navigate_earlier (boolean) – 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

  • order (string) – If set, changes the order in which log events are returned based on the value of ‘navigate_earlier’

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • events[] (object) –

  • returned (integer) – Number of log events returned

  • total (number) – Total number of log events available for this query

POST /events.get_task_events

Scroll through task events, sorted by timestamp

Request JSON Object

  • batch_size (integer) – Number of events to return each time (default 500)

  • event_type (string) – Return only events of this type

  • order (string) – ‘asc’ (default) or ‘desc’.

  • scroll_id (string) – Pass this value on next call to get next page

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • events[] (object) –

  • returned (integer) – Number of results returned

  • scroll_id (string) – Scroll ID for getting more results

  • total (number) – Total number of results available for this query

POST /events.download_task_log

Get an attachment containing the task’s log

Request JSON Object

  • line_format (string) – Line string format. Used if the line type is ‘text’

  • line_type (string) – Line format type

  • task (string) – Task ID (required)

Status Codes
POST /events.get_task_plots

Get all ‘plot’ events for this task

Request JSON Object

  • iters (integer) – Max number of latest iterations for which to return debug images

  • scroll_id (string) – Scroll ID of previous call (used for getting more results)

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • plots[] (object) –

  • returned (integer) – Number of results returned

  • scroll_id (string) – Scroll ID for getting more results

  • total (number) – Total number of results available for this query

POST /events.get_multi_task_plots

Get ‘plot’ events for the given tasks

Request JSON Object

  • iters (integer) – Max number of latest iterations for which to return debug images

  • scroll_id (string) – Scroll ID of previous call (used for getting more results)

  • tasks[] (string) – Task ID

Status Codes
Response JSON Object

  • plots (object) – Plots mapping (keyed by task name)

  • returned (integer) – Number of results returned

  • scroll_id (string) – Scroll ID for getting more results

  • total (number) – Total number of results available for this query

POST /events.get_vector_metrics_and_variants
Request JSON Object

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • metrics[] (object) –

POST /events.vector_metrics_iter_histogram

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

Request JSON Object

  • metric (string) – (required)

  • task (string) – Task ID (required)

  • variant (string) – (required)

Status Codes
Response JSON Object

  • images[] (object) –

POST /events.scalar_metrics_iter_histogram

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

Request JSON Object

  • key (string) –

  • samples (integer) – The amount of histogram points to return (0 to return all the points). Optional, the default value is 6000.

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • images[] (object) –

POST /events.multi_task_scalar_metrics_iter_histogram

Used to compare scalar stats histogram of multiple tasks

Request JSON Object

  • key (string) –

  • samples (integer) – The amount of histogram points to return. Optional, the default value is 6000

  • tasks[] (string) – List of task Task IDs

Status Codes
POST /events.get_task_latest_scalar_values

Get the tasks’s latest scalar values

Request JSON Object

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • metrics[].name (string) – Metric name

  • metrics[].variants[].last_100_value (number) – Average of 100 last reported values

  • metrics[].variants[].last_value (number) – Last reported value

  • metrics[].variants[].name (string) – Variant name

POST /events.get_scalar_metrics_and_variants

get task scalar metrics and variants

Request JSON Object

  • task (string) – task ID (required)

Status Codes
Response JSON Object

  • metrics (object) –

POST /events.get_scalar_metric_data

get scalar metric data for task

Request JSON Object

  • metric (string) – type of metric

  • task (string) – task ID

Status Codes
Response JSON Object

  • events[] (object) –

  • returned (integer) – amount of events returned

  • scroll_id (string) – Scroll ID of previous call (used for getting more results)

  • total (integer) – amount of events in task

POST /login.supported_modes

Return supported login modes.

Request JSON Object

  • callback_url_prefix (string) – URL prefix used to generate the callback URL for each supported SSO provider

  • state (string) – ASCII base64 encoded application state

Status Codes
Response JSON Object

  • authenticated (boolean) – Is user authenticated

  • basic.enabled (boolean) – Basic aothentication (fixed users mode) mode enabled

  • basic.guest.enabled (boolean) – Basic aothentication guest mode enabled

  • basic.guest.name (string) – Guest name

  • basic.guest.password (string) – Guest password

  • basic.guest.username (string) – Guest username

  • server_errors.es_connection_error (boolean) – Indicate an error communicating to Elasticsearch

  • server_errors.missed_es_upgrade (boolean) – Indicate that Elasticsearch database was not upgraded from version 5

  • sso (object) – SSO authentication providers

  • sso_providers[] (object) –

POST /login.logout

Logout (including SSO, if used))

Status Codes
POST /models.get_by_id

Gets model information

Request JSON Object

  • model (string) – Model id (required)

Status Codes
Response JSON Object

  • model.comment (string) – Model comment

  • model.company (string) – Company id

  • model.created (string) – Model creation time

  • model.design (object) – Json object representing the model design. Should be identical to the network design of the task which created the model

  • model.framework (string) – Framework on which the model is based. Should be identical to the framework of the task which created the model

  • model.id (string) – Model id

  • model.labels (object) – Json object representing the ids of the labels in the model. The keys are the layers’ names and the values are the ids.

  • model.last_update (string) – Model last update time

  • model.metadata[].key (string) – The key uniquely identifying the metadata item inside the given entity

  • model.metadata[].type (string) – The type of the metadata item

  • model.metadata[].value (string) – The value stored in the metadata item

  • model.name (string) – Model name

  • model.parent (string) – Parent model ID

  • model.project (string) – Associated project ID

  • model.ready (boolean) – Indication if the model is final and can be used by other tasks

  • model.system_tags[] (string) –

  • model.tags[] (string) –

  • model.task (string) – Task ID of task in which the model was created

  • model.ui_cache (object) – UI cache for this model

  • model.uri (string) – URI for the model, pointing to the destination storage.

  • model.user (string) – Associated user id

POST /models.get_by_task_id

Gets model information

Request JSON Object

  • task (string) – Task id

Status Codes
Response JSON Object

  • model.comment (string) – Model comment

  • model.company (string) – Company id

  • model.created (string) – Model creation time

  • model.design (object) – Json object representing the model design. Should be identical to the network design of the task which created the model

  • model.framework (string) – Framework on which the model is based. Should be identical to the framework of the task which created the model

  • model.id (string) – Model id

  • model.labels (object) – Json object representing the ids of the labels in the model. The keys are the layers’ names and the values are the ids.

  • model.last_update (string) – Model last update time

  • model.metadata[].key (string) – The key uniquely identifying the metadata item inside the given entity

  • model.metadata[].type (string) – The type of the metadata item

  • model.metadata[].value (string) – The value stored in the metadata item

  • model.name (string) – Model name

  • model.parent (string) – Parent model ID

  • model.project (string) – Associated project ID

  • model.ready (boolean) – Indication if the model is final and can be used by other tasks

  • model.system_tags[] (string) –

  • model.tags[] (string) –

  • model.task (string) – Task ID of task in which the model was created

  • model.ui_cache (object) – UI cache for this model

  • model.uri (string) – URI for the model, pointing to the destination storage.

  • model.user (string) – Associated user id

POST /models.get_by_id_ex

Get all models

Request JSON Object

  • _all_.fields[] (string) –

  • _all_.pattern (string) – Pattern string (regex)

  • _any_.fields[] (string) –

  • _any_.pattern (string) – Pattern string (regex)

  • framework[] (string) –

  • id[] (string) –

  • name (string) – Get only models whose name matches this pattern (python regular expression syntax)

  • only_fields[] (string) –

  • order_by[] (string) –

  • page (integer) – Page number, returns a specific page out of the resulting list of models

  • page_size (integer) – Page size, specifies the number of results returned in each page (last page may contain fewer results)

  • project[] (string) –

  • ready (boolean) – Indication whether to retrieve only models that are marked ready If not supplied returns both ready and not-ready projects.

  • search_text (string) – Free text search query

  • system_tags[] (string) –

  • tags[] (string) –

  • task[] (string) –

  • uri[] (string) –

  • user[] (string) –

Status Codes
Response JSON Object

  • models[].comment (string) – Model comment

  • models[].company (string) – Company id

  • models[].created (string) – Model creation time

  • models[].design (object) – Json object representing the model design. Should be identical to the network design of the task which created the model

  • models[].framework (string) – Framework on which the model is based. Should be identical to the framework of the task which created the model

  • models[].id (string) – Model id

  • models[].labels (object) – Json object representing the ids of the labels in the model. The keys are the layers’ names and the values are the ids.

  • models[].last_update (string) – Model last update time

  • models[].metadata[].key (string) – The key uniquely identifying the metadata item inside the given entity

  • models[].metadata[].type (string) – The type of the metadata item

  • models[].metadata[].value (string) – The value stored in the metadata item

  • models[].name (string) – Model name

  • models[].parent (string) – Parent model ID

  • models[].project (string) – Associated project ID

  • models[].ready (boolean) – Indication if the model is final and can be used by other tasks

  • models[].system_tags[] (string) –

  • models[].tags[] (string) –

  • models[].task (string) – Task ID of task in which the model was created

  • models[].ui_cache (object) – UI cache for this model

  • models[].uri (string) – URI for the model, pointing to the destination storage.

  • models[].user (string) – Associated user id

POST /models.get_all_ex

Get all models

Request JSON Object

  • _all_.fields[] (string) –

  • _all_.pattern (string) – Pattern string (regex)

  • _any_.fields[] (string) –

  • _any_.pattern (string) – Pattern string (regex)

  • framework[] (string) –

  • id[] (string) –

  • include_subprojects (boolean) – If set to ‘true’ and project field is set then models from the subprojects are searched too

  • name (string) – Get only models whose name matches this pattern (python regular expression syntax)

  • only_fields[] (string) –

  • order_by[] (string) –

  • page (integer) – Page number, returns a specific page out of the resulting list of models

  • page_size (integer) – Page size, specifies the number of results returned in each page (last page may contain fewer results)

  • project[] (string) –

  • ready (boolean) – Indication whether to retrieve only models that are marked ready If not supplied returns both ready and not-ready projects.

  • search_text (string) – Free text search query

  • system_tags[] (string) –

  • tags[] (string) –

  • task[] (string) –

  • uri[] (string) –

  • user[] (string) –

Status Codes
Response JSON Object

  • models[].comment (string) – Model comment

  • models[].company (string) – Company id

  • models[].created (string) – Model creation time

  • models[].design (object) – Json object representing the model design. Should be identical to the network design of the task which created the model

  • models[].framework (string) – Framework on which the model is based. Should be identical to the framework of the task which created the model

  • models[].id (string) – Model id

  • models[].labels (object) – Json object representing the ids of the labels in the model. The keys are the layers’ names and the values are the ids.

  • models[].last_update (string) – Model last update time

  • models[].metadata[].key (string) – The key uniquely identifying the metadata item inside the given entity

  • models[].metadata[].type (string) – The type of the metadata item

  • models[].metadata[].value (string) – The value stored in the metadata item

  • models[].name (string) – Model name

  • models[].parent (string) – Parent model ID

  • models[].project (string) – Associated project ID

  • models[].ready (boolean) – Indication if the model is final and can be used by other tasks

  • models[].system_tags[] (string) –

  • models[].tags[] (string) –

  • models[].task (string) – Task ID of task in which the model was created

  • models[].ui_cache (object) – UI cache for this model

  • models[].uri (string) – URI for the model, pointing to the destination storage.

  • models[].user (string) – Associated user id

POST /models.get_all

Get all models

Request JSON Object

  • _all_.fields[] (string) –

  • _all_.pattern (string) – Pattern string (regex)

  • _any_.fields[] (string) –

  • _any_.pattern (string) – Pattern string (regex)

  • framework[] (string) –

  • id[] (string) –

  • name (string) – Get only models whose name matches this pattern (python regular expression syntax)

  • only_fields[] (string) –

  • order_by[] (string) –

  • page (integer) – Page number, returns a specific page out of the resulting list of models

  • page_size (integer) – Page size, specifies the number of results returned in each page (last page may contain fewer results)

  • project[] (string) –

  • ready (boolean) – Indication whether to retrieve only models that are marked ready If not supplied returns both ready and not-ready projects.

  • search_text (string) – Free text search query

  • system_tags[] (string) –

  • tags[] (string) –

  • task[] (string) –

  • uri[] (string) –

  • user[] (string) –

Status Codes
Response JSON Object

  • models[].comment (string) – Model comment

  • models[].company (string) – Company id

  • models[].created (string) – Model creation time

  • models[].design (object) – Json object representing the model design. Should be identical to the network design of the task which created the model

  • models[].framework (string) – Framework on which the model is based. Should be identical to the framework of the task which created the model

  • models[].id (string) – Model id

  • models[].labels (object) – Json object representing the ids of the labels in the model. The keys are the layers’ names and the values are the ids.

  • models[].last_update (string) – Model last update time

  • models[].metadata[].key (string) – The key uniquely identifying the metadata item inside the given entity

  • models[].metadata[].type (string) – The type of the metadata item

  • models[].metadata[].value (string) – The value stored in the metadata item

  • models[].name (string) – Model name

  • models[].parent (string) – Parent model ID

  • models[].project (string) – Associated project ID

  • models[].ready (boolean) – Indication if the model is final and can be used by other tasks

  • models[].system_tags[] (string) –

  • models[].tags[] (string) –

  • models[].task (string) – Task ID of task in which the model was created

  • models[].ui_cache (object) – UI cache for this model

  • models[].uri (string) – URI for the model, pointing to the destination storage.

  • models[].user (string) – Associated user id

POST /models.get_frameworks

Get the list of frameworks used in the company models

Request JSON Object

  • projects[] (string) –

Status Codes
Response JSON Object

  • frameworks[] (string) –

POST /models.update_for_task

Create or update a new model for a task

Request JSON Object

  • comment (string) – Model comment

  • iteration (integer) – Iteration (used to update task statistics)

  • name (string) – Model name Unique within the company.

  • override_model_id (string) – Override model ID. If provided, this model is updated in the task. Exactly one of override_model_id or uri is required.

  • system_tags[] (string) –

  • tags[] (string) –

  • task (string) – Task id (required)

  • uri (string) – URI for the model. Exactly one of uri or override_model_id is a required.

Status Codes
Response JSON Object

  • created (boolean) – Was the model created

  • fields (object) – Updated fields names and values

  • id (string) – ID of the model

  • updated (integer) – Number of models updated (0 or 1)

POST /models.create

Create a new model not associated with a task

Request JSON Object

  • comment (string) – Model comment

  • design (object) – Json[d] object representing the model design. Should be identical to the network design of the task which created the model

  • framework (string) – Framework on which the model is based. Case insensitive. Should be identical to the framework of the task which created the model.

  • labels (object) – Json object

  • name (string) – Model name Unique within the company. (required)

  • parent (string) – Parent model

  • project (string) – Project to which to model belongs

  • public (boolean) – Create a public model Default is false.

  • ready (boolean) – Indication if the model is final and can be used by other tasks. Default is false.

  • system_tags[] (string) –

  • tags[] (string) –

  • task (string) – Associated task ID

  • uri (string) – URI for the model (required)

Status Codes
Response JSON Object

  • created (boolean) – Was the model created

  • id (string) – ID of the model

POST /models.edit

Edit an existing model

Request JSON Object

  • comment (string) – Model comment

  • design (object) – Json[d] object representing the model design. Should be identical to the network design of the task which created the model

  • framework (string) – Framework on which the model is based. Case insensitive. Should be identical to the framework of the task which created the model.

  • iteration (integer) – Iteration (used to update task statistics)

  • labels (object) – Json object

  • model (string) – Model ID (required)

  • name (string) – Model name Unique within the company.

  • parent (string) – Parent model

  • project (string) – Project to which to model belongs

  • ready (boolean) – Indication if the model is final and can be used by other tasks

  • system_tags[] (string) –

  • tags[] (string) –

  • task (string) – Associated task ID

  • uri (string) – URI for the model

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of models updated (0 or 1)

POST /models.update

Update a model

Request JSON Object

  • comment (string) – Model comment

  • created (string) – Model creation time (UTC)

  • iteration (integer) – Iteration (used to update task statistics if an associated task is reported)

  • model (string) – Model id (required)

  • name (string) – Model name Unique within the company.

  • project (string) – Project to which to model belongs

  • ready (boolean) – Indication if the model is final and can be used by other tasks Default is false.

  • system_tags[] (string) –

  • tags[] (string) –

  • task (string) – Associated task ID

  • ui_cache (object) – UI cache for this model

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of models updated (0 or 1)

POST /models.publish_many

Publish models

Request JSON Object

  • force_publish_task (boolean) – Publish the associated tasks (if exist) even if they are not in the ‘stopped’ state. Optional, the default value is False.

  • ids[] (string) –

  • publish_tasks (boolean) – Indicates that the associated tasks (if exist) should be published. Optional, the default value is True.

Status Codes
Response JSON Object

  • failed[].error.codes[] (integer) –

  • failed[].error.data (object) –

  • failed[].error.msg (string) –

  • failed[].id (string) – ID of the failed entity

  • succeeded[].id (string) – ID of the succeeded entity

  • succeeded[].published_task.data.fields (object) – Updated fields names and values

  • succeeded[].published_task.data.updated (integer) – Number of tasks updated (0 or 1)

  • succeeded[].published_task.id (string) – Task id

  • succeeded[].updated (boolean) – Indicates whether the model was updated

POST /models.set_ready

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

Request JSON Object

  • force_publish_task (boolean) – Publish the associated task (if exists) even if it is not in the ‘stopped’ state. Optional, the default value is False.

  • model (string) – Model id (required)

  • publish_task (boolean) – Indicates that the associated task (if exists) should be published. Optional, the default value is True.

Status Codes
Response JSON Object

  • published_task.data.fields (object) – Updated fields names and values

  • published_task.data.updated (integer) – Number of tasks updated (0 or 1)

  • published_task.id (string) – Task id

  • updated (integer) – Number of models updated (0 or 1)

POST /models.archive_many

Archive models

Request JSON Object

  • ids[] (string) –

Status Codes
Response JSON Object

  • failed[].error.codes[] (integer) –

  • failed[].error.data (object) –

  • failed[].error.msg (string) –

  • failed[].id (string) – ID of the failed entity

  • succeeded[].archived (boolean) – Indicates whether the model was archived

  • succeeded[].id (string) – ID of the succeeded entity

POST /models.unarchive_many

Unarchive models

Request JSON Object

  • ids[] (string) –

Status Codes
Response JSON Object

  • failed[].error.codes[] (integer) –

  • failed[].error.data (object) –

  • failed[].error.msg (string) –

  • failed[].id (string) – ID of the failed entity

  • succeeded[].id (string) – ID of the succeeded entity

  • succeeded[].unarchived (boolean) – Indicates whether the model was unarchived

POST /models.delete_many

Delete models

Request JSON Object

  • force (boolean) – Force. Required if there are tasks that use the model as an execution model, or if the model’s creating task is published.

  • ids[] (string) –

Status Codes
Response JSON Object

  • failed[].error.codes[] (integer) –

  • failed[].error.data (object) –

  • failed[].error.msg (string) –

  • failed[].id (string) – ID of the failed entity

  • succeeded[].deleted (boolean) – Indicates whether the model was deleted

  • succeeded[].id (string) – ID of the succeeded entity

  • succeeded[].url (string) – The url of the model file

POST /models.delete

Delete a model.

Request JSON Object

  • force (boolean) – Force. Required if there are tasks that use the model as an execution model, or if the model’s creating task is published.

  • model (string) – Model ID (required)

Status Codes
Response JSON Object

  • deleted (boolean) – Indicates whether the model was deleted

  • url (string) – The url of the model file

POST /models.make_public

Convert company models to public

Request JSON Object

  • ids[] (string) –

Status Codes
Response JSON Object

  • updated (integer) – Number of models updated

POST /models.make_private

Convert public models to private

Request JSON Object

  • ids[] (string) –

Status Codes
Response JSON Object

  • updated (integer) – Number of models updated

POST /models.move

Move models to a project

Request JSON Object

  • ids[] (string) –

  • project (string) – Target project ID. If not provided, project_name must be provided.

  • project_name (string) – 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.

Status Codes
POST /models.add_or_update_metadata

Add or update model metadata

Request JSON Object

  • metadata[].key (string) – The key uniquely identifying the metadata item inside the given entity

  • metadata[].type (string) – The type of the metadata item

  • metadata[].value (string) – The value stored in the metadata item

  • model (string) – ID of the model (required)

Status Codes
Response JSON Object

  • updated (integer) – Number of models updated (0 or 1)

POST /models.delete_metadata

Delete metadata from model

Request JSON Object

  • keys[] (string) –

  • model (string) – ID of the model (required)

Status Codes
Response JSON Object

  • updated (integer) – Number of models updated (0 or 1)

POST /organization.get_tags

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

Request JSON Object

  • filter.system_tags[] (string) –

  • filter.tags[] (string) –

  • include_system (boolean) – If set to ‘true’ then the list of the system tags is also returned. The default value is ‘false’

Status Codes
Response JSON Object

  • system_tags[] (string) –

  • tags[] (string) –

POST /organization.get_user_companies

Get details for all companies associated with the current user

Status Codes
Response JSON Object

  • companies[].allocated (integer) – Number of users allocated for company

  • companies[].id (string) – Company ID

  • companies[].name (string) – Company name

  • companies[].owners[].avatar (string) – User avatar (URL or base64-encoded data)

  • companies[].owners[].id (string) – User ID

  • companies[].owners[].name (string) – User Name

POST /projects.create

Create a new project

Request JSON Object

  • default_output_destination (string) – The default output destination URL for new tasks under this project

  • description (string) – Project description.

  • name (string) – Project name Unique within the company. (required)

  • system_tags[] (string) –

  • tags[] (string) –

Status Codes
Response JSON Object

  • id (string) – Project id

POST /projects.get_by_id
Request JSON Object

  • project (string) – Project id (required)

Status Codes
Response JSON Object

  • project.company (string) – Company id

  • project.created (string) – Creation time

  • project.default_output_destination (string) – The default output destination URL for new tasks under this project

  • project.description (string) – Project description

  • project.id (string) – Project id

  • project.last_update (string) – Last project update time. Reflects the last time the project metadata was changed or a task in this project has changed status

  • project.name (string) – Project name

  • project.system_tags[] (string) –

  • project.tags[] (string) –

  • project.user (string) – Associated user id

POST /projects.get_all

Get all the company’s projects and all public projects

Request JSON Object

  • _all_.fields[] (string) –

  • _all_.pattern (string) – Pattern string (regex)

  • _any_.fields[] (string) –

  • _any_.pattern (string) – Pattern string (regex)

  • description (string) – Get only projects whose description matches this pattern (python regular expression syntax)

  • id[] (string) –

  • name (string) – Get only projects whose name matches this pattern (python regular expression syntax)

  • only_fields[] (string) –

  • order_by[] (string) –

  • page (integer) – Page number, returns a specific page out of the resulting list of dataviews

  • page_size (integer) – Page size, specifies the number of results returned in each page (last page may contain fewer results)

  • search_text (string) – Free text search query

  • shallow_search (boolean) – 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).

  • system_tags[] (string) –

  • tags[] (string) –

Status Codes
Response JSON Object

  • projects[].company (string) – Company id

  • projects[].created (string) – Creation time

  • projects[].default_output_destination (string) – The default output destination URL for new tasks under this project

  • projects[].description (string) – Project description

  • projects[].id (string) – Project id

  • projects[].name (string) – Project name

  • projects[].stats.active.status_count.closed (integer) – Number of ‘closed’ tasks in project

  • projects[].stats.active.status_count.created (integer) – Number of ‘created’ tasks in project

  • projects[].stats.active.status_count.failed (integer) – Number of ‘failed’ tasks in project

  • projects[].stats.active.status_count.in_progress (integer) – Number of ‘in_progress’ tasks in project

  • projects[].stats.active.status_count.published (integer) – Number of ‘published’ tasks in project

  • projects[].stats.active.status_count.queued (integer) – Number of ‘queued’ tasks in project

  • projects[].stats.active.status_count.stopped (integer) – Number of ‘stopped’ tasks in project

  • projects[].stats.active.status_count.unknown (integer) – Number of ‘unknown’ tasks in project

  • projects[].stats.active.total_runtime (integer) – Total run time of all tasks in project (in seconds)

  • projects[].stats.archived.status_count.closed (integer) – Number of ‘closed’ tasks in project

  • projects[].stats.archived.status_count.created (integer) – Number of ‘created’ tasks in project

  • projects[].stats.archived.status_count.failed (integer) – Number of ‘failed’ tasks in project

  • projects[].stats.archived.status_count.in_progress (integer) – Number of ‘in_progress’ tasks in project

  • projects[].stats.archived.status_count.published (integer) – Number of ‘published’ tasks in project

  • projects[].stats.archived.status_count.queued (integer) – Number of ‘queued’ tasks in project

  • projects[].stats.archived.status_count.stopped (integer) – Number of ‘stopped’ tasks in project

  • projects[].stats.archived.status_count.unknown (integer) – Number of ‘unknown’ tasks in project

  • projects[].stats.archived.total_runtime (integer) – Total run time of all tasks in project (in seconds)

  • projects[].sub_projects[].id (string) – Subproject ID

  • projects[].sub_projects[].name (string) – Subproject name

  • projects[].system_tags[] (string) –

  • projects[].tags[] (string) –

  • projects[].user (string) – Associated user id

POST /projects.get_all_ex

Get all the company’s projects and all public projects

Request JSON Object

  • _all_.fields[] (string) –

  • _all_.pattern (string) – Pattern string (regex)

  • _any_.fields[] (string) –

  • _any_.pattern (string) – Pattern string (regex)

  • active_users[] (string) –

  • check_own_contents (boolean) – If set to ‘true’ and project ids are passed to the query then for these projects their own tasks, models and dataviews are counted

  • description (string) – Get only projects whose description matches this pattern (python regular expression syntax)

  • id[] (string) –

  • include_stats (boolean) – If true, include project statistic in response.

  • name (string) – Get only projects whose name matches this pattern (python regular expression syntax)

  • non_public (boolean) – Return only non-public projects

  • only_fields[] (string) –

  • order_by[] (string) –

  • page (integer) – Page number, returns a specific page out of the resulting list of dataviews

  • page_size (integer) – Page size, specifies the number of results returned in each page (last page may contain fewer results)

  • search_text (string) – Free text search query

  • shallow_search (boolean) – 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).

  • stats_for_state (string) – Report stats include only statistics for tasks in the specified state. If Null is provided, stats for all task states will be returned.

  • system_tags[] (string) –

  • tags[] (string) –

Status Codes
Response JSON Object

  • own_models (integer) – The amount of models under this project (without children projects). Returned if ‘check_own_contents’ flag is set in the request

  • own_tasks (integer) – The amount of tasks under this project (without children projects). Returned if ‘check_own_contents’ flag is set in the request

  • projects[].company (string) – Company id

  • projects[].created (string) – Creation time

  • projects[].default_output_destination (string) – The default output destination URL for new tasks under this project

  • projects[].description (string) – Project description

  • projects[].id (string) – Project id

  • projects[].name (string) – Project name

  • projects[].stats.active.status_count.closed (integer) – Number of ‘closed’ tasks in project

  • projects[].stats.active.status_count.created (integer) – Number of ‘created’ tasks in project

  • projects[].stats.active.status_count.failed (integer) – Number of ‘failed’ tasks in project

  • projects[].stats.active.status_count.in_progress (integer) – Number of ‘in_progress’ tasks in project

  • projects[].stats.active.status_count.published (integer) – Number of ‘published’ tasks in project

  • projects[].stats.active.status_count.queued (integer) – Number of ‘queued’ tasks in project

  • projects[].stats.active.status_count.stopped (integer) – Number of ‘stopped’ tasks in project

  • projects[].stats.active.status_count.unknown (integer) – Number of ‘unknown’ tasks in project

  • projects[].stats.active.total_runtime (integer) – Total run time of all tasks in project (in seconds)

  • projects[].stats.archived.status_count.closed (integer) – Number of ‘closed’ tasks in project

  • projects[].stats.archived.status_count.created (integer) – Number of ‘created’ tasks in project

  • projects[].stats.archived.status_count.failed (integer) – Number of ‘failed’ tasks in project

  • projects[].stats.archived.status_count.in_progress (integer) – Number of ‘in_progress’ tasks in project

  • projects[].stats.archived.status_count.published (integer) – Number of ‘published’ tasks in project

  • projects[].stats.archived.status_count.queued (integer) – Number of ‘queued’ tasks in project

  • projects[].stats.archived.status_count.stopped (integer) – Number of ‘stopped’ tasks in project

  • projects[].stats.archived.status_count.unknown (integer) – Number of ‘unknown’ tasks in project

  • projects[].stats.archived.total_runtime (integer) – Total run time of all tasks in project (in seconds)

  • projects[].sub_projects[].id (string) – Subproject ID

  • projects[].sub_projects[].name (string) – Subproject name

  • projects[].system_tags[] (string) –

  • projects[].tags[] (string) –

  • projects[].user (string) – Associated user id

POST /projects.update

Update project information

Request JSON Object

  • default_output_destination (string) – The default output destination URL for new tasks under this project

  • description (string) – Project description

  • name (string) – Project name. Unique within the company.

  • project (string) – Project id (required)

  • system_tags[] (string) –

  • tags[] (string) –

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of projects updated (0 or 1)

POST /projects.move

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

Request JSON Object

  • new_location (string) – The name location for the project

  • project (string) – Project id (required)

Status Codes
Response JSON Object

  • moved (integer) – The number of projects moved

POST /projects.merge

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

Request JSON Object

  • destination_project (string) – The ID of the destination project

  • project (string) – Project id (required)

Status Codes
Response JSON Object

  • moved_entities (integer) – The number of tasks, models and dataviews moved from the merged project into the destination

  • moved_projects (integer) – The number of child projects moved from the merged project into the destination

POST /projects.delete

Deletes a project

Request JSON Object

  • delete_contents (boolean) – If set to ‘true’ then the project tasks and models will be deleted. Otherwise their project property will be unassigned. Default value is ‘false’

  • force (boolean) – If not true, fails if project has tasks. If true, and project has tasks, they will be unassigned

  • project (string) – Project id (required)

Status Codes
Response JSON Object

  • deleted (integer) – Number of projects deleted (0 or 1)

  • deleted_models (integer) – Number of models deleted

  • deleted_tasks (integer) – Number of tasks deleted

  • disassociated_tasks (integer) – Number of tasks disassociated from the deleted project

  • urls.artifact_urls[] (string) –

  • urls.event_urls[] (string) –

  • urls.model_urls[] (string) –

POST /projects.get_unique_metric_variants

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.

Request JSON Object

  • include_subprojects (boolean) – If set to ‘true’ and the project field is set then the result includes metrics/variants from the subproject tasks

  • project (string) – Project ID

Status Codes
Response JSON Object

  • metrics[].metric (string) – Metric name

  • metrics[].metric_hash (string) – Metric name hash. Used instead of the metric name when categorizing last metrics events in task objects.

  • metrics[].variant (string) – Variant name

  • metrics[].variant_hash (string) – Variant name hash. Used instead of the variant name when categorizing last metrics events in task objects.

POST /projects.get_hyperparam_values

Get a list of distinct values for the chosen hyperparameter

Request JSON Object

  • allow_public (boolean) – If set to ‘true’ then collect values from both company and public tasks otherwise company tasks only. The default is ‘true’

  • include_subprojects (boolean) – If set to ‘true’ and the project field is set then the result includes hyper parameters values from the subproject tasks

  • name (string) – Hyperparameter name (required)

  • projects[] (string) –

  • section (string) – Hyperparameter section name (required)

Status Codes
Response JSON Object

  • total (integer) – Total number of distinct parameter values

  • values[] (string) –

POST /projects.get_hyper_parameters

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

Request JSON Object

  • include_subprojects (boolean) – If set to ‘true’ and the project field is set then the result includes hyper parameters from the subproject tasks

  • page (integer) – Page number

  • page_size (integer) – Page size

  • project (string) – Project ID

Status Codes
Response JSON Object

  • parameters[] (object) –

  • remaining (integer) – Remaining results

  • total (integer) – Total number of results

POST /projects.get_task_tags

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

Request JSON Object

  • filter.system_tags[] (string) –

  • filter.tags[] (string) –

  • include_system (boolean) – If set to ‘true’ then the list of the system tags is also returned. The default value is ‘false’

  • projects[] (string) –

Status Codes
Response JSON Object

  • system_tags[] (string) –

  • tags[] (string) –

POST /projects.get_model_tags

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

Request JSON Object

  • filter.system_tags[] (string) –

  • filter.tags[] (string) –

  • include_system (boolean) – If set to ‘true’ then the list of the system tags is also returned. The default value is ‘false’

  • projects[] (string) –

Status Codes
Response JSON Object

  • system_tags[] (string) –

  • tags[] (string) –

POST /projects.make_public

Convert company projects to public

Request JSON Object

  • ids[] (string) –

Status Codes
Response JSON Object

  • updated (integer) – Number of projects updated

POST /projects.make_private

Convert public projects to private

Request JSON Object

  • ids[] (string) –

Status Codes
Response JSON Object

  • updated (integer) – Number of projects updated

POST /projects.get_task_parents

Get unique parent tasks for the tasks in the specified projects

Request JSON Object

  • include_subprojects (boolean) – If set to ‘true’ and the projects field is not empty then the result includes tasks parents from the subproject tasks

  • projects[] (string) –

  • tasks_state (string) – Return parents for tasks in the specified state. If Null is provided, parents for all task states will be returned.

Status Codes
Response JSON Object

  • parents[].id (string) – The ID of the parent task

  • parents[].name (string) – The name of the parent task

  • parents[].project (object) –

POST /queues.get_by_id

Gets queue information

Request JSON Object

  • queue (string) – Queue ID (required)

Status Codes
Response JSON Object

  • queue.company (string) – Company id

  • queue.created (string) – Queue creation time

  • queue.entries[].added (string) – Time this entry was added to the queue

  • queue.entries[].task (string) – Queued task ID

  • queue.id (string) – Queue id

  • queue.metadata[].key (string) – The key uniquely identifying the metadata item inside the given entity

  • queue.metadata[].type (string) – The type of the metadata item

  • queue.metadata[].value (string) – The value stored in the metadata item

  • queue.name (string) – Queue name

  • queue.system_tags[] (string) –

  • queue.tags[] (string) –

  • queue.user (string) – Associated user id

POST /queues.get_all_ex

Get all queues

Request JSON Object

  • id[] (string) –

  • name (string) – Get only queues whose name matches this pattern (python regular expression syntax)

  • only_fields[] (string) –

  • order_by[] (string) –

  • page (integer) – Page number, returns a specific page out of the result list of results.

  • page_size (integer) – Page size, specifies the number of results returned in each page (last page may contain fewer results)

  • search_text (string) – Free text search query

  • system_tags[] (string) –

  • tags[] (string) –

Status Codes
Response JSON Object

  • queues[].company (string) – Company id

  • queues[].created (string) – Queue creation time

  • queues[].entries[].added (string) – Time this entry was added to the queue

  • queues[].entries[].task (string) – Queued task ID

  • queues[].id (string) – Queue id

  • queues[].metadata[].key (string) – The key uniquely identifying the metadata item inside the given entity

  • queues[].metadata[].type (string) – The type of the metadata item

  • queues[].metadata[].value (string) – The value stored in the metadata item

  • queues[].name (string) – Queue name

  • queues[].system_tags[] (string) –

  • queues[].tags[] (string) –

  • queues[].user (string) – Associated user id

POST /queues.get_all

Get all queues

Request JSON Object

  • id[] (string) –

  • name (string) – Get only queues whose name matches this pattern (python regular expression syntax)

  • only_fields[] (string) –

  • order_by[] (string) –

  • page (integer) – Page number, returns a specific page out of the result list of results.

  • page_size (integer) – Page size, specifies the number of results returned in each page (last page may contain fewer results)

  • search_text (string) – Free text search query

  • system_tags[] (string) –

  • tags[] (string) –

Status Codes
Response JSON Object

  • queues[].company (string) – Company id

  • queues[].created (string) – Queue creation time

  • queues[].entries[].added (string) – Time this entry was added to the queue

  • queues[].entries[].task (string) – Queued task ID

  • queues[].id (string) – Queue id

  • queues[].metadata[].key (string) – The key uniquely identifying the metadata item inside the given entity

  • queues[].metadata[].type (string) – The type of the metadata item

  • queues[].metadata[].value (string) – The value stored in the metadata item

  • queues[].name (string) – Queue name

  • queues[].system_tags[] (string) –

  • queues[].tags[] (string) –

  • queues[].user (string) – Associated user id

POST /queues.get_default
Status Codes
Response JSON Object

  • id (string) – Queue id

  • name (string) – Queue name

POST /queues.create

Create a new queue

Request JSON Object

  • name (string) – Queue name Unique within the company. (required)

  • system_tags[] (string) –

  • tags[] (string) –

Status Codes
Response JSON Object

  • id (string) – New queue ID

POST /queues.update

Update queue information

Request JSON Object

  • name (string) – Queue name Unique within the company.

  • queue (string) – Queue id (required)

  • system_tags[] (string) –

  • tags[] (string) –

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of queues updated (0 or 1)

POST /queues.delete

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

Request JSON Object

  • force (boolean) – Force delete of non-empty queue. Defaults to false

  • queue (string) – Queue id (required)

Status Codes
Response JSON Object

  • deleted (integer) – Number of queues deleted (0 or 1)

POST /queues.add_task

Adds a task entry to the queue.

Request JSON Object

  • queue (string) – Queue id (required)

  • task (string) – Task id (required)

Status Codes
Response JSON Object

  • added (integer) – Number of tasks added (0 or 1)

POST /queues.get_next_task

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

Request JSON Object

  • queue (string) – Queue id (required)

Status Codes
Response JSON Object

  • entry.added (string) – Time this entry was added to the queue

  • entry.task (string) – Queued task ID

POST /queues.remove_task

Removes a task entry from the queue.

Request JSON Object

  • queue (string) – Queue id (required)

  • task (string) – Task id (required)

Status Codes
Response JSON Object

  • removed (integer) – Number of tasks removed (0 or 1)

POST /queues.move_task_forward

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

Request JSON Object

  • count (integer) – Number of positions in the queue to move the task forward relative to the current position. Optional, the default value is 1.

  • queue (string) – Queue id (required)

  • task (string) – Task id (required)

Status Codes
Response JSON Object

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

POST /queues.move_task_backward
Request JSON Object

  • count (integer) – Number of positions in the queue to move the task forward relative to the current position. Optional, the default value is 1.

  • queue (string) – Queue id (required)

  • task (string) – Task id (required)

Status Codes
Response JSON Object

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

POST /queues.move_task_to_front
Request JSON Object

  • queue (string) – Queue id (required)

  • task (string) – Task id (required)

Status Codes
Response JSON Object

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

POST /queues.move_task_to_back
Request JSON Object

  • queue (string) – Queue id (required)

  • task (string) – Task id (required)

Status Codes
Response JSON Object

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

POST /queues.get_queue_metrics

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

Request JSON Object

  • from_date (number) – Starting time (in seconds from epoch) for collecting metrics (required)

  • interval (integer) – Time interval in seconds for a single metrics point. The minimal value is 1 (required)

  • queue_ids[] (string) –

  • to_date (number) – Ending time (in seconds from epoch) for collecting metrics (required)

Status Codes
Response JSON Object

  • queues[].avg_waiting_times[] (number) –

  • queues[].dates[] (integer) –

  • queues[].queue (string) – ID of the queue

  • queues[].queue_lengths[] (integer) –

POST /queues.add_or_update_metadata

Add or update queue metadata

Request JSON Object

  • metadata[].key (string) – The key uniquely identifying the metadata item inside the given entity

  • metadata[].type (string) – The type of the metadata item

  • metadata[].value (string) – The value stored in the metadata item

  • queue (string) – ID of the queue (required)

Status Codes
Response JSON Object

  • updated (integer) – Number of queues updated (0 or 1)

POST /queues.delete_metadata

Delete metadata from queue

Request JSON Object

  • keys[] (string) –

  • queue (string) – ID of the queue (required)

Status Codes
Response JSON Object

  • updated (integer) – Number of queues updated (0 or 1)

POST /server.get_stats

Internal. Get the server collected statistics.

Request JSON Object

  • interval (long) – The period for statistics collection in seconds.

Status Codes
POST /server.config

Internal. Get server configuration. Secure section is not returned.

Request JSON Object

  • path (string) – Path of config value. Defaults to root

Status Codes
POST /server.info

Internal. Get server information, including version and build number

Status Codes
Response JSON Object

  • api_version (string) – Max API version supported

  • build (string) – Build number

  • commit (string) – VCS commit number

  • uid (string) – Server UID

  • version (string) – Version string

POST /server.endpoints

Internal. Show available endpoints

Status Codes
POST /server.report_stats_option

Internal. Get or set the report statistics option per-company

Request JSON Object

  • enabled (boolean) – If provided, sets the report statistics option (true/false)

Status Codes
Response JSON Object

  • current_version (string) – Returns the current server version

  • enabled (boolean) – Returns the current report stats option value

  • enabled_time (string) – If enabled, returns the time at which option was enabled

  • enabled_user (string) – If enabled, returns Id of the user who enabled the option

  • enabled_version (string) – If enabled, returns the server version at the time option was enabled

  • supported (boolean) – Is this feature supported by the server

POST /tasks.get_by_id

Gets task information

Request JSON Object

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • task.active_duration (integer) – Task duration time (seconds)

  • task.comment (string) – Free text comment

  • task.company (string) – Company ID

  • task.completed (string) – Task end time (UTC)

  • task.configuration (object) – Task configuration params

  • task.container (object) – Docker container parameters

  • task.created (string) – Task creation time (UTC)

  • task.execution.artifacts[].content_size (integer) – Raw data length in bytes

  • task.execution.artifacts[].display_data[][] (string) –

  • task.execution.artifacts[].hash (string) – Hash of entire raw data

  • task.execution.artifacts[].key (string) – Entry key (required)

  • task.execution.artifacts[].mode (string) –

  • task.execution.artifacts[].timestamp (integer) – Epoch time when artifact was created

  • task.execution.artifacts[].type (string) – System defined type (required)

  • task.execution.artifacts[].type_data.content_type (string) – System defined raw data content type

  • task.execution.artifacts[].type_data.data_hash (string) – Hash of raw data, without any headers or descriptive parts

  • task.execution.artifacts[].type_data.preview (string) – Description or textual data

  • task.execution.artifacts[].uri (string) – Raw data location

  • task.execution.docker_cmd (string) – Command for running docker script for the execution of the task

  • task.execution.framework (string) – Framework related to the task. Case insensitive. Mandatory for Training tasks.

  • task.execution.model (string) – Execution input model ID Not applicable for Register (Import) tasks

  • task.execution.model_desc (object) – Json object representing the Model descriptors

  • task.execution.model_labels (object) – Json object representing the ids of the labels in the model. The keys are the layers’ names and the values are the IDs. Not applicable for Register (Import) tasks. Mandatory for Training tasks

  • task.execution.parameters (object) – Json object containing the Task parameters

  • task.execution.queue (string) – Queue ID where task was queued.

  • task.hyperparams (object) – Task hyper params per section

  • task.id (string) – Task id

  • task.last_change (string) – Last time any update was done to the task

  • task.last_iteration (integer) – Last iteration reported for this task

  • task.last_metrics (object) – Last metric variants (hash to events), one for each metric hash

  • task.last_update (string) – Last time this task was created, updated, changed or events for this task were reported

  • task.last_worker (string) – ID of last worker that handled the task

  • task.last_worker_report (string) – Last time a worker reported while working on this task

  • task.models.input[].model (string) – The model ID (required)

  • task.models.input[].name (string) – The task model name (required)

  • task.models.output[].model (string) – The model ID (required)

  • task.models.output[].name (string) – The task model name (required)

  • task.name (string) – Task Name

  • task.output.destination (string) – Storage id. This is where output files will be stored.

  • task.output.error (string) – Last error text

  • task.output.model (string) – Model id.

  • task.output.result (string) – Task result. Values: ‘success’, ‘failure’

  • task.parent (string) – Parent task id

  • task.project (string) – Project ID of the project to which this task is assigned

  • task.published (string) – Last status change time

  • task.runtime (object) – Task runtime mapping

  • task.script.binary (string) – Binary to use when running the script

  • task.script.branch (string) – Repository branch id If not provided and tag not provided, default repository branch is used.

  • task.script.diff (string) – Uncommitted changes found in the repository when task was run

  • task.script.entry_point (string) – Path to execute within the repository

  • task.script.repository (string) – Name of the repository where the script is located

  • task.script.requirements (object) – A JSON object containing requirements strings by key

  • task.script.tag (string) – Repository tag

  • task.script.version_num (string) – Version (changeset) number. Optional (default is head version) Unused if tag is provided.

  • task.script.working_dir (string) – Path to the folder from which to run the script Default - root folder of repository

  • task.started (string) – Task start time (UTC)

  • task.status (string) –

  • task.status_changed (string) – Last status change time

  • task.status_message (string) – free text string representing info about the status

  • task.status_reason (string) – Reason for last status change

  • task.system_tags[] (string) –

  • task.tags[] (string) –

  • task.type (string) –

  • task.user (string) – Associated user id

POST /tasks.get_by_id_ex

Get all the company’s tasks and all public tasks

Request JSON Object

  • _all_.fields[] (string) –

  • _all_.pattern (string) – Pattern string (regex)

  • _any_.fields[] (string) –

  • _any_.pattern (string) – Pattern string (regex)

  • id[] (string) –

  • name (string) – Get only tasks whose name matches this pattern (python regular expression syntax)

  • only_fields[] (string) –

  • order_by[] (string) –

  • page (integer) – Page number, returns a specific page out of the resulting list of tasks

  • page_size (integer) – Page size, specifies the number of results returned in each page (last page may contain fewer results)

  • parent (string) – Parent ID

  • project[] (string) –

  • search_text (string) – Free text search query

  • status[] (string) –

  • status_changed[] (string) –

  • system_tags[] (string) –

  • tags[] (string) –

  • type[] (string) –

  • user[] (string) –

Status Codes
Response JSON Object

  • tasks[].active_duration (integer) – Task duration time (seconds)

  • tasks[].comment (string) – Free text comment

  • tasks[].company (string) – Company ID

  • tasks[].completed (string) – Task end time (UTC)

  • tasks[].configuration (object) – Task configuration params

  • tasks[].container (object) – Docker container parameters

  • tasks[].created (string) – Task creation time (UTC)

  • tasks[].execution.artifacts[].content_size (integer) – Raw data length in bytes

  • tasks[].execution.artifacts[].display_data[][] (string) –

  • tasks[].execution.artifacts[].hash (string) – Hash of entire raw data

  • tasks[].execution.artifacts[].key (string) – Entry key (required)

  • tasks[].execution.artifacts[].mode (string) –

  • tasks[].execution.artifacts[].timestamp (integer) – Epoch time when artifact was created

  • tasks[].execution.artifacts[].type (string) – System defined type (required)

  • tasks[].execution.artifacts[].type_data.content_type (string) – System defined raw data content type

  • tasks[].execution.artifacts[].type_data.data_hash (string) – Hash of raw data, without any headers or descriptive parts

  • tasks[].execution.artifacts[].type_data.preview (string) – Description or textual data

  • tasks[].execution.artifacts[].uri (string) – Raw data location

  • tasks[].execution.docker_cmd (string) – Command for running docker script for the execution of the task

  • tasks[].execution.framework (string) – Framework related to the task. Case insensitive. Mandatory for Training tasks.

  • tasks[].execution.model (string) – Execution input model ID Not applicable for Register (Import) tasks

  • tasks[].execution.model_desc (object) – Json object representing the Model descriptors

  • tasks[].execution.model_labels (object) – Json object representing the ids of the labels in the model. The keys are the layers’ names and the values are the IDs. Not applicable for Register (Import) tasks. Mandatory for Training tasks

  • tasks[].execution.parameters (object) – Json object containing the Task parameters

  • tasks[].execution.queue (string) – Queue ID where task was queued.

  • tasks[].hyperparams (object) – Task hyper params per section

  • tasks[].id (string) – Task id

  • tasks[].last_change (string) – Last time any update was done to the task

  • tasks[].last_iteration (integer) – Last iteration reported for this task

  • tasks[].last_metrics (object) – Last metric variants (hash to events), one for each metric hash

  • tasks[].last_update (string) – Last time this task was created, updated, changed or events for this task were reported

  • tasks[].last_worker (string) – ID of last worker that handled the task

  • tasks[].last_worker_report (string) – Last time a worker reported while working on this task

  • tasks[].models.input[].model (string) – The model ID (required)

  • tasks[].models.input[].name (string) – The task model name (required)

  • tasks[].models.output[].model (string) – The model ID (required)

  • tasks[].models.output[].name (string) – The task model name (required)

  • tasks[].name (string) – Task Name

  • tasks[].output.destination (string) – Storage id. This is where output files will be stored.

  • tasks[].output.error (string) – Last error text

  • tasks[].output.model (string) – Model id.

  • tasks[].output.result (string) – Task result. Values: ‘success’, ‘failure’

  • tasks[].parent (string) – Parent task id

  • tasks[].project (string) – Project ID of the project to which this task is assigned

  • tasks[].published (string) – Last status change time

  • tasks[].runtime (object) – Task runtime mapping

  • tasks[].script.binary (string) – Binary to use when running the script

  • tasks[].script.branch (string) – Repository branch id If not provided and tag not provided, default repository branch is used.

  • tasks[].script.diff (string) – Uncommitted changes found in the repository when task was run

  • tasks[].script.entry_point (string) – Path to execute within the repository

  • tasks[].script.repository (string) – Name of the repository where the script is located

  • tasks[].script.requirements (object) – A JSON object containing requirements strings by key

  • tasks[].script.tag (string) – Repository tag

  • tasks[].script.version_num (string) – Version (changeset) number. Optional (default is head version) Unused if tag is provided.

  • tasks[].script.working_dir (string) – Path to the folder from which to run the script Default - root folder of repository

  • tasks[].started (string) – Task start time (UTC)

  • tasks[].status (string) –

  • tasks[].status_changed (string) – Last status change time

  • tasks[].status_message (string) – free text string representing info about the status

  • tasks[].status_reason (string) – Reason for last status change

  • tasks[].system_tags[] (string) –

  • tasks[].tags[] (string) –

  • tasks[].type (string) –

  • tasks[].user (string) – Associated user id

POST /tasks.get_all_ex

Get all the company’s tasks and all public tasks

Request JSON Object

  • _all_.fields[] (string) –

  • _all_.pattern (string) – Pattern string (regex)

  • _any_.fields[] (string) –

  • _any_.pattern (string) – Pattern string (regex)

  • id[] (string) –

  • include_subprojects (boolean) – If set to ‘true’ and project field is set then tasks from the subprojects are searched too

  • name (string) – Get only tasks whose name matches this pattern (python regular expression syntax)

  • only_fields[] (string) –

  • order_by[] (string) –

  • page (integer) – Page number, returns a specific page out of the resulting list of tasks

  • page_size (integer) – Page size, specifies the number of results returned in each page (last page may contain fewer results)

  • parent (string) – Parent ID

  • project[] (string) –

  • search_text (string) – Free text search query

  • status[] (string) –

  • status_changed[] (string) –

  • system_tags[] (string) –

  • tags[] (string) –

  • type[] (string) –

  • user[] (string) –

Status Codes
Response JSON Object

  • tasks[].active_duration (integer) – Task duration time (seconds)

  • tasks[].comment (string) – Free text comment

  • tasks[].company (string) – Company ID

  • tasks[].completed (string) – Task end time (UTC)

  • tasks[].configuration (object) – Task configuration params

  • tasks[].container (object) – Docker container parameters

  • tasks[].created (string) – Task creation time (UTC)

  • tasks[].execution.artifacts[].content_size (integer) – Raw data length in bytes

  • tasks[].execution.artifacts[].display_data[][] (string) –

  • tasks[].execution.artifacts[].hash (string) – Hash of entire raw data

  • tasks[].execution.artifacts[].key (string) – Entry key (required)

  • tasks[].execution.artifacts[].mode (string) –

  • tasks[].execution.artifacts[].timestamp (integer) – Epoch time when artifact was created

  • tasks[].execution.artifacts[].type (string) – System defined type (required)

  • tasks[].execution.artifacts[].type_data.content_type (string) – System defined raw data content type

  • tasks[].execution.artifacts[].type_data.data_hash (string) – Hash of raw data, without any headers or descriptive parts

  • tasks[].execution.artifacts[].type_data.preview (string) – Description or textual data

  • tasks[].execution.artifacts[].uri (string) – Raw data location

  • tasks[].execution.docker_cmd (string) – Command for running docker script for the execution of the task

  • tasks[].execution.framework (string) – Framework related to the task. Case insensitive. Mandatory for Training tasks.

  • tasks[].execution.model (string) – Execution input model ID Not applicable for Register (Import) tasks

  • tasks[].execution.model_desc (object) – Json object representing the Model descriptors

  • tasks[].execution.model_labels (object) – Json object representing the ids of the labels in the model. The keys are the layers’ names and the values are the IDs. Not applicable for Register (Import) tasks. Mandatory for Training tasks

  • tasks[].execution.parameters (object) – Json object containing the Task parameters

  • tasks[].execution.queue (string) – Queue ID where task was queued.

  • tasks[].hyperparams (object) – Task hyper params per section

  • tasks[].id (string) – Task id

  • tasks[].last_change (string) – Last time any update was done to the task

  • tasks[].last_iteration (integer) – Last iteration reported for this task

  • tasks[].last_metrics (object) – Last metric variants (hash to events), one for each metric hash

  • tasks[].last_update (string) – Last time this task was created, updated, changed or events for this task were reported

  • tasks[].last_worker (string) – ID of last worker that handled the task

  • tasks[].last_worker_report (string) – Last time a worker reported while working on this task

  • tasks[].models.input[].model (string) – The model ID (required)

  • tasks[].models.input[].name (string) – The task model name (required)

  • tasks[].models.output[].model (string) – The model ID (required)

  • tasks[].models.output[].name (string) – The task model name (required)

  • tasks[].name (string) – Task Name

  • tasks[].output.destination (string) – Storage id. This is where output files will be stored.

  • tasks[].output.error (string) – Last error text

  • tasks[].output.model (string) – Model id.

  • tasks[].output.result (string) – Task result. Values: ‘success’, ‘failure’

  • tasks[].parent (string) – Parent task id

  • tasks[].project (string) – Project ID of the project to which this task is assigned

  • tasks[].published (string) – Last status change time

  • tasks[].runtime (object) – Task runtime mapping

  • tasks[].script.binary (string) – Binary to use when running the script

  • tasks[].script.branch (string) – Repository branch id If not provided and tag not provided, default repository branch is used.

  • tasks[].script.diff (string) – Uncommitted changes found in the repository when task was run

  • tasks[].script.entry_point (string) – Path to execute within the repository

  • tasks[].script.repository (string) – Name of the repository where the script is located

  • tasks[].script.requirements (object) – A JSON object containing requirements strings by key

  • tasks[].script.tag (string) – Repository tag

  • tasks[].script.version_num (string) – Version (changeset) number. Optional (default is head version) Unused if tag is provided.

  • tasks[].script.working_dir (string) – Path to the folder from which to run the script Default - root folder of repository

  • tasks[].started (string) – Task start time (UTC)

  • tasks[].status (string) –

  • tasks[].status_changed (string) – Last status change time

  • tasks[].status_message (string) – free text string representing info about the status

  • tasks[].status_reason (string) – Reason for last status change

  • tasks[].system_tags[] (string) –

  • tasks[].tags[] (string) –

  • tasks[].type (string) –

  • tasks[].user (string) – Associated user id

POST /tasks.get_all

Get all the company’s tasks and all public tasks

Request JSON Object

  • _all_.fields[] (string) –

  • _all_.pattern (string) – Pattern string (regex)

  • _any_.fields[] (string) –

  • _any_.pattern (string) – Pattern string (regex)

  • id[] (string) –

  • name (string) – Get only tasks whose name matches this pattern (python regular expression syntax)

  • only_fields[] (string) –

  • order_by[] (string) –

  • page (integer) – Page number, returns a specific page out of the resulting list of tasks

  • page_size (integer) – Page size, specifies the number of results returned in each page (last page may contain fewer results)

  • parent (string) – Parent ID

  • project[] (string) –

  • search_text (string) – Free text search query

  • status[] (string) –

  • status_changed[] (string) –

  • system_tags[] (string) –

  • tags[] (string) –

  • type[] (string) –

  • user[] (string) –

Status Codes
Response JSON Object

  • tasks[].active_duration (integer) – Task duration time (seconds)

  • tasks[].comment (string) – Free text comment

  • tasks[].company (string) – Company ID

  • tasks[].completed (string) – Task end time (UTC)

  • tasks[].configuration (object) – Task configuration params

  • tasks[].container (object) – Docker container parameters

  • tasks[].created (string) – Task creation time (UTC)

  • tasks[].execution.artifacts[].content_size (integer) – Raw data length in bytes

  • tasks[].execution.artifacts[].display_data[][] (string) –

  • tasks[].execution.artifacts[].hash (string) – Hash of entire raw data

  • tasks[].execution.artifacts[].key (string) – Entry key (required)

  • tasks[].execution.artifacts[].mode (string) –

  • tasks[].execution.artifacts[].timestamp (integer) – Epoch time when artifact was created

  • tasks[].execution.artifacts[].type (string) – System defined type (required)

  • tasks[].execution.artifacts[].type_data.content_type (string) – System defined raw data content type

  • tasks[].execution.artifacts[].type_data.data_hash (string) – Hash of raw data, without any headers or descriptive parts

  • tasks[].execution.artifacts[].type_data.preview (string) – Description or textual data

  • tasks[].execution.artifacts[].uri (string) – Raw data location

  • tasks[].execution.docker_cmd (string) – Command for running docker script for the execution of the task

  • tasks[].execution.framework (string) – Framework related to the task. Case insensitive. Mandatory for Training tasks.

  • tasks[].execution.model (string) – Execution input model ID Not applicable for Register (Import) tasks

  • tasks[].execution.model_desc (object) – Json object representing the Model descriptors

  • tasks[].execution.model_labels (object) – Json object representing the ids of the labels in the model. The keys are the layers’ names and the values are the IDs. Not applicable for Register (Import) tasks. Mandatory for Training tasks

  • tasks[].execution.parameters (object) – Json object containing the Task parameters

  • tasks[].execution.queue (string) – Queue ID where task was queued.

  • tasks[].hyperparams (object) – Task hyper params per section

  • tasks[].id (string) – Task id

  • tasks[].last_change (string) – Last time any update was done to the task

  • tasks[].last_iteration (integer) – Last iteration reported for this task

  • tasks[].last_metrics (object) – Last metric variants (hash to events), one for each metric hash

  • tasks[].last_update (string) – Last time this task was created, updated, changed or events for this task were reported

  • tasks[].last_worker (string) – ID of last worker that handled the task

  • tasks[].last_worker_report (string) – Last time a worker reported while working on this task

  • tasks[].models.input[].model (string) – The model ID (required)

  • tasks[].models.input[].name (string) – The task model name (required)

  • tasks[].models.output[].model (string) – The model ID (required)

  • tasks[].models.output[].name (string) – The task model name (required)

  • tasks[].name (string) – Task Name

  • tasks[].output.destination (string) – Storage id. This is where output files will be stored.

  • tasks[].output.error (string) – Last error text

  • tasks[].output.model (string) – Model id.

  • tasks[].output.result (string) – Task result. Values: ‘success’, ‘failure’

  • tasks[].parent (string) – Parent task id

  • tasks[].project (string) – Project ID of the project to which this task is assigned

  • tasks[].published (string) – Last status change time

  • tasks[].runtime (object) – Task runtime mapping

  • tasks[].script.binary (string) – Binary to use when running the script

  • tasks[].script.branch (string) – Repository branch id If not provided and tag not provided, default repository branch is used.

  • tasks[].script.diff (string) – Uncommitted changes found in the repository when task was run

  • tasks[].script.entry_point (string) – Path to execute within the repository

  • tasks[].script.repository (string) – Name of the repository where the script is located

  • tasks[].script.requirements (object) – A JSON object containing requirements strings by key

  • tasks[].script.tag (string) – Repository tag

  • tasks[].script.version_num (string) – Version (changeset) number. Optional (default is head version) Unused if tag is provided.

  • tasks[].script.working_dir (string) – Path to the folder from which to run the script Default - root folder of repository

  • tasks[].started (string) – Task start time (UTC)

  • tasks[].status (string) –

  • tasks[].status_changed (string) – Last status change time

  • tasks[].status_message (string) – free text string representing info about the status

  • tasks[].status_reason (string) – Reason for last status change

  • tasks[].system_tags[] (string) –

  • tasks[].tags[] (string) –

  • tasks[].type (string) –

  • tasks[].user (string) – Associated user id

POST /tasks.get_types

Get the list of task types used in the specified projects

Request JSON Object

  • projects[] (string) –

Status Codes
Response JSON Object

  • types[] (string) –

POST /tasks.clone

Clone an existing task

Request JSON Object

  • execution_overrides.artifacts[].content_size (integer) – Raw data length in bytes

  • execution_overrides.artifacts[].display_data[][] (string) –

  • execution_overrides.artifacts[].hash (string) – Hash of entire raw data

  • execution_overrides.artifacts[].key (string) – Entry key (required)

  • execution_overrides.artifacts[].mode (string) –

  • execution_overrides.artifacts[].timestamp (integer) – Epoch time when artifact was created

  • execution_overrides.artifacts[].type (string) – System defined type (required)

  • execution_overrides.artifacts[].type_data.content_type (string) – System defined raw data content type

  • execution_overrides.artifacts[].type_data.data_hash (string) – Hash of raw data, without any headers or descriptive parts

  • execution_overrides.artifacts[].type_data.preview (string) – Description or textual data

  • execution_overrides.artifacts[].uri (string) – Raw data location

  • execution_overrides.docker_cmd (string) – Command for running docker script for the execution of the task

  • execution_overrides.framework (string) – Framework related to the task. Case insensitive. Mandatory for Training tasks.

  • execution_overrides.model (string) – Execution input model ID Not applicable for Register (Import) tasks

  • execution_overrides.model_desc (object) – Json object representing the Model descriptors

  • execution_overrides.model_labels (object) – Json object representing the ids of the labels in the model. The keys are the layers’ names and the values are the IDs. Not applicable for Register (Import) tasks. Mandatory for Training tasks

  • execution_overrides.parameters (object) – Json object containing the Task parameters

  • execution_overrides.queue (string) – Queue ID where task was queued.

  • new_project_name (string) – 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.

  • new_task_comment (string) – The comment of the cloned task. If not provided then taken from the original task

  • new_task_configuration (object) – The configuration for the new task. If not provided then taken from the original task

  • new_task_container (object) – The docker container properties for the new task. If not provided then taken from the original task

  • new_task_hyperparams (object) – The hyper params for the new task. If not provided then taken from the original task

  • new_task_input_models[].model (string) – The model ID (required)

  • new_task_input_models[].name (string) – The task model name (required)

  • new_task_name (string) – The name of the cloned task. If not provided then taken from the original task

  • new_task_parent (string) – The parent of the cloned task. If not provided then taken from the original task

  • new_task_project (string) – The project of the cloned task. If not provided then taken from the original task

  • new_task_system_tags[] (string) –

  • new_task_tags[] (string) –

  • task (string) – ID of the task (required)

  • validate_references (boolean) – If set to ‘false’ then the task fields that are copied from the original task are not validated. The default is false.

Status Codes
Response JSON Object

  • id (string) – ID of the new task

  • new_project.id (string) – The ID of the target project

  • new_project.name (string) – The name of the target project

POST /tasks.add_or_update_model

Add or update task model

Request JSON Object

  • iteration (integer) – Iteration (used to update task statistics)

  • model (string) – The model ID (required)

  • name (string) – The task model name (required)

  • task (string) – ID of the task (required)

  • type (string) – (required)

Status Codes
Response JSON Object

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.delete_models

Delete models from task

Request JSON Object

  • models[].name (string) – The task model name (required)

  • models[].type (string) – (required)

  • task (string) – ID of the task (required)

Status Codes
Response JSON Object

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.create

Create a new task

Request JSON Object

  • comment (string) – Free text comment

  • configuration (object) – Task configuration params

  • container (object) – Docker container parameters

  • execution.artifacts[].content_size (integer) – Raw data length in bytes

  • execution.artifacts[].display_data[][] (string) –

  • execution.artifacts[].hash (string) – Hash of entire raw data

  • execution.artifacts[].key (string) – Entry key (required)

  • execution.artifacts[].mode (string) –

  • execution.artifacts[].timestamp (integer) – Epoch time when artifact was created

  • execution.artifacts[].type (string) – System defined type (required)

  • execution.artifacts[].type_data.content_type (string) – System defined raw data content type

  • execution.artifacts[].type_data.data_hash (string) – Hash of raw data, without any headers or descriptive parts

  • execution.artifacts[].type_data.preview (string) – Description or textual data

  • execution.artifacts[].uri (string) – Raw data location

  • execution.docker_cmd (string) – Command for running docker script for the execution of the task

  • execution.framework (string) – Framework related to the task. Case insensitive. Mandatory for Training tasks.

  • execution.model (string) – Execution input model ID Not applicable for Register (Import) tasks

  • execution.model_desc (object) – Json object representing the Model descriptors

  • execution.model_labels (object) – Json object representing the ids of the labels in the model. The keys are the layers’ names and the values are the IDs. Not applicable for Register (Import) tasks. Mandatory for Training tasks

  • execution.parameters (object) – Json object containing the Task parameters

  • execution.queue (string) – Queue ID where task was queued.

  • hyperparams (object) – Task hyper params per section

  • models.input[].model (string) – The model ID (required)

  • models.input[].name (string) – The task model name (required)

  • models.output[].model (string) – The model ID (required)

  • models.output[].name (string) – The task model name (required)

  • name (string) – Task name. Unique within the company. (required)

  • output_dest (string) – Output storage id Must be a reference to an existing storage.

  • parent (string) – Parent task id Must be a completed task.

  • project (string) – Project ID of the project to which this task is assigned Must exist[ab]

  • script.binary (string) – Binary to use when running the script

  • script.branch (string) – Repository branch id If not provided and tag not provided, default repository branch is used.

  • script.diff (string) – Uncommitted changes found in the repository when task was run

  • script.entry_point (string) – Path to execute within the repository

  • script.repository (string) – Name of the repository where the script is located

  • script.requirements (object) – A JSON object containing requirements strings by key

  • script.tag (string) – Repository tag

  • script.version_num (string) – Version (changeset) number. Optional (default is head version) Unused if tag is provided.

  • script.working_dir (string) – Path to the folder from which to run the script Default - root folder of repository

  • system_tags[] (string) –

  • tags[] (string) –

  • type (string) – (required)

Status Codes
Response JSON Object

  • id (string) – ID of the task

POST /tasks.validate

Validate task properties (before create)

Request JSON Object

  • comment (string) – Free text comment

  • configuration (object) – Task configuration params

  • container (object) – Docker container parameters

  • execution.artifacts[].content_size (integer) – Raw data length in bytes

  • execution.artifacts[].display_data[][] (string) –

  • execution.artifacts[].hash (string) – Hash of entire raw data

  • execution.artifacts[].key (string) – Entry key (required)

  • execution.artifacts[].mode (string) –

  • execution.artifacts[].timestamp (integer) – Epoch time when artifact was created

  • execution.artifacts[].type (string) – System defined type (required)

  • execution.artifacts[].type_data.content_type (string) – System defined raw data content type

  • execution.artifacts[].type_data.data_hash (string) – Hash of raw data, without any headers or descriptive parts

  • execution.artifacts[].type_data.preview (string) – Description or textual data

  • execution.artifacts[].uri (string) – Raw data location

  • execution.docker_cmd (string) – Command for running docker script for the execution of the task

  • execution.framework (string) – Framework related to the task. Case insensitive. Mandatory for Training tasks.

  • execution.model (string) – Execution input model ID Not applicable for Register (Import) tasks

  • execution.model_desc (object) – Json object representing the Model descriptors

  • execution.model_labels (object) – Json object representing the ids of the labels in the model. The keys are the layers’ names and the values are the IDs. Not applicable for Register (Import) tasks. Mandatory for Training tasks

  • execution.parameters (object) – Json object containing the Task parameters

  • execution.queue (string) – Queue ID where task was queued.

  • hyperparams (object) – Task hyper params per section

  • models.input[].model (string) – The model ID (required)

  • models.input[].name (string) – The task model name (required)

  • models.output[].model (string) – The model ID (required)

  • models.output[].name (string) – The task model name (required)

  • name (string) – Task name. Unique within the company. (required)

  • output_dest (string) – Output storage id Must be a reference to an existing storage.

  • parent (string) – Parent task id Must be a completed task.

  • project (string) – Project ID of the project to which this task is assigned Must exist[ab]

  • script.binary (string) – Binary to use when running the script

  • script.branch (string) – Repository branch id If not provided and tag not provided, default repository branch is used.

  • script.diff (string) – Uncommitted changes found in the repository when task was run

  • script.entry_point (string) – Path to execute within the repository

  • script.repository (string) – Name of the repository where the script is located

  • script.requirements (object) – A JSON object containing requirements strings by key

  • script.tag (string) – Repository tag

  • script.version_num (string) – Version (changeset) number. Optional (default is head version) Unused if tag is provided.

  • script.working_dir (string) – Path to the folder from which to run the script Default - root folder of repository

  • system_tags[] (string) –

  • tags[] (string) –

  • type (string) – (required)

Status Codes
POST /tasks.update

Update task’s runtime parameters

Request JSON Object

  • comment (string) – Free text comment

  • created (string) – Task creation time (UTC)

  • name (string) – Task name Unique within the company.

  • output__error (string) – Free text error

  • project (string) – Project ID of the project to which this task is assigned

  • system_tags[] (string) –

  • tags[] (string) –

  • task (string) – ID of the task (required)

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.update_batch

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

Request JSON Object

  • [] (object) –

Status Codes
Response JSON Object

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.edit

Edit task’s details.

Request JSON Object

  • comment (string) – Free text comment

  • configuration (object) – Task configuration params

  • container (object) – Docker container parameters

  • execution.artifacts[].content_size (integer) – Raw data length in bytes

  • execution.artifacts[].display_data[][] (string) –

  • execution.artifacts[].hash (string) – Hash of entire raw data

  • execution.artifacts[].key (string) – Entry key (required)

  • execution.artifacts[].mode (string) –

  • execution.artifacts[].timestamp (integer) – Epoch time when artifact was created

  • execution.artifacts[].type (string) – System defined type (required)

  • execution.artifacts[].type_data.content_type (string) – System defined raw data content type

  • execution.artifacts[].type_data.data_hash (string) – Hash of raw data, without any headers or descriptive parts

  • execution.artifacts[].type_data.preview (string) – Description or textual data

  • execution.artifacts[].uri (string) – Raw data location

  • execution.docker_cmd (string) – Command for running docker script for the execution of the task

  • execution.framework (string) – Framework related to the task. Case insensitive. Mandatory for Training tasks.

  • execution.model (string) – Execution input model ID Not applicable for Register (Import) tasks

  • execution.model_desc (object) – Json object representing the Model descriptors

  • execution.model_labels (object) – Json object representing the ids of the labels in the model. The keys are the layers’ names and the values are the IDs. Not applicable for Register (Import) tasks. Mandatory for Training tasks

  • execution.parameters (object) – Json object containing the Task parameters

  • execution.queue (string) – Queue ID where task was queued.

  • force (boolean) – If not true, call fails if the task status is not ‘created’

  • hyperparams (object) – Task hyper params per section

  • models.input[].model (string) – The model ID (required)

  • models.input[].name (string) – The task model name (required)

  • models.output[].model (string) – The model ID (required)

  • models.output[].name (string) – The task model name (required)

  • name (string) – Task name Unique within the company.

  • output_dest (string) – Output storage id Must be a reference to an existing storage.

  • parent (string) – Parent task id Must be a completed task.

  • project (string) – Project ID of the project to which this task is assigned Must exist[ab]

  • runtime (object) – Task runtime mapping

  • script.binary (string) – Binary to use when running the script

  • script.branch (string) – Repository branch id If not provided and tag not provided, default repository branch is used.

  • script.diff (string) – Uncommitted changes found in the repository when task was run

  • script.entry_point (string) – Path to execute within the repository

  • script.repository (string) – Name of the repository where the script is located

  • script.requirements (object) – A JSON object containing requirements strings by key

  • script.tag (string) – Repository tag

  • script.version_num (string) – Version (changeset) number. Optional (default is head version) Unused if tag is provided.

  • script.working_dir (string) – Path to the folder from which to run the script Default - root folder of repository

  • system_tags[] (string) –

  • tags[] (string) –

  • task (string) – ID of the task (required)

  • type (string) –

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.reset

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

Request JSON Object

  • clear_all (boolean) – Clear script and execution sections completely

  • force (boolean) – If not true, call fails if the task status is ‘completed’

  • return_file_urls (boolean) – If set to ‘true’ then return the urls of the files that were uploaded by this task. Default value is ‘false’

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • deleted_models (integer) – Number of output models deleted by the reset

  • dequeued (object) – Response from queues.remove_task

  • events (object) – Response from events.delete_for_task

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of tasks updated (0 or 1)

  • urls.artifact_urls[] (string) –

  • urls.event_urls[] (string) –

  • urls.model_urls[] (string) –

POST /tasks.reset_many

Reset tasks

Request JSON Object

  • clear_all (boolean) – Clear script and execution sections completely

  • delete_output_models (boolean) – If set to ‘true’ then delete output models of the tasks that are not referenced by other tasks. Default value is ‘true’

  • force (boolean) – If not true, call fails if the task status is ‘completed’

  • ids[] (string) –

  • return_file_urls (boolean) – If set to ‘true’ then return the urls of the files that were uploaded by the tasks. Default value is ‘false’

Status Codes
Response JSON Object

  • failed[].error.codes[] (integer) –

  • failed[].error.data (object) –

  • failed[].error.msg (string) –

  • failed[].id (string) – ID of the failed entity

  • succeeded[].deleted_models (integer) – Number of output models deleted by the reset

  • succeeded[].dequeued (boolean) – Indicates whether the task was dequeued

  • succeeded[].fields (object) – Updated fields names and values

  • succeeded[].id (string) – ID of the succeeded entity

  • succeeded[].updated (integer) – Number of tasks updated (0 or 1)

  • succeeded[].urls.artifact_urls[] (string) –

  • succeeded[].urls.event_urls[] (string) –

  • succeeded[].urls.model_urls[] (string) –

POST /tasks.delete_many

Delete tasks

Request JSON Object

  • delete_output_models (boolean) – If set to ‘true’ then delete output models of the tasks that are not referenced by other tasks. Default value is ‘true’

  • force (boolean) – If not true, call fails if the task status is ‘in_progress’

  • ids[] (string) –

  • move_to_trash (boolean) – 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!

  • return_file_urls (boolean) – If set to ‘true’ then return the urls of the files that were uploaded by the tasks. Default value is ‘false’

Status Codes
Response JSON Object

  • failed[].error.codes[] (integer) –

  • failed[].error.data (object) –

  • failed[].error.msg (string) –

  • failed[].id (string) – ID of the failed entity

  • succeeded[].deleted (boolean) – Indicates whether the task was deleted

  • succeeded[].deleted_models (integer) – Number of deleted output models

  • succeeded[].id (string) – ID of the succeeded entity

  • succeeded[].updated_children (integer) – Number of child tasks whose parent property was updated

  • succeeded[].updated_models (integer) – Number of models whose task property was updated

  • succeeded[].urls.artifact_urls[] (string) –

  • succeeded[].urls.event_urls[] (string) –

  • succeeded[].urls.model_urls[] (string) –

POST /tasks.delete

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.

Request JSON Object

  • force (boolean) – If not true, call fails if the task status is ‘in_progress’

  • move_to_trash (boolean) – 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!

  • return_file_urls (boolean) – If set to ‘true’ then return the urls of the files that were uploaded by this task. Default value is ‘false’

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • deleted (boolean) – Indicates whether the task was deleted

  • events (object) – Response from events.delete_for_task

  • updated_children (integer) – Number of child tasks whose parent property was updated

  • updated_models (integer) – Number of models whose task property was updated

  • urls.artifact_urls[] (string) –

  • urls.event_urls[] (string) –

  • urls.model_urls[] (string) –

POST /tasks.archive

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

Request JSON Object

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

  • tasks[] (string) –

Status Codes
Response JSON Object

  • archived (integer) – Indicates number of archived tasks

POST /tasks.archive_many

Archive tasks

Request JSON Object

  • ids[] (string) –

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

Status Codes
Response JSON Object

  • failed[].error.codes[] (integer) –

  • failed[].error.data (object) –

  • failed[].error.msg (string) –

  • failed[].id (string) – ID of the failed entity

  • succeeded[].id (string) – ID of the succeeded entity

POST /tasks.unarchive_many

Unarchive tasks

Request JSON Object

  • ids[] (string) –

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

Status Codes
Response JSON Object

  • failed[].error.codes[] (integer) –

  • failed[].error.data (object) –

  • failed[].error.msg (string) –

  • failed[].id (string) – ID of the failed entity

  • succeeded[].id (string) – ID of the succeeded entity

  • succeeded[].unarchived (boolean) – Indicates whether the task was unarchived

POST /tasks.started

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

Request JSON Object

  • force (boolean) – If not true, call fails if the task status is not ‘not_started’

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • started (integer) – Number of tasks started (0 or 1)

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.stop

Request to stop a running task

Request JSON Object

  • force (boolean) – If not true, call fails if the task status is not ‘in_progress’

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.stop_many

Request to stop running tasks

Request JSON Object

  • force (boolean) – If not true, call fails if the task status is not ‘in_progress’

  • ids[] (string) –

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

Status Codes
Response JSON Object

  • failed[].error.codes[] (integer) –

  • failed[].error.data (object) –

  • failed[].error.msg (string) –

  • failed[].id (string) – ID of the failed entity

  • succeeded[].fields (object) – Updated fields names and values

  • succeeded[].id (string) – ID of the succeeded entity

  • succeeded[].updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.stopped

Signal a task has stopped

Request JSON Object

  • force (boolean) – If not true, call fails if the task status is not ‘stopped’

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.failed

Indicates that task has failed

Request JSON Object

  • force (boolean) – Allows forcing state change even if transition is not supported

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.close

Indicates that task is closed

Request JSON Object

  • force (boolean) – Allows forcing state change even if transition is not supported

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.publish
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.

Request JSON Object

  • force (boolean) – If not true, call fails if the task status is not ‘stopped’

  • publish_model (boolean) – Indicates that the task output model (if exists) should be published. Optional, the default value is True.

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.publish_many

Publish tasks

Request JSON Object

  • force (boolean) – If not true, call fails if the task status is not ‘stopped’

  • ids[] (string) –

  • publish_model (boolean) – Indicates that the task output model (if exists) should be published. Optional, the default value is True.

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

Status Codes
Response JSON Object

  • failed[].error.codes[] (integer) –

  • failed[].error.data (object) –

  • failed[].error.msg (string) –

  • failed[].id (string) – ID of the failed entity

  • succeeded[].fields (object) – Updated fields names and values

  • succeeded[].id (string) – ID of the succeeded entity

  • succeeded[].updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.enqueue

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

Request JSON Object

  • queue (string) – Queue id. If not provided, task is added to the default queue.

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • queued (integer) – Number of tasks queued (0 or 1)

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.enqueue_many

Enqueue tasks

Request JSON Object

  • ids[] (string) –

  • queue (string) – Queue id. If not provided, tasks are added to the default queue.

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

  • validate_tasks (boolean) – If set then tasks are validated before enqueue

Status Codes
Response JSON Object

  • failed[].error.codes[] (integer) –

  • failed[].error.data (object) –

  • failed[].error.msg (string) –

  • failed[].id (string) – ID of the failed entity

  • succeeded[].fields (object) – Updated fields names and values

  • succeeded[].id (string) – ID of the succeeded entity

  • succeeded[].queued (boolean) – Indicates whether the task was queued

  • succeeded[].updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.dequeue

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

Request JSON Object

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • dequeued (integer) – Number of tasks dequeued (0 or 1)

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.dequeue_many

Dequeue tasks

Request JSON Object

  • ids[] (string) –

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

Status Codes
Response JSON Object

  • failed[].error.codes[] (integer) –

  • failed[].error.data (object) –

  • failed[].error.msg (string) –

  • failed[].id (string) – ID of the failed entity

  • succeeded[].dequeued (boolean) – Indicates whether the task was dequeued

  • succeeded[].fields (object) – Updated fields names and values

  • succeeded[].id (string) – ID of the succeeded entity

  • succeeded[].updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.set_requirements

Set the script requirements for a task

Request JSON Object

  • requirements (object) – A JSON object containing requirements strings by key (required)

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.completed

Signal a task has completed

Request JSON Object

  • force (boolean) – If not true, call fails if the task status is not in_progress/stopped

  • status_message (string) – Extra information regarding status change

  • status_reason (string) – Reason for status change

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of tasks updated (0 or 1)

POST /tasks.ping

Refresh the task’s last update time

Request JSON Object

  • task (string) – Task ID (required)

Status Codes
POST /tasks.add_or_update_artifacts

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

Request JSON Object

  • artifacts[].content_size (integer) – Raw data length in bytes

  • artifacts[].display_data[][] (string) –

  • artifacts[].hash (string) – Hash of entire raw data

  • artifacts[].key (string) – Entry key (required)

  • artifacts[].mode (string) –

  • artifacts[].timestamp (integer) – Epoch time when artifact was created

  • artifacts[].type (string) – System defined type (required)

  • artifacts[].type_data.content_type (string) – System defined raw data content type

  • artifacts[].type_data.data_hash (string) – Hash of raw data, without any headers or descriptive parts

  • artifacts[].type_data.preview (string) – Description or textual data

  • artifacts[].uri (string) – Raw data location

  • force (boolean) – If set to True then both new and running task artifacts can be edited. Otherwise only the new task ones. Default is False

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • updated (integer) – Indicates if the task was updated successfully

POST /tasks.delete_artifacts

Delete existing artifacts (search by key/mode)

Request JSON Object

  • artifacts[].key (string) – Entry key (required)

  • artifacts[].mode (string) –

  • force (boolean) – If set to True then both new and running task artifacts can be deleted. Otherwise only the new task ones. Default is False

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • deleted (integer) – Indicates if the task was updated successfully

POST /tasks.make_public

Convert company tasks to public

Request JSON Object

  • ids[] (string) –

Status Codes
Response JSON Object

  • updated (integer) – Number of tasks updated

POST /tasks.make_private

Convert public tasks to private

Request JSON Object

  • ids[] (string) –

Status Codes
Response JSON Object

  • updated (integer) – Number of tasks updated

POST /tasks.get_hyper_params

Get the list of task hyper parameters

Request JSON Object

  • tasks[] (string) –

Status Codes
Response JSON Object

  • params[].hyperparams[].description (string) – The parameter description. Optional

  • params[].hyperparams[].name (string) – Name of the parameter. The combination of section and name should be unique

  • params[].hyperparams[].section (string) – Section that the parameter belongs to

  • params[].hyperparams[].type (string) – Type of the parameter. Optional

  • params[].hyperparams[].value (string) – Value of the parameter

  • params[].task (string) – Task ID

POST /tasks.edit_hyper_params

Add or update task hyper parameters

Request JSON Object

  • force (boolean) – If set to True then both new and running task hyper params can be edited. Otherwise only the new task ones. Default is False

  • hyperparams[].description (string) – The parameter description. Optional

  • hyperparams[].name (string) – Name of the parameter. The combination of section and name should be unique

  • hyperparams[].section (string) – Section that the parameter belongs to

  • hyperparams[].type (string) – Type of the parameter. Optional

  • hyperparams[].value (string) – Value of the parameter

  • replace_hyperparams (string) –

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • updated (integer) – Indicates if the task was updated successfully

POST /tasks.delete_hyper_params

Delete task hyper parameters

Request JSON Object

  • force (boolean) – If set to True then both new and running task hyper params can be deleted. Otherwise only the new task ones. Default is False

  • hyperparams[].name (string) – Name of the parameter. If the name is ommitted then the corresponding operation is performed on the whole section

  • hyperparams[].section (string) – Section that the parameter belongs to

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • deleted (integer) – Indicates if the task was updated successfully

POST /tasks.get_configurations

Get the list of task configurations

Request JSON Object

  • names[] (string) –

  • tasks[] (string) –

Status Codes
Response JSON Object

  • configurations[].configuration[].description (string) – The parameter description. Optional

  • configurations[].configuration[].name (string) – Name of the parameter. Should be unique

  • configurations[].configuration[].type (string) – Type of the parameter. Optional

  • configurations[].configuration[].value (string) – Value of the parameter

  • configurations[].task (string) – Task ID

POST /tasks.get_configuration_names

Get the list of task configuration items names

Request JSON Object

  • skip_empty (boolean) – If set to ‘true’ then the names for configurations with missing values are not returned

  • tasks[] (string) –

Status Codes
Response JSON Object

  • configurations.names[] (string) –

  • configurations.task (string) – Task ID

POST /tasks.edit_configuration

Add or update task configuration

Request JSON Object

  • configuration[].description (string) – The parameter description. Optional

  • configuration[].name (string) – Name of the parameter. Should be unique

  • configuration[].type (string) – Type of the parameter. Optional

  • configuration[].value (string) – Value of the parameter

  • force (boolean) – If set to True then both new and running task configuration can be edited. Otherwise only the new task ones. Default is False

  • replace_configuration (boolean) – 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

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • updated (integer) – Indicates if the task was updated successfully

POST /tasks.delete_configuration

Delete task configuration items

Request JSON Object

  • configuration[] (string) –

  • force (boolean) – If set to True then both new and running task configuration can be deleted. Otherwise only the new task ones. Default is False

  • task (string) – Task ID (required)

Status Codes
Response JSON Object

  • deleted (integer) – Indicates if the task was updated successfully

POST /tasks.move

Move tasks to a project

Request JSON Object

  • ids[] (string) –

  • project (string) – Target project ID. If not provided, project_name must be provided.

  • project_name (string) – 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.

Status Codes
POST /users.get_by_id

Internal. Gets user information

Request JSON Object

  • user (string) – User ID (required)

Status Codes
Response JSON Object

  • user.avatar (string) – Avatar URL

  • user.company (string) – Company ID

  • user.created (string) – User creation date

  • user.email (string) – User email

  • user.family_name (string) – Family name

  • user.given_name (string) – Given name

  • user.id (string) – User ID

  • user.name (string) – Full name

  • user.providers (object) – Providers uses has logged-in with

  • user.role (string) – User’s role (admin only)

POST /users.get_current_user

Internal. Gets current user information, based on the authenticated user making the call.

Status Codes
Response JSON Object

  • user.avatar (string) –

  • user.company.id (string) –

  • user.company.name (string) –

  • user.family_name (string) –

  • user.given_name (string) –

  • user.id (string) –

  • user.name (string) –

  • user.preferences (object) – User preferences

  • user.role (string) –

POST /users.get_all_ex

Internal. Get all user objects

Request JSON Object

  • active_in_projects[] (string) –

  • id[] (string) –

  • name (string) – Get only users whose name matches this pattern (python regular expression syntax)

  • only_fields[] (string) –

  • order_by[] (string) –

  • page (integer) – Page number, returns a specific page out of the resulting list of users

  • page_size (integer) – Page size, specifies the number of results returned in each page (last page may contain fewer results)

Status Codes
Response JSON Object

  • users[].avatar (string) – Avatar URL

  • users[].company (string) – Company ID

  • users[].created (string) – User creation date

  • users[].email (string) – User email

  • users[].family_name (string) – Family name

  • users[].given_name (string) – Given name

  • users[].id (string) – User ID

  • users[].name (string) – Full name

  • users[].providers (object) – Providers uses has logged-in with

  • users[].role (string) – User’s role (admin only)

POST /users.get_all

Internal. Get all user objects

Request JSON Object

  • id[] (string) –

  • name (string) – Get only users whose name matches this pattern (python regular expression syntax)

  • only_fields[] (string) –

  • order_by[] (string) –

  • page (integer) – Page number, returns a specific page out of the resulting list of users

  • page_size (integer) – Page size, specifies the number of results returned in each page (last page may contain fewer results)

Status Codes
Response JSON Object

  • users[].avatar (string) – Avatar URL

  • users[].company (string) – Company ID

  • users[].created (string) – User creation date

  • users[].email (string) – User email

  • users[].family_name (string) – Family name

  • users[].given_name (string) – Given name

  • users[].id (string) – User ID

  • users[].name (string) – Full name

  • users[].providers (object) – Providers uses has logged-in with

  • users[].role (string) – User’s role (admin only)

POST /users.delete

Internal. Delete a user

Request JSON Object

  • user (string) – ID of user to delete (required)

Status Codes
POST /users.create

Internal. Create a new user object. Reserved for internal use.

Request JSON Object

  • avatar (string) – Avatar URL

  • company (string) – Company ID (required)

  • family_name (string) – Family name

  • given_name (string) – Given name

  • id (string) – User ID (required)

  • name (string) – Full name (required)

Status Codes
POST /users.update

Internal. Update a user object

Request JSON Object

  • avatar (string) – Avatar URL

  • family_name (string) – Family name

  • given_name (string) – Given name

  • name (string) – Full name

  • user (string) – User ID (required)

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of updated user objects (0 or 1)

POST /users.get_preferences

Internal. Get user preferences

Status Codes
Response JSON Object

  • preferences (object) –

POST /users.set_preferences

Internal. Set user preferences

Request JSON Object

  • preferences (object) – Updates to user preferences. A mapping from keys in dot notation to values. For example, {“a.b”: 0} will set the key “b” in object “a” to 0. (required)

Status Codes
Response JSON Object

  • fields (object) – Updated fields names and values

  • updated (integer) – Number of updated user objects (0 or 1)

POST /workers.get_all

Returns information on all registered workers.

Request JSON Object

  • last_seen (integer) – Filter out workers not active for more than last_seen seconds. A value or 0 or ‘none’ will disable the filter.

Status Codes
Response JSON Object

  • workers[].company.id (string) – ID

  • workers[].company.name (string) – Name

  • workers[].id (string) – Worker ID

  • workers[].ip (string) – IP of the worker

  • workers[].last_activity_time (string) – Last activity time (even if an error occurred)

  • workers[].last_report_time (string) – Last successful report time

  • workers[].project.id (string) – ID

  • workers[].project.name (string) – Name

  • workers[].queue.id (string) – ID

  • workers[].queue.name (string) – Name

  • workers[].queue.next_task.id (string) – ID

  • workers[].queue.next_task.name (string) – Name

  • workers[].queue.num_tasks (integer) – Number of task entries in the queue

  • workers[].queues[].id (string) – ID

  • workers[].queues[].name (string) – Name

  • workers[].queues[].next_task.id (string) – ID

  • workers[].queues[].next_task.name (string) – Name

  • workers[].queues[].num_tasks (integer) – Number of task entries in the queue

  • workers[].register_time (string) – Registration time

  • workers[].tags[] (string) –

  • workers[].task.id (string) – ID

  • workers[].task.last_iteration (integer) – Last task iteration

  • workers[].task.name (string) – Name

  • workers[].task.running_time (integer) – Task running time

  • workers[].user.id (string) – ID

  • workers[].user.name (string) – Name

POST /workers.register

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

Request JSON Object

  • queues[] (string) –

  • tags[] (string) –

  • timeout (integer) – 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.

  • worker (string) – Worker id. Must be unique in company. (required)

Status Codes
POST /workers.unregister

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

Request JSON Object

  • worker (string) – Worker id. Must be unique in company. (required)

Status Codes
POST /workers.status_report

Called periodically by the worker daemon to report machine status

Request JSON Object

  • machine_stats.cpu_temperature[] (number) –

  • machine_stats.cpu_usage[] (number) –

  • machine_stats.disk_free_home (integer) – Mbytes free space of /home drive

  • machine_stats.disk_free_temp (integer) – Mbytes free space of /tmp drive

  • machine_stats.disk_read (integer) – Mbytes read per second

  • machine_stats.disk_write (integer) – Mbytes write per second

  • machine_stats.gpu_memory_free[] (integer) –

  • machine_stats.gpu_memory_used[] (integer) –

  • machine_stats.gpu_temperature[] (number) –

  • machine_stats.gpu_usage[] (number) –

  • machine_stats.memory_free (integer) – Free memory MBs

  • machine_stats.memory_used (integer) – Used memory MBs

  • machine_stats.network_rx (integer) – Mbytes per second

  • machine_stats.network_tx (integer) – Mbytes per second

  • queue (string) – ID of the queue from which task was received. If no queue is sent, the worker’s queue field will be cleared.

  • queues[] (string) –

  • tags[] (string) –

  • task (string) – ID of a task currently being run by the worker. If no task is sent, the worker’s task field will be cleared.

  • timestamp (integer) – UNIX time in seconds since epoch. (required)

  • worker (string) – Worker id. (required)

Status Codes
POST /workers.get_metric_keys

Returns worker statistics metric keys grouped by categories.

Request JSON Object

  • worker_ids[] (string) –

Status Codes
Response JSON Object

  • categories[].metric_keys[] (string) –

  • categories[].name (string) – Name of the metrics category.

POST /workers.get_stats

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

Request JSON Object

  • from_date (number) – Starting time (in seconds from epoch) for collecting statistics (required)

  • interval (integer) – Time interval in seconds for a single statistics point. The minimal value is 1 (required)

  • items[].category (string) – Metric aggregation type

  • items[].key (string) – Name of a metric

  • split_by_variant (boolean) – If true then break statistics by hardware sub types

  • to_date (number) – Ending time (in seconds from epoch) for collecting statistics (required)

  • worker_ids[] (string) –

Status Codes
Response JSON Object

  • workers[].metrics[].dates[] (integer) –

  • workers[].metrics[].metric (string) – Name of the metric (cpu_usage, memory_used etc.)

  • workers[].metrics[].stats[].aggregation (string) – Metric aggregation type

  • workers[].metrics[].stats[].values[] (number) –

  • workers[].metrics[].variant (string) – Name of the metric component. Set only if ‘split_by_variant’ was set in the request

  • workers[].worker (string) – ID of the worker

POST /workers.get_activity_report

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

Request JSON Object

  • from_date (number) – Starting time (in seconds from epoch) for collecting statistics (required)

  • interval (integer) – Time interval in seconds for a single statistics point. The minimal value is 1 (required)

  • to_date (number) – Ending time (in seconds from epoch) for collecting statistics (required)

Status Codes
Response JSON Object

  • active.counts[] (integer) –

  • active.dates[] (integer) –

  • total.counts[] (integer) –

  • total.dates[] (integer) –