Skip to main content

projects

POST /projects.create#

Description#

Create a new project

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
default_output_destination
optional
The default output destination URL for new tasks under this projectstring
description
optional
Project description.string
name
required
Project name Unique within the company.string
system_tags
optional
System tags. This field is reserved for system use, please don't use it.< string > array
tags
optional
User-defined tags< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
id
optional
Project idstring

POST /projects.delete#

Description#

Deletes a project

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

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

Responses#

HTTP CodeSchema
200Response 200

Response 200

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

POST /projects.get_all#

Description#

Get all the company's projects and all public projects

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

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

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
projects
optional
Projects list< projects.projects_get_all_response_single > array

POST /projects.get_all_ex#

Description#

Get all the company's projects and all public projects

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

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

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
own_models
optional
The amount of models under this project (without children projects). Returned
if 'check_own_contents' flag is set in the request
integer
own_tasks
optional
The amount of tasks under this project (without children projects). Returned if
'check_own_contents' flag is set in the request
integer
projects
optional
Projects list< projects.projects_get_all_response_single > array

POST /projects.get_by_id#

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
project
required
Project idstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
project
optional
Project infoprojects.project

POST /projects.get_hyper_parameters#

Description#

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

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

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

Responses#

HTTP CodeSchema
200Response 200

Response 200

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

POST /projects.get_hyperparam_values#

Description#

Get a list of distinct values for the chosen hyperparameter

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

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

Responses#

HTTP CodeSchema
200Response 200

Response 200

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

POST /projects.get_model_tags#

Description#

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

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

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

filter

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

Responses#

HTTP CodeSchema
200Response 200

Response 200

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

POST /projects.get_task_parents#

Description#

Get unique parent tasks for the tasks in the specified projects

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

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

Responses#

HTTP CodeSchema
200Response 200

Response 200

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

parents

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

POST /projects.get_task_tags#

Description#

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

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

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

filter

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

Responses#

HTTP CodeSchema
200Response 200

Response 200

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

POST /projects.get_unique_metric_variants#

Description#

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

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

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

Responses#

HTTP CodeSchema
200Response 200

Response 200

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

POST /projects.make_private#

Description#

Convert public projects to private

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

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

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of projects updatedinteger

POST /projects.make_public#

Description#

Convert company projects to public

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

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

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
updated
optional
Number of projects updatedinteger

POST /projects.merge#

Description#

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

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

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

Responses#

HTTP CodeSchema
200Response 200

Response 200

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

POST /projects.move#

Description#

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

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

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

Responses#

HTTP CodeSchema
200Response 200

Response 200

NameDescriptionSchema
moved
optional
The number of projects movedinteger

POST /projects.update#

Description#

Update project information

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
default_output_destination
optional
The default output destination URL for new tasks under this projectstring
description
optional
Project descriptionstring
name
optional
Project name. Unique within the company.string
project
required
Project idstring
system_tags
optional
System tags. This field is reserved for system use, please don't use it.< string > array
tags
optional
User-defined tags< string > array

Responses#

HTTP CodeSchema
200Response 200

Response 200

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

POST /projects.validate_delete#

Description#

Validates that the project existis and can be deleted

Parameters#

TypeNameDescriptionSchema
Bodyrequest
required
request bodyrequest

request

NameDescriptionSchema
project
required
Project IDstring

Responses#

HTTP CodeSchema
200Response 200

Response 200

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