Get models

Returns one deployed inference model.

GET /v1/ml/models/{name}

Addresshttps://api.hanzo.ai/v1/ml/models/{name}
MethodGET
Operationget_ml_models_by_name
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one deployed inference model. Its spec comes with it, and kserve's live status, which is where readiness and the serving address appear. A name the caller's org does not own answers 404, exactly as an unknown name does, so a probe learns nothing about another tenant's models.

Request

1 field.

FieldInTypeRequiredDescription
namepathstringyesName is the resource to act on, taken from the path.

Response

StatusBodyMeaning
200ml.mlResourceok
defaultproblem-detailsrefused

200 body — 6 fields.

FieldInTypeAlwaysDescription
createdAtbodystring—CreatedAt is when Kubernetes admitted the object, RFC 3339 in UTC.
namebodystring—Name is the object's metadata.name, unique within the caller's namespace.
specbodyobject—Spec is the resource spec, verbatim as Kubernetes stores it.
spec.*bodyany—
statusbodyobject—Status is the live status kserve owns, verbatim.
status.*bodyany—

Failure carries the platform error shape — see Errors.

Examples

hanzo ml models get <name>
import { Configuration, MlApi } from 'hanzoai';

const api = new MlApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getMlModelsByName({ name: 'name' });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import MlApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = MlApi(client).get_ml_models_by_name(name='name')
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.MlAPI.GetMlModelsByName(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, ml_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = ml_api::get_ml_models_by_name(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.MlApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new MlApi(client).getMlModelsByName();
curl https://api.hanzo.ai/v1/ml/models/<name> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches ml through the ml tool, which names its 4 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_ml_models"
         }
       }
     }'

ML API · All Hanzo APIs · Interactive reference

Was this page useful?