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.

Authorizations

CookieOAuth2TokenBearer

OAuth2passwordRequired

Token URL:

Query parameters

model_name_or_idany ofOptional

stringOptional

or

string · uuidOptional

or

nullOptional

hydratebooleanOptionalDefault: false

sort_bystringOptionalDefault: created

logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:

pageinteger · min: 1OptionalDefault: 1

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

idany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

createdany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

updatedany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

run_metadataany ofOptional

string[]Optional

or

nullOptional

tagany ofOptional

stringOptional

or

nullOptional

tagsany ofOptional

string[]Optional

or

nullOptional

scope_userany ofOptional

string · uuidOptional

or

nullOptional

userany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

projectany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

nameany ofOptional

stringOptional

or

nullOptional

numberany ofOptional

integerOptional

or

nullOptional

stageany ofOptional

stringOptional

or

string · enumOptional

All possible stages of a Model Version.

Possible values:

or

nullOptional

modelany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

get

/api/v1/model_versions

HTTPcURLJavaScriptPython

GET /api/v1/model_versions HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2026-01-13T10:11:48.516Z",
        "updated": "2026-01-13T10:11:48.516Z",
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_id": "123e4567-e89b-12d3-a456-426614174000",
        "stage": "text",
        "number": 1,
        "model": {
          "body": {
            "created": "2026-01-13T10:11:48.516Z",
            "updated": "2026-01-13T10:11:48.516Z",
            "user_id": "123e4567-e89b-12d3-a456-426614174000",
            "project_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "license": "text",
            "description": "text",
            "audience": "text",
            "use_cases": "text",
            "limitations": "text",
            "trade_offs": "text",
            "ethics": "text",
            "save_models_to_registry": true
          },
          "resources": "[Circular Reference]",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false,
          "name": "text"
        }
      },
      "metadata": {
        "description": "text",
        "run_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "resources": {
        "user": {
          "body": {
            "created": "2026-01-13T10:11:48.516Z",
            "updated": "2026-01-13T10:11:48.516Z",
            "active": false,
            "activation_token": "text",
            "full_name": "",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
            "avatar_url": "text"
          },
          "metadata": {
            "email": "",
            "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": false,
          "name": "text"
        },
        "services": {
          "index": 1,
          "max_size": 1,
          "total_pages": 1,
          "total": 1,
          "items": "[Circular Reference]"
        },
        "tags": [
          {
            "body": {
              "created": "2026-01-13T10:11:48.516Z",
              "updated": "2026-01-13T10:11:48.516Z",
              "user_id": "123e4567-e89b-12d3-a456-426614174000",
              "color": "grey",
              "exclusive": true
            },
            "metadata": {
              "tagged_count": 1
            },
            "resources": {
              "user": {
                "body": {
                  "created": "2026-01-13T10:11:48.516Z",
                  "updated": "2026-01-13T10:11:48.516Z",
                  "active": false,
                  "activation_token": "text",
                  "full_name": "",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                  "avatar_url": "text"
                },
                "metadata": {
                  "email": "",
                  "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": false,
                "name": "text"
              },
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false,
            "name": "text"
          }
        ],
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    }
  ]
}

Get Model Version

get

Get a model version by ID.

Args: model_version_id: id of the model version to be retrieved. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The model version with the given name or ID.

Authorizations

CookieOAuth2TokenBearer

OAuth2passwordRequired

Token URL:

Path parameters

model_version_idstring · uuidRequired

Query parameters

hydratebooleanOptionalDefault: true

Responses

200

Successful Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

get

/api/v1/model_versions/{model_version_id}

HTTPcURLJavaScriptPython

GET /api/v1/model_versions/{model_version_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "body": {
    "created": "2026-01-13T10:11:48.516Z",
    "updated": "2026-01-13T10:11:48.516Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "stage": "text",
    "number": 1,
    "model": {
      "body": {
        "created": "2026-01-13T10:11:48.516Z",
        "updated": "2026-01-13T10:11:48.516Z",
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "license": "text",
        "description": "text",
        "audience": "text",
        "use_cases": "text",
        "limitations": "text",
        "trade_offs": "text",
        "ethics": "text",
        "save_models_to_registry": true
      },
      "resources": {
        "user": {
          "body": {
            "created": "2026-01-13T10:11:48.516Z",
            "updated": "2026-01-13T10:11:48.516Z",
            "active": false,
            "activation_token": "text",
            "full_name": "",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
            "avatar_url": "text"
          },
          "metadata": {
            "email": "",
            "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": false,
          "name": "text"
        },
        "tags": [
          {
            "body": {
              "created": "2026-01-13T10:11:48.516Z",
              "updated": "2026-01-13T10:11:48.516Z",
              "user_id": "123e4567-e89b-12d3-a456-426614174000",
              "color": "grey",
              "exclusive": true
            },
            "metadata": {
              "tagged_count": 1
            },
            "resources": {
              "user": {
                "body": {
                  "created": "2026-01-13T10:11:48.516Z",
                  "updated": "2026-01-13T10:11:48.516Z",
                  "active": false,
                  "activation_token": "text",
                  "full_name": "",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                  "avatar_url": "text"
                },
                "metadata": {
                  "email": "",
                  "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": false,
                "name": "text"
              },
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false,
            "name": "text"
          }
        ],
        "latest_version_name": "text",
        "latest_version_id": "123e4567-e89b-12d3-a456-426614174000",
        "visualizations": "[Circular Reference]",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    }
  },
  "metadata": {
    "description": "text",
    "run_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": {
    "user": {
      "body": {
        "created": "2026-01-13T10:11:48.516Z",
        "updated": "2026-01-13T10:11:48.516Z",
        "active": false,
        "activation_token": "text",
        "full_name": "",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "avatar_url": "text"
      },
      "metadata": {
        "email": "",
        "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": false,
      "name": "text"
    },
    "services": {
      "index": 1,
      "max_size": 1,
      "total_pages": 1,
      "total": 1,
      "items": [
        {
          "body": {
            "created": "2026-01-13T10:11:48.516Z",
            "updated": "2026-01-13T10:11:48.516Z",
            "user_id": "123e4567-e89b-12d3-a456-426614174000",
            "project_id": "123e4567-e89b-12d3-a456-426614174000",
            "service_type": {
              "type": "text",
              "flavor": "text",
              "name": "",
              "description": "",
              "logo_url": ""
            },
            "labels": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "state": "inactive"
          },
          "metadata": {
            "service_source": "text",
            "admin_state": "inactive",
            "config": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "status": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "endpoint": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "prediction_url": "text",
            "health_check_url": "text"
          },
          "resources": "[Circular Reference]",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false,
          "name": "text"
        }
      ]
    },
    "tags": [
      {
        "body": {
          "created": "2026-01-13T10:11:48.516Z",
          "updated": "2026-01-13T10:11:48.516Z",
          "user_id": "123e4567-e89b-12d3-a456-426614174000",
          "color": "grey",
          "exclusive": true
        },
        "metadata": {
          "tagged_count": 1
        },
        "resources": {
          "user": {
            "body": {
              "created": "2026-01-13T10:11:48.516Z",
              "updated": "2026-01-13T10:11:48.516Z",
              "active": false,
              "activation_token": "text",
              "full_name": "",
              "email_opted_in": true,
              "is_service_account": true,
              "is_admin": true,
              "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
              "avatar_url": "text"
            },
            "metadata": {
              "email": "",
              "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": false,
            "name": "text"
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": false,
        "name": "text"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": false,
  "name": "text"
}

Update Model Version

put

Get all model versions by filter.

Args: model_version_id: The ID of model version to be updated. model_version_update_model: The model version to be updated.

Returns: An updated model version.

Authorizations

CookieOAuth2TokenBearer

OAuth2passwordRequired

Token URL:

Path parameters

model_version_idstring · uuidRequired

Body

application/json

Update model for model versions.

stageany ofOptional

Target model version stage to be set

stringOptional

or

string · enumOptional

All possible stages of a Model Version.

Possible values:

or

nullOptional

forcebooleanOptional

Whether existing model version in target stage should be silently archived or an error should be raised.

Default: false

nameany ofOptional

Target model version name to be set

stringOptional

or

nullOptional

descriptionany ofOptional

Target model version description to be set

stringOptional

or

nullOptional

add_tagsany ofOptional

Tags to be added to the model version

string[]Optional

or

nullOptional

remove_tagsany ofOptional

Tags to be removed from the model version

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

put

/api/v1/model_versions/{model_version_id}

HTTPcURLJavaScriptPython

PUT /api/v1/model_versions/{model_version_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "stage": "text",
  "force": false,
  "name": "text",
  "description": "text",
  "add_tags": [
    "text"
  ],
  "remove_tags": [
    "text"
  ]
}

{
  "body": {
    "created": "2026-01-13T10:11:48.516Z",
    "updated": "2026-01-13T10:11:48.516Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "stage": "text",
    "number": 1,
    "model": {
      "body": {
        "created": "2026-01-13T10:11:48.516Z",
        "updated": "2026-01-13T10:11:48.516Z",
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "license": "text",
        "description": "text",
        "audience": "text",
        "use_cases": "text",
        "limitations": "text",
        "trade_offs": "text",
        "ethics": "text",
        "save_models_to_registry": true
      },
      "resources": {
        "user": {
          "body": {
            "created": "2026-01-13T10:11:48.516Z",
            "updated": "2026-01-13T10:11:48.516Z",
            "active": false,
            "activation_token": "text",
            "full_name": "",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
            "avatar_url": "text"
          },
          "metadata": {
            "email": "",
            "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": false,
          "name": "text"
        },
        "tags": [
          {
            "body": {
              "created": "2026-01-13T10:11:48.516Z",
              "updated": "2026-01-13T10:11:48.516Z",
              "user_id": "123e4567-e89b-12d3-a456-426614174000",
              "color": "grey",
              "exclusive": true
            },
            "metadata": {
              "tagged_count": 1
            },
            "resources": {
              "user": {
                "body": {
                  "created": "2026-01-13T10:11:48.516Z",
                  "updated": "2026-01-13T10:11:48.516Z",
                  "active": false,
                  "activation_token": "text",
                  "full_name": "",
                  "email_opted_in": true,
                  "is_service_account": true,
                  "is_admin": true,
                  "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
                  "avatar_url": "text"
                },
                "metadata": {
                  "email": "",
                  "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": false,
                "name": "text"
              },
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "permission_denied": false,
            "name": "text"
          }
        ],
        "latest_version_name": "text",
        "latest_version_id": "123e4567-e89b-12d3-a456-426614174000",
        "visualizations": "[Circular Reference]",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    }
  },
  "metadata": {
    "description": "text",
    "run_metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": {
    "user": {
      "body": {
        "created": "2026-01-13T10:11:48.516Z",
        "updated": "2026-01-13T10:11:48.516Z",
        "active": false,
        "activation_token": "text",
        "full_name": "",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "avatar_url": "text"
      },
      "metadata": {
        "email": "",
        "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": false,
      "name": "text"
    },
    "services": {
      "index": 1,
      "max_size": 1,
      "total_pages": 1,
      "total": 1,
      "items": [
        {
          "body": {
            "created": "2026-01-13T10:11:48.516Z",
            "updated": "2026-01-13T10:11:48.516Z",
            "user_id": "123e4567-e89b-12d3-a456-426614174000",
            "project_id": "123e4567-e89b-12d3-a456-426614174000",
            "service_type": {
              "type": "text",
              "flavor": "text",
              "name": "",
              "description": "",
              "logo_url": ""
            },
            "labels": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "state": "inactive"
          },
          "metadata": {
            "service_source": "text",
            "admin_state": "inactive",
            "config": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "status": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "endpoint": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "prediction_url": "text",
            "health_check_url": "text"
          },
          "resources": "[Circular Reference]",
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false,
          "name": "text"
        }
      ]
    },
    "tags": [
      {
        "body": {
          "created": "2026-01-13T10:11:48.516Z",
          "updated": "2026-01-13T10:11:48.516Z",
          "user_id": "123e4567-e89b-12d3-a456-426614174000",
          "color": "grey",
          "exclusive": true
        },
        "metadata": {
          "tagged_count": 1
        },
        "resources": {
          "user": {
            "body": {
              "created": "2026-01-13T10:11:48.516Z",
              "updated": "2026-01-13T10:11:48.516Z",
              "active": false,
              "activation_token": "text",
              "full_name": "",
              "email_opted_in": true,
              "is_service_account": true,
              "is_admin": true,
              "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
              "avatar_url": "text"
            },
            "metadata": {
              "email": "",
              "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": false,
            "name": "text"
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "permission_denied": false,
        "name": "text"
      }
    ],
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": false,
  "name": "text"
}

Delete Model Version

delete

Delete a model by name or ID.

Args: model_version_id: The name or ID of the model version to delete.

Authorizations

CookieOAuth2TokenBearer

OAuth2passwordRequired

Token URL:

Path parameters

model_version_idstring · uuidRequired

Responses

200

Successful Response

application/json

Responseany

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

delete

/api/v1/model_versions/{model_version_id}

HTTPcURLJavaScriptPython

DELETE /api/v1/model_versions/{model_version_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content