Models

Create a model definition

Changed on
post/api/v1/models/{tenant}/{name}

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}
  • Auth: none declared

Path parameters

tenantstring required
namestring required

Request body

annotationsStringMap
descriptionstring

Free-text definition description.

displayNamestring

Human-readable definition label.

labelsStringMap
namestring required

Artifact definition name (unique within the tenant).

specobject

Pass-through definition spec (free-form).

Example request

{
  "description": "ResNet-50 image-classification model.",
  "displayName": "ResNet-50",
  "labels": {
    "team": "vision"
  },
  "name": "resnet50"
}

Response

Model definition created.

annotationsStringMap
createdAtstring date-time required

Time the definition was created.

descriptionstring

Free-text definition description.

displayNamestring

Human-readable definition label.

idstring uuid required

Stable definition identifier.

kind'model' | 'image' required

Definition kind (model or image).

labelsStringMap
latestVersionstring

Version string of the most recent version.

latestVersionAtstring date-time nullable

Creation time of the most recent version.

namestring required

Definition name (unique within the tenant).

namespacestring required

Platform tenant namespace the definition belongs to.

ownerstring

Username of the definition owner.

ownerIdstring uuid

User ID of the definition owner.

specobject

Pass-through definition spec (free-form).

tenantNamestring required

Tenant identifier owning the definition.

updatedAtstring date-time required

Time the definition was last updated.

versionCountinteger

Number of versions under the definition (roll-up for list cards).

Example response

{
  "annotations": {
    "git-commit": "8c1f4e2"
  },
  "createdAt": "2026-06-20T08:00:00Z",
  "description": "ResNet-50 image-classification model.",
  "displayName": "ResNet-50",
  "id": "1f2e3d4c-5b6a-7980-abcd-ef0123456789",
  "kind": "model",
  "labels": {
    "team": "vision"
  },
  "latestVersion": "1.4.0",
  "latestVersionAt": "2026-06-28T09:30:00Z",
  "name": "resnet50",
  "namespace": "team-vision",
  "owner": "li.wei",
  "ownerId": "3a2b1c0d-4e5f-6789-abcd-ef0123456789",
  "spec": {
    "format": "safetensors",
    "framework": "pytorch",
    "parameters": "25.6M",
    "task": "image-classification"
  },
  "tenantName": "team-vision",
  "updatedAt": "2026-06-28T09:30:00Z",
  "versionCount": 3
}

Changes

  • e93e8e490641Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 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 object to no type for status

    • breaking

      the response's property type changed from object 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