List models

Answers each base the caller can train today, in one shape: the base, the methods it trains by (adaptations), where it runs (runs: Hanzo's devices or the org's machines) with what one device-second costs there in nano-USD, then the resources that run it (nouns), its executor and devices, and the protections, objective terms, outputs and dataset schemes it takes.

GET /v1/train/models

Addresshttps://api.hanzo.ai/v1/train/models
MethodGET
Operationget_train_models
AuthAuthorization: Bearer $HANZO_API_KEY

Answers each base the caller can train today, in one shape: the base, the methods it trains by (adaptations), where it runs (runs: Hanzo's devices or the org's machines) with what one device-second costs there in nano-USD, then the resources that run it (nouns), its executor and devices, and the protections, objective terms, outputs and dataset schemes it takes. Bases are ordered by name, a base's runs by place, then price. A create is validated against the same rows, and a noun the caller cannot start is not listed: the engine's clients are a SuperAdmin's.

Request

GET /v1/train/models takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200train.catalogok
defaultproblem-detailsrefused

200 body — 14 fields.

FieldInTypeAlwaysDescription
databodytrain.Family[]—Data is every base the caller can train, each with its methods, where it runs and what a device-second costs there.
data[].adaptationsbodystring[]—Adaptations are the methods it trains by: a create's adaptation.mode.
data[].basebodystring—Base is the base model: kai, or engine for the models the engine loads.
data[].datasetsbodystring[]—Datasets are the dataset URI schemes it reads.
data[].devicesbodystring[]—Devices are the accelerator kinds it runs on, wherever it runs.
data[].executorbodystring—Executor is what runs it.
data[].nounsbodystring[]—Nouns are the resources that run it: jobs, clients.
data[].outputsbodystring[]—Outputs are the output kinds it produces.
data[].protectbodystring[]—Protect are the protections it runs: projection, distillation, capabilities.
data[].runsbodytrain.Run[]—Runs are where it runs, each with what a device-second costs there.
data[].runs[].devicesbodystring[]—Devices are the accelerator kinds it runs on there; none is the executor's own.
data[].runs[].price_nano_usdbodyinteger (int64)—Price is what one device-second costs there, in nano-USD: 0 on the org's machines.
data[].runs[].wherebodystring—Where is hanzo, Hanzo's devices, charged by the device-second to the payer inside the job's budget; or machines, the org's linked machines, charged nothing.
data[].termsbodystring[]—Terms are the objective terms it runs.

Failure carries the platform error shape — see Errors.

Examples

hanzo train models
import { Configuration, TrainApi } from 'hanzoai';

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

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

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

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

let result = train_api::get_train_models(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.TrainApi;

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

var result = new TrainApi(client).getTrainModels();
curl https://api.hanzo.ai/v1/train/models \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches train through the train tool, which names its 35 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_train_artifacts"
         }
       }
     }'

Train API · All Hanzo APIs · Interactive reference

Was this page useful?
Broken link or missing step? Drop it in #docs on Discord or open a PR.