Skip to content
UltimateTeam.ai Docs

Retire Model

POST
/api/v1/finetuning/models/{tenant_id}/{version_id}/retire

Retire a model version.

Authorizations

Parameters

Path Parameters

tenant_id
required
string format: uuid
version_id
required
string format: uuid

Request Body required

Request body for retiring a model version.

object
performed_by

User or agent performing the retirement.

string
default: system >= 1 characters <= 200 characters
reason

Reason for retiring this version.

string
"" <= 1000 characters

Responses

200

Successful Response

Response body for a fine-tuned model version.

object
base_model
required
string
canary_traffic_pct
integer
created_at
required
string format: date-time
deployment_status
required
string
evaluation_metrics
required
object
key
additional properties
any
hyperparameters
required
object
key
additional properties
any
id
required
string format: uuid
promoted_at
Any of:
string format: date-time
promoted_by
Any of:
string
provider
required
string
provider_model_id
Any of:
string
retired_at
Any of:
string format: date-time
rolled_back_at
Any of:
string format: date-time
tenant_id
required
string format: uuid
training_data_hash
required
string
version_number
required
integer

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string