GuidesRecipesAPI ReferenceChangelogDiscussions
Log In

Model management

Overview

The Model service provides the APIs needed to retrieve and manage available AI models. It can be integrated with other applications, scripts, and systems. It provides APIs to browse and update models, set processing engines, and get usage and telemetry details.

The models object

{
  "modelId": "...",
  "latestVersion": "...",
  "latestActiveVersion": "...",
  "versions": [],
  "author": "...",
  "name": "...",
  "description": "...",
  "permalink": "...",
  "features": [],
  "isActive": false,
  "isRecommended": false,
  "isCommercial": false,
  "tags": [],
  "images": [],
  "lastActiveDateTime": "...",
  "createdByEmail": "...",
  "createdByFullName": "...",
  "visibility": {
    "scope": "...",
    "teams": []
  }
}
modelIdstringA model identifier provided by Modzy. It contains 10 random alphanumeric characters.
latestVersionstringThe model’s most recent active version. This version is displayed by default in the Model Details page.
latestActiveVersionstringThe model’s most recent active version. This version is displayed by default in the Model Details page.
versionsarrayAn array that contains all the version objects.
authorstringThe organization that created the model.
namestringThe model’s name. It may only contain alphanumeric, dash, and underscore characters.
descriptionstringA summary about the model. It’s featured in the Model Marketplace.
permalinkstringA link to the model. It combines the modelId, author, and name.
featuresarrayAn array that contains all the feature objets.
isActivebooleanActive models are available in the Marketplace and can execute inference on data. At least one active version is required for the model to remain active.
isRecommendedbooleanAdds a "recommended" badge to the model. It features in the Model Marketplace. Defaults to false.
isCommercialbooleanThe model’s commercial status. Commercial models can be purchased.
tagsarrayAn array that contains all the tag objects.
imagesarrayAn array that contains all the image objects.
lastActiveDateTimestringThe last time the model was used in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.
createdByEmailstringThe email of the user that deployed the model.
createdByFullNamestringThe full name of the user that deployed the model.
visibilityobjectAn object that contains a model’s scope that defines who can see the model (ALL, ACCOUNT, TEAM, PRIVATE) and the model’s teams.