Create optim step

Applies the optimizer to the accumulated gradients.

POST /v1/train/clients/{id}/optim_step

Addresshttps://api.hanzo.ai/v1/train/clients/{id}/optim_step
MethodPOST
Operationpost_train_clients_by_id_optim_step
AuthAuthorization: Bearer $HANZO_API_KEY

Applies the optimizer to the accumulated gradients.

Request

3 fields, body application/json (required).

FieldInTypeRequiredDescription
idpathstringyesID names the client.
adam_paramsbodyany—AdamParams are the optimizer's parameters for this step.
idbodystring—ID names the client.

Response

StatusBodyMeaning
200ok
defaultproblem-detailsrefused

200 body — 1 field.

FieldInTypeAlwaysDescription
(body)bodyanyyes

Failure carries the platform error shape — see Errors.

Examples

hanzo train clients optim_step <id>
import { Configuration, TrainApi } from 'hanzoai';

const api = new TrainApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postTrainClientsByIdOptimStep({ id: 'id', adam_params: "<adam_params>", id: "<id>" });
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).post_train_clients_by_id_optim_step(id='id', adam_params="<adam_params>", id="<id>")
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.TrainAPI.PostTrainClientsByIdOptimStep(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::post_train_clients_by_id_optim_step(&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).postTrainClientsByIdOptimStep();
curl -X POST https://api.hanzo.ai/v1/train/clients/<id>/optim_step \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "adam_params": "<adam_params>",
       "id": "<id>"
     }'

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.