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

JSON

{
  "modelId": "...",
  "latestVersion": "...",
  "latestActiveVersion": "...",
  "versions": [],
  "author": "...",
  "name": "...",
  "description": "...",
  "permalink": "...",
  "features": [],
  "isActive": false,
  "isRecommended": false,
  "isCommercial": false,
  "tags": [],
  "images": [],
  "lastActiveDateTime": "...",
  "createdByEmail": "...",
  "createdByFullName": "...",
  "visibility": {
    "scope": "...",
    "teams": []
  }
}

modelId	string	A model identifier provided by Modzy. It contains 10 random alphanumeric characters.
latestVersion	string	The model’s most recent active version. This version is displayed by default in the Model Details page.
latestActiveVersion	string	The model’s most recent active version. This version is displayed by default in the Model Details page.
versions	array	An array that contains all the version objects.
author	string	The organization that created the model.
name	string	The model’s name. It may only contain alphanumeric, dash, and underscore characters.
description	string	A summary about the model. It’s featured in the Model Marketplace.
permalink	string	A link to the model. It combines the modelId, author, and name.
features	array	An array that contains all the feature objets.
isActive	boolean	Active 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.
isRecommended	boolean	Adds a "recommended" badge to the model. It features in the Model Marketplace. Defaults to false.
isCommercial	boolean	The model’s commercial status. Commercial models can be purchased.
tags	array	An array that contains all the tag objects.
images	array	An array that contains all the image objects.
lastActiveDateTime	string	The last time the model was used in ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.
createdByEmail	string	The email of the user that deployed the model.
createdByFullName	string	The full name of the user that deployed the model.
visibility	object	An object that contains a model’s scope that defines who can see the model (ALL, ACCOUNT, TEAM, PRIVATE) and the model’s teams.