Train

The REST reference for Train — 10 operations, generated from the OpenAPI document.

All API references → · Six flows, four surfaces →


Base URL	`https://api.hanzo.ai`
Operations	10
Auth	`Authorization: Bearer $HANZO_API_KEY`

ListTrials lists the katib Trials one experiment owns.

GET /v1/train/experiments/{name}/trials

ListTrials lists the katib Trials one experiment owns. The experiment is read FIRST, so a name the caller's org does not own is a clean 404 rather than an empty list; the Trials themselves are selected by katib's own katib.kubeflow.org/experiment label within the caller's tenant namespace.

Parameter	In	Type	Required	Description
`name`	path	string	yes	Name is the resource to act on, taken from the path.

GetExperiment returns one hyperparameter-tuning experiment.

GET /v1/train/experiments/{name}

GetExperiment returns one hyperparameter-tuning experiment. Its spec comes with it, and katib's live status, which is where the best trial found so far is reported.

Parameter	In	Type	Required	Description
`name`	path	string	yes	Name is the resource to act on, taken from the path.

DeleteExperiment deletes a hyperparameter-tuning experiment.

DELETE /v1/train/experiments/{name}

DeleteExperiment deletes a hyperparameter-tuning experiment. Kubernetes garbage-collects the Trials katib created under it, because they carry the Experiment as their owner. Answers 204, or 404 for a name the caller's org does not own.

Parameter	In	Type	Required	Description
`name`	path	string	yes	Name is the resource to act on, taken from the path.

ListExperiments lists the caller org's tuning experiments.

GET /v1/train/experiments

ListExperiments lists the caller org's tuning experiments. Each entry carries the experiment's name, when Kubernetes admitted it, and katib's live status — the spec is on the single-experiment read.

post_v1_train_experiments

POST /v1/train/experiments

get_v1_train_health

GET /v1/train/health

GetJob returns one training job.

GET /v1/train/jobs/{name}

GetJob returns one training job. Its spec comes with it, and the trainer operator's live status, which is where a run's phase and its conditions are reported.

Parameter	In	Type	Required	Description
`name`	path	string	yes	Name is the resource to act on, taken from the path.

DeleteJob deletes a training job.

DELETE /v1/train/jobs/{name}

DeleteJob deletes a training job. Kubernetes garbage-collects the pods the trainer operator created under it, because they carry the TrainJob as their owner — so deleting the job is how a run is stopped. Answers 204, or 404 for a name the caller's org does not own.

Parameter	In	Type	Required	Description
`name`	path	string	yes	Name is the resource to act on, taken from the path.

ListJobs lists the training jobs in the caller's org.

GET /v1/train/jobs

ListJobs lists the training jobs in the caller's org. Each entry carries the job's name, when Kubernetes admitted it, and the trainer operator's live status — the spec is on the single-job read.

post_v1_train_jobs

POST /v1/train/jobs

All Hanzo APIs · Interactive reference

Train

On this page