v3

latestOpenAPI 3.1.02026-07-3153169140.2 KB

models

Update Model

Set or rename a model's name (unique per org).

The console drives this; both naming an unnamed model and renaming an existing one are the same call. A name already taken in the org surfaces as 409 (the partial unique index is the guard); the request body's validator rejects malformed names with 422 before reaching here.

Owner-scoped, matching delete: a member can read the org's models but only rename their own (a non-owned model returns 404).

patch/v1/models/{model_id}

Path parameters

model_idstring uuid required

Request body

namestring required

New human-readable model name, unique per org.

Response

Successful Response

short_idstring required

Short, human-friendly model handle, e.g. mdl-7bQ2xV9mKp4R.

namestring required

Human-readable model name, unique per org. Server-generated at creation; editable via PATCH /v1/models/{model_id}.

user_idstring required

Id of the user who created the model (the creator/owner).

model_type'training' | 'custom_training' | 'reasoning' | 'sequence_reasoning' required

training for platform-trained models; custom_training for caller-owned Python trial artifacts; reasoning for reasoning models on flat tasks; sequence_reasoning for reasoning models on sequence tasks.

created_atstring nullable

hyperparametersobject nullable

The winning trial's hyperparameters (model-family specific).

validation_metricsobject nullable

Cross-validation scores the optimizer selected on, keyed by metric name (e.g. {"auc": 0.91}).

source_tablesstring[]

Names of the source tables the model trained on, captured at finalize from its training plan (read relations). Empty for models recorded before this was captured.