Sign in

v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Model Lab API

List Model Lab runs

List all Model Lab runs for the current organization.

get/api/v2/model-lab-api/runs

Query parameters

filter[id]string

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

filterstring

Text search filter for run name or description.

filter[owner_id]string

Filter by owner UUID.

filter[status]'pending' | 'running' | 'completed' | 'failed' | 'killed' | 'unresponsive' | 'paused'

The status of a Model Lab run.

Example:running

Filter by run status. Valid 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_firstboolean

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

include_pinnedboolean

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

include_descendant_matchesboolean

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.

sortstring

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

Example response

{
  "data": [
    {
      "attributes": {
        "created_at": "2024-01-20T10:00:00Z",
        "description": "Fine-tuning run with custom hyperparameters.",
        "metric_summaries": [
          {
            "count": 100,
            "key": "accuracy"
          }
        ],
        "mlflow_artifact_location": "s3://bucket/active-run",
        "name": "training-run-1",
        "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"
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 25,
      "total": 100
    }
  }
}