--- title: List Model Lab runs description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Model Lab API --- # List Model Lab runs{% #list-model-lab-runs %} Copy pageCopied {% tab title="v2" %} **Note**: This endpoint is in preview and is subject to change. If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/model-lab-api/runs | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/model-lab-api/runs | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/model-lab-api/runs | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/model-lab-api/runs | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/model-lab-api/runs | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/model-lab-api/runs | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/model-lab-api/runs | | us5.datadoghq.com | GET https://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 {% tab title="200" %} OK {% tab title="Model" %} Response containing a list of Model Lab runs with pagination metadata. | Parent field | Field | Type | Description | | ---------------- | ------------------------------------------ | --------- | ----------------------------------------------------------------------------------------------------------------- | | | data [*required*] | [object] | The list of runs. | | data | attributes [*required*] | object | Attributes of a Model Lab run. | | attributes | completed_at | date-time | The date and time the run completed. | | attributes | created_at [*required*] | date-time | The date and time the run was created. | | attributes | deleted_at | date-time | The date and time the run was soft-deleted. | | attributes | descendant_match [*required*] | boolean | Whether a descendant run matched the applied filters. | | attributes | description [*required*] | string | A description of the run. | | attributes | duration | double | The duration of the run in seconds. | | attributes | external_url | string | An optional external URL associated with the run. | | attributes | has_children [*required*] | boolean | Whether the run has child runs. | | attributes | is_pinned [*required*] | boolean | Whether the run is pinned by the current user. | | attributes | metric_summaries [*required*] | [object] | Summary statistics for metrics recorded during the run. | | metric_summaries | count [*required*] | int64 | The total number of recorded values. | | metric_summaries | first_step | int64 | The first step at which the metric was recorded. | | metric_summaries | key [*required*] | string | The metric name. | | metric_summaries | last_step | int64 | The last step at which the metric was recorded. | | metric_summaries | latest | double | The most recently recorded value. | | metric_summaries | max | double | The maximum recorded value. | | metric_summaries | mean | double | The mean of recorded values. | | metric_summaries | min | double | The minimum recorded value. | | metric_summaries | stddev | double | The standard deviation of recorded values. | | attributes | mlflow_artifact_location [*required*] | string | The MLflow artifact storage location for this run. | | attributes | name [*required*] | string | The name of the run. | | attributes | owner_id | string | The UUID of the run owner. | | attributes | params [*required*] | [object] | The list of parameters used for the run. | | params | key [*required*] | string | The parameter key. | | params | value [*required*] | string | The parameter value. | | attributes | project_id [*required*] | int64 | The ID of the project this run belongs to. | | attributes | started_at [*required*] | date-time | The date and time the run started. | | attributes | status [*required*] | enum | The status of a Model Lab run. Allowed enum values: `pending,running,completed,failed,killed,unresponsive,paused` | | attributes | tags [*required*] | [object] | The list of tags associated with the run. | | tags | key [*required*] | string | The tag key. | | tags | value [*required*] | string | The tag value. | | attributes | updated_at [*required*] | date-time | The date and time the run was last updated. | | data | id [*required*] | string | The unique identifier of the run. | | data | 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. | | links | first | string | Link to the first page. | | links | last | string | Link to the last page. | | links | next | string | Link to the next page. | | links | prev | string | Link to the previous page. | | links | self | string | Link to the current page. | | | meta [*required*] | object | Pagination metadata for a list response. | | meta | page [*required*] | object | Pagination details for a list response. | | page | first_number | int64 | The first page number. | | page | last_number | int64 | The last page number. | | page | next_number | int64 | The next page number. | | page | number [*required*] | int64 | The current page number. | | page | prev_number | int64 | The previous page number. | | page | size [*required*] | int64 | The number of items per page. | | page | total [*required*] | int64 | The total number of items. | | page | type | string | The pagination type. | {% /tab %} {% tab title="Example" %} ```json { "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" } } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="500" %} Internal Server Error {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl command curl -X GET "https://api.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}" {% /tab %}