REST API Reference > Model Serve REST API > Quick start models
  

Quick start models

Use API resources to get descriptions and status information about quick start models.

Getting descriptions of quick start models

Use the modelhub resource to get a list of the names and descriptions of all quick start models.

GET request

To get information about the quick start models, use the following URI:
/mlops/api/v1/modelhub/models

GET response

Returns an overview of each quick start model.
The following table describes the fields in each quick start model overview:
Field
Type
Description
displayName
String
External name of the quick start model that displays in the user interface.
name
String
Internal name of the quick start model.
description
String
Description of the quick start model.
framework
String
Framework used to create the model. Quick start models use the framework PYTHON.
frameworkType
String
Internal type of the framework. Quick start models use the type CUSTOM.

Monitoring quick start models

Use the modelhub resource to get the statuses of all quick start models.

GET request

To monitor all quick start models, use the following URI:
/mlops/api/v1/modelhub/monitor

GET response

Returns a status summary of each quick start model.
The following table describes the fields in each status summary:
Field
Type
Description
displayName
String
External name of the quick start model that displays in the user interface.
name
String
Internal name of the quick start model.
deploymentStatus
String
Current status of the quick start model.
deploymentState
String
Requested state of the quick start model. When you start or restart a model, the requested state is ENABLED. When you stop a model, the requested state is DISABLED.
deploymentId
String
ID of the quick start model.
predictUrl
String
Model endpoint URL. Use the URL to generate predictions from the model.
Applies when the quick start model is available.

Getting information about a quick start model

Use the modelhub resource to get information about a single quick start model.

GET request

To get information about a quick start model, use the following URI:
/mlops/api/v1/modelhub/preBuiltModel?name=<model name>
To get information about the image classification model, use IMAGE_CLASSIFICATION as the model name. To get information about the text translation model, use TEXT_TRANSLATION as the model name.

GET response

Returns a summary of the quick start model.
The following table describes the fields in each quick start model summary:
Field
Type
Description
displayName
String
External name of the quick start model that displays in the user interface.
name
String
Internal name of the quick start model.
description
String
Description of the quick start model.
id
String
ID of the quick start model.
status
String
Current status of the quick start model.
predictUrl
String
Model endpoint URL. Use the URL to generate predictions from the model.
Applies when the quick start model is available.