Models

Update mutable model metadata

Changed on
patch/api/v1/models/{tenant}/{name}/versions/{version}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/models/{tenant}/{name}/versions/{version}
  • Auth: none declared

Path parameters

tenantstring required
namestring required
versionstring required

Request body

annotationsStringMap
descriptionstring

Updated free-text description.

displayNamestring

Updated human-readable label.

labelsStringMap

Example request

{
  "description": "Updated version description.",
  "displayName": "ResNet-50 v1.4.0 (calibrated)",
  "labels": {
    "team": "vision"
  }
}

Response

Model updated.

createdAtstring date-time required

Time the version was created.

descriptionstring

Free-text version description.

digeststring

Content digest of the uploaded artifact.

displayNamestring

Human-readable version label.

idstring uuid required

Stable model version identifier.

namestring required

Model definition name (unique within the tenant).

namespacestring required

Platform tenant namespace the model belongs to.

ownerstring

Username of the version owner.

ownerIdstring uuid

User ID of the version owner.

readyAtstring date-time nullable

Time the version became Ready.

sizeBytesinteger

Total size of the version content in bytes.

source'webUpload' | 'oras' | 'dockerPush' | 'external'

How an artifact version was added.

specModelSpec

Artifact-side spec for kind=model; pass-through to artifacts.

status'Uploading' | 'Ready' | 'Failed' | 'Deleting' | 'Deleted' required

Mirrors artifacts ArtifactStatus for kind=model.

tenantNamestring required

Tenant identifier owning the model.

updatedAtstring date-time

Time the version was last updated.

uristring

Artifact registry URI of the version.

versionstring required

Model version label.

Example response

{
  "createdAt": "2026-06-20T08:00:00Z",
  "description": "ResNet-50 weights fine-tuned on ImageNet.",
  "digest": "sha256:9b0d5a2c7f3148e1f4a6c8e3d2b4a6c8e1f9b0d5a2c7f3148e1f4a6c8e3d2b4a",
  "displayName": "ResNet-50 v1.4.0",
  "id": "c4a7f1e9-3d2b-4a6c-8e1f-9b0d5a2c7f31",
  "name": "resnet50",
  "namespace": "team-vision",
  "owner": "li.wei",
  "ownerId": "3a2b1c0d-4e5f-6789-abcd-ef0123456789",
  "readyAt": "2026-06-28T09:30:00Z",
  "sizeBytes": 102457600,
  "source": "webUpload",
  "spec": {
    "format": "safetensors",
    "framework": "pytorch",
    "parameters": "25.6M",
    "task": "image-classification"
  },
  "status": "Ready",
  "tenantName": "team-vision",
  "updatedAt": "2026-06-28T09:30:00Z",
  "uri": "oci://registry.axisml.io/team-vision/resnet50:1.4.0",
  "version": "1.4.0"
}

Changes

  • d51e2e0e6970Revision changes
    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      the request property type changed from object to no type

    • breaking

      the request property type changed from object to no type

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed the Deleted enum value from the response property for the response status

    • info

      removed the Deleting enum value from the response property for the response status

    • info

      removed the Failed enum value from the response property for the response status

    • info

      removed the Ready enum value from the response property for the response status

    • info

      removed the Uploading enum value from the response property for the response status

    • info

      removed the dockerPush enum value from the response property for the response status

    • info

      removed the external enum value from the response property for the response status

    • info

      removed the oras enum value from the response property for the response status

    • info

      removed the webUpload enum value from the response property for the response status