Model versions

List Model Versions

get

Get model versions according to query filters.

Args: model_version_filter_model: Filter model used for pagination, sorting, filtering. model_name_or_id: Optional name or ID of the model. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response. auth_context: The authentication context.

Returns: The model versions according to query filters.

Raises: ValueError: If the model is missing from the filter.

Authorizations

Path parameters

model_name_or_idany ofRequired

Query parameters

hydratebooleanOptionalDefault: false

sort_bystringOptionalDefault: created

logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andAvailable options:

pageinteger · min: 1OptionalDefault: 1

sizeinteger · min: 1 · max: 10000OptionalDefault: 20

idany ofOptional

createdany ofOptional

updatedany ofOptional

run_metadataany ofOptional

tagany ofOptional

tagsany ofOptional

scope_userany ofOptional

userany ofOptional

projectany ofOptional

nameany ofOptional

numberany ofOptional

stageany ofOptional

All possible stages of a Model Version.

modelany ofOptional

Responses

application/json

objectOptional

application/json

application/json

application/json

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/models/{model_name_or_id}/model_versions HTTP/1.1
Host: 
Accept: */*

{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2025-04-21T16:49:05.607Z",
        "updated": "2025-04-21T16:49:05.607Z",
        "user": {
          "body": {
            "created": "2025-04-21T16:49:05.607Z",
            "updated": "2025-04-21T16:49:05.607Z",
            "active": true,
            "activation_token": "text",
            "full_name": "text",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "email": "text",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "stage": "text",
        "number": 1,
        "model": {
          "body": {
            "created": "2025-04-21T16:49:05.607Z",
            "updated": "2025-04-21T16:49:05.607Z",
            "user": {
              "body": {
                "created": "2025-04-21T16:49:05.607Z",
                "updated": "2025-04-21T16:49:05.607Z",
                "active": true,
                "activation_token": "text",
                "full_name": "text",
                "email_opted_in": true,
                "is_service_account": true,
                "is_admin": true,
                "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
              },
              "metadata": {
                "email": "text",
                "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                "user_metadata": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                }
              },
              "resources": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "permission_denied": true,
              "name": "text"
            },
            "tags": [
              {
                "body": {
                  "created": "2025-04-21T16:49:05.607Z",
                  "updated": "2025-04-21T16:49:05.607Z",
                  "user": {
                    "body": {
                      "created": "2025-04-21T16:49:05.607Z",
                      "updated": "2025-04-21T16:49:05.607Z",
                      "active": true,
                      "activation_token": "text",
                      "full_name": "text",
                      "email_opted_in": true,
                      "is_service_account": true,
                      "is_admin": true,
                      "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
                    },
                    "metadata": {
                      "email": "text",
                      "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                      "user_metadata": {
                        "ANY_ADDITIONAL_PROPERTY": "anything"
                      }
                    },
                    "resources": {
                      "ANY_ADDITIONAL_PROPERTY": "anything"
                    },
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "permission_denied": true,
                    "name": "text"
                  },
                  "color": "grey",
                  "exclusive": true,
                  "tagged_count": 1
                },
                "metadata": {},
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": true,
                "name": "text"
              }
            ],
            "latest_version_name": "text",
            "latest_version_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "project": {
              "body": {
                "created": "2025-04-21T16:49:05.607Z",
                "updated": "2025-04-21T16:49:05.607Z",
                "display_name": "text"
              },
              "metadata": {
                "description": "text"
              },
              "resources": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "permission_denied": true,
              "name": "text"
            },
            "license": "text",
            "description": "text",
            "audience": "text",
            "use_cases": "text",
            "limitations": "text",
            "trade_offs": "text",
            "ethics": "text",
            "save_models_to_registry": true
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "model_artifact_ids": {
          "ANY_ADDITIONAL_PROPERTY": {
            "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "data_artifact_ids": {
          "ANY_ADDITIONAL_PROPERTY": {
            "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "deployment_artifact_ids": {
          "ANY_ADDITIONAL_PROPERTY": {
            "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
          }
        },
        "pipeline_run_ids": {
          "ANY_ADDITIONAL_PROPERTY": "123e4567-e89b-12d3-a456-426614174000"
        },
        "tags": [
          {
            "body": {
              "created": "2025-04-21T16:49:05.607Z",
              "updated": "2025-04-21T16:49:05.607Z",
              "user": {
                "body": {
                  "created": "2025-04-21T16:49:05.607Z",
                  "updated": "2025-04-21T16:49:05.607Z",
                  "active": true,
                  "activation_token": "text",
                  "full_name": "text",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
                },
                "metadata": {
                  "email": "text",
                  "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
                  "user_metadata": {
                    "ANY_ADDITIONAL_PROPERTY": "anything"
                  }
                },
                "resources": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                },
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "permission_denied": true,
                "name": "text"
              },
              "color": "grey",
              "exclusive": true,
              "tagged_count": 1
            },
            "metadata": {},
            "resources": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": true,
            "name": "text"
          }
        ]
      },
      "metadata": {
        "project": {
          "body": {
            "created": "2025-04-21T16:49:05.607Z",
            "updated": "2025-04-21T16:49:05.607Z",
            "display_name": "text"
          },
          "metadata": {
            "description": "text"
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": true,
          "name": "text"
        },
        "description": "text",
        "run_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "resources": {
        "services": {
          "index": 1,
          "max_size": 1,
          "total_pages": 1,
          "total": 1,
          "items": "[Circular Reference]"
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "name": "text"
    }
  ]
}