ULultralytics
Models

Update a model

Changed on

Updates model properties such as name, description, metadata, or training status. Pass projectId alone to move the model into another project owned by the same account.

patch/api/models/{owner}/{project}/{model}

Request

  • Base URL
    https://platform.ultralytics.com
  • Auth
    HTTP bearer

Path parameters

ownerstring required
Example:ultralytics

Project owner

projectstring required
Example:yolo26

Project name

modelstring required
Example:yolo26n

Model name

Request body

starredboolean
namestring
colorstring nullable
descriptionstring
metadataobject

Custom JSON metadata with keys limited to 128 characters and at most 500,000 serialized characters.

status'pending' | 'untrained' | 'starting' | 'running' | 'completed' | 'failed' | 'cancelled'

Training/model status

license'None' | 'Apache-2.0' | 'MIT' | 'BSD-3-Clause' | 'AGPL-3.0' | 'GPL-3.0' | 'LGPL-3.0' | 'MPL-2.0' | 'EUPL-1.1' | 'Unlicense' | 'CC0-1.0' | 'Ultralytics-Enterprise' | 'Other'

Project/model license identifier

datasetSlugstring nullable
projectIdstring

Move the model into this project (same owner)

trainArgsobject

Custom JSON metadata with keys limited to 128 characters and at most 500,000 serialized characters.

epochsnumber
bestEpochnumber
bestFitnessnumber
versionstring

Example request

{
  "projectId": "507f1f77bcf86cd799439011"
}

Response

Model updated or starred

OR
OR

Changes

  • 67c88de7493aRevision changes
    • info

      added the new optional request property

    • info

      added subschema #2 to the response body anyOf list for the response status