Skip to main content

Update a custom model

PUT 
/v1/models/:model_uuid

Update a custom model's name and/or model state.

Async semantics. When the model state changes, the call returns pending immediately and re-runs generation in a worker. Poll GET /v1/models/{uuid} until status is completed, failed, or reverted.

Rename short-circuit. When only name changes (model_state is identical), the rename is applied synchronously without re-running generation, and the response reflects the post-rename state directly.

Concurrency. Refuses to update a model with an in-progress update status - either pending or running - and will fail with MODEL_UPDATE_IN_PROGRESS, or in failed state and will fail with MODEL_IN_FAILED_STATE. Per the API contract, DELETE and recreate the model to escape failed.

Authentication. Requires a valid X-API-Key header.

Request​

Responses​

The model after the update has been queued (or, in the rename-only fast path, after the rename has applied). Generation runs asynchronously when the state changes; poll GET /v1/models/{uuid}.