Searches runs/candidates within a project

POST

/api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/search

• GitLab REST API

Https://www.mlflow.org/docs/2.19.0/rest-api.html#search-runsexperiment_ids supports only a single experiment ID.Introduced in GitLab 16.4

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

One of:

string

string

integer

integer

The ID or URL-encoded path of the project

Example

1

Request Body ^required

Media type application/json

object

experiment_ids

required

IDs of the experiments to get searches from, relative to the project

array

nullable

max_results

Maximum number of runs/candidates to fetch in a page. Default is 200, maximum in 1000

integer

default: 200 nullable

order_by

Order criteria. Can be by a column of the run/candidate (created_at, name) or by a metric ifprefixed by metrics. Valid examples: created_at, created_at DESC, metrics.my_metric DESCSorting by candidate parameter or metadata is not supported.

string

default: created_at DESC nullable

page_token

Token for pagination

string

nullable

Responses

201

Created

Media type application/json

object

info

object

run_id

string

run_uuid

string

experiment_id

string

start_time

Unix timestamp in milliseconds

integer

end_time

Unix timestamp in milliseconds

integer

run_name

string

status

string

artifact_uri

string

lifecycle_stage

string

user_id

string

data

object

Example

{
  "info": {
    "status": "FINISHED",
    "lifecycle_stage": "active"
  }
}

400

Bad Request

404

Not Found