For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/model-lab-api/list-model-lab-runs.md. A documentation index is available at /llms.txt.
homeHomedocsDocsapiAPI
Language
Datadog site

List Model Lab runs

WARNINGNote: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.
GEThttps://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/runshttps://api.datadoghq.eu/api/v2/model-lab-api/runshttps://api.ap1.datadoghq.com/api/v2/model-lab-api/runshttps://api.ap2.datadoghq.com/api/v2/model-lab-api/runshttps://api.uk1.datadoghq.com/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/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).

Default: -updated_at
page[size]
integer

Number of items per page. Maximum is 100.

Default: 25
page[number]
integer

Page number (1-indexed).

Default: 1

Response

OK

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

Field
Type
Description
data [required]
[object]

The list of runs.

links
object

Pagination links for navigating list responses.

meta [required]
object

Pagination metadata for a list response.

Code Example

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/model-lab-api/runs" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/model-lab-api/runs" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/model-lab-api/runs" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/model-lab-api/runs" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/model-lab-api/runs" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/model-lab-api/runs" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/model-lab-api/runs" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/model-lab-api/runs" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/model-lab-api/runs" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"