List Artifact Versions
List artifact version API
curl --request GET \
--url https://{controlPlaneURL}/api/ml/v1/artifact-versions \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "<string>",
"fqn": "<string>",
"created_by_subject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"manifest": {
"name": "<string>",
"description": "<string>",
"metadata": {},
"version_alias": "<string>",
"ml_repo": "<string>",
"version": 2,
"type": "artifact-version",
"source": {
"type": "truefoundry",
"uri": "<string>"
},
"step": 0,
"run_id": "<string>"
},
"usage_code_snippet": "<string>",
"ml_repo_id": "<string>",
"artifact_id": "<string>"
}
],
"pagination": {
"total": 100,
"offset": 0,
"limit": 10
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Response
Subject ID
Subject type
user
, team
, serviceaccount
Subject slug
Subject display name
Artifact Version manifest.
Name of the entity
256
Key value metadata. Should be valid JSON. For e.g. {"business-unit": "sales", "quality": "good", "rating": 4.5}
Name of the ML Repo
512
Version alias is alternate, ideally human readable, version string to reference an artifact version. It should start with v
followed by alphanumeric and it can include .
and -
in between (e.g. v1.0.0
, v1-prod
, v3-dev
, etc)
128
Version of the entity
x >= 1
artifact-version
Step/Epoch number in an iterative training loop the artifact version was created. Generally useful when logging a model version from a MLRepo Run
x >= 0
ID of the MLRepo Run that generated the artifact version
curl --request GET \
--url https://{controlPlaneURL}/api/ml/v1/artifact-versions \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "<string>",
"fqn": "<string>",
"created_by_subject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"manifest": {
"name": "<string>",
"description": "<string>",
"metadata": {},
"version_alias": "<string>",
"ml_repo": "<string>",
"version": 2,
"type": "artifact-version",
"source": {
"type": "truefoundry",
"uri": "<string>"
},
"step": 0,
"run_id": "<string>"
},
"usage_code_snippet": "<string>",
"ml_repo_id": "<string>",
"artifact_id": "<string>"
}
],
"pagination": {
"total": 100,
"offset": 0,
"limit": 10
}
}