Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED US2-FED

List Model Lab runs

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/runshttps://api.ap2.datadoghq.com/api/v2/model-lab-api/runshttps://api.datadoghq.eu/api/v2/model-lab-api/runshttps://api.ddog-gov.com/api/v2/model-lab-api/runshttps://api.us2.ddog-gov.com/api/v2/model-lab-api/runshttps://api.datadoghq.com/api/v2/model-lab-api/runshttps://api.us3.datadoghq.com/api/v2/model-lab-api/runshttps://api.us5.datadoghq.com/api/v2/model-lab-api/runs

Overview

List all Model Lab runs for the current organization.

Arguments

Query Strings

Name

Type

Description

filter[id]

string

Filter by run ID(s). Comma-separated list for multiple IDs.

filter

string

Text search filter for run name or description.

filter[owner_id]

string

Filter by owner UUID.

filter[status]

enum

Filter by run status. Valid values: pending, running, completed, failed, killed, unresponsive, paused.
Allowed enum values: pending, running, completed, failed, killed, unresponsive, paused

filter[project_id]

integer

Filter by project ID.

filter[tags]

string

Filter by tags. Format: key:value,key2:value2.

filter[params]

string

Filter by params. Format: key:value,key2:>0.5,key3:true.

filter[parent_run_id]

string

Filter by parent run ID. Use ’null’ to return only root runs (runs with no parent).

pinned_first

boolean

Sort pinned runs before non-pinned runs. Pinned runs are ordered by pin time descending.

include_pinned

boolean

Include all runs pinned by the current user, regardless of other filters.

include_descendant_matches

boolean

When true, also return runs whose descendants match the active filters. The descendant_match field in each result indicates whether the run was included via a descendant match.

sort

string

Sort field. Valid values: name, created_at, updated_at, duration. Prefix with ‘-’ for descending order (e.g., -updated_at).

page[size]

integer

Number of items per page. Maximum is 100.

page[number]

integer

Page number (1-indexed).

Response

OK

Response containing a list of Model Lab runs with pagination metadata.

Expand All

Field

Type

Description

data [required]

[object]

The list of runs.

attributes [required]

object

Attributes of a Model Lab run.

completed_at

date-time

The date and time the run completed.

created_at [required]

date-time

The date and time the run was created.

deleted_at

date-time

The date and time the run was soft-deleted.

descendant_match [required]

boolean

Whether a descendant run matched the applied filters.

description [required]

string

A description of the run.

duration

double

The duration of the run in seconds.

external_url

string

An optional external URL associated with the run.

has_children [required]

boolean

Whether the run has child runs.

is_pinned [required]

boolean

Whether the run is pinned by the current user.

metric_summaries [required]

[object]

Summary statistics for metrics recorded during the run.

count [required]

int64

The total number of recorded values.

first_step

int64

The first step at which the metric was recorded.

key [required]

string

The metric name.

last_step

int64

The last step at which the metric was recorded.

latest

double

The most recently recorded value.

max

double

The maximum recorded value.

mean

double

The mean of recorded values.

min

double

The minimum recorded value.

stddev

double

The standard deviation of recorded values.

mlflow_artifact_location [required]

string

The MLflow artifact storage location for this run.

name [required]

string

The name of the run.

owner_id

string

The UUID of the run owner.

params [required]

[object]

The list of parameters used for the run.

key [required]

string

The parameter key.

value [required]

string

The parameter value.

project_id [required]

int64

The ID of the project this run belongs to.

started_at [required]

date-time

The date and time the run started.

status [required]

enum

The status of a Model Lab run. Allowed enum values: pending,running,completed,failed,killed,unresponsive,paused

tags [required]

[object]

The list of tags associated with the run.

key [required]

string

The tag key.

value [required]

string

The tag value.

updated_at [required]

date-time

The date and time the run was last updated.

id [required]

string

The unique identifier of the run.

type [required]

enum

The JSON:API type for a Model Lab run resource. Allowed enum values: runs

links

object

Pagination links for navigating list responses.

first

string

Link to the first page.

last

string

Link to the last page.

next

string

Link to the next page.

prev

string

Link to the previous page.

self

string

Link to the current page.

meta [required]

object

Pagination metadata for a list response.

page [required]

object

Pagination details for a list response.

first_number

int64

The first page number.

last_number

int64

The last page number.

next_number

int64

The next page number.

number [required]

int64

The current page number.

prev_number

int64

The previous page number.

size [required]

int64

The number of items per page.

total [required]

int64

The total number of items.

type

string

The pagination type.

{
  "data": [
    {
      "attributes": {
        "completed_at": "2019-09-19T10:00:00.000Z",
        "created_at": "2024-01-20T10:00:00Z",
        "deleted_at": "2019-09-19T10:00:00.000Z",
        "descendant_match": false,
        "description": "Fine-tuning run with custom hyperparameters.",
        "duration": "number",
        "external_url": "string",
        "has_children": false,
        "is_pinned": false,
        "metric_summaries": [
          {
            "count": 100,
            "first_step": "integer",
            "key": "accuracy",
            "last_step": "integer",
            "latest": "number",
            "max": "number",
            "mean": "number",
            "min": "number",
            "stddev": "number"
          }
        ],
        "mlflow_artifact_location": "s3://bucket/active-run",
        "name": "training-run-1",
        "owner_id": "string",
        "params": [
          {
            "key": "algorithm",
            "value": "gpt4"
          }
        ],
        "project_id": 101,
        "started_at": "2024-01-20T10:00:00Z",
        "status": "running",
        "tags": [
          {
            "key": "model",
            "value": "opus"
          }
        ],
        "updated_at": "2024-01-20T11:00:00Z"
      },
      "id": "42",
      "type": "runs"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string",
    "self": "string"
  },
  "meta": {
    "page": {
      "first_number": "integer",
      "last_number": "integer",
      "next_number": "integer",
      "number": 1,
      "prev_number": "integer",
      "size": 25,
      "total": 100,
      "type": "string"
    }
  }
}

Bad Request

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Internal Server Error

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Code Example

                  # Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/model-lab-api/runs" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"