Model registry API

Tier: Free, Premium, Ultimate
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

Use this API to interact with the machine learning model registry. For more information, see model registry.

Download a machine learning model package

Returns the file.

GET /projects/:id/packages/ml_models/:model_version_id/files/(*path/):file_name

For Versions, the :model_version_id is specified in the URL of the model version. In the following example, the model version is 5: /namespace/project/-/ml/models/1/versions/5.

For Runs, the ID must prepended with candidate:. In the following example, the :model_version_id is candidate:5: /namespace/project/-/ml/candidates/5.

Parameters:

Attribute	Type	Required	Description
`id`	integer or string	yes	The ID or URL-encoded path of the project
`model_version_id`	integer or string	yes	The model version ID for the file
`path`	string	yes	File directory path
`filename`	string	yes	Filename

curl --header "Authorization: Bearer <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/:id/packages/ml_models/:model_version_id/files/(*path/):filename"

The response contains the file contents.

For example, the following command returns the file foo.txt for the model version with an ID of 2 and project with an ID of 1.

curl --header "Authorization: Bearer <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/1/packages/ml_models/2/files/foo.txt"