Skip to content
UltimateTeam.ai Docs

Retire Model

POST
/api/v1/finetuning/models/{tenant_id}/{version_id}/retire
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/finetuning/models/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/retire \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "performed_by": "system", "reason": "" }'

Retire a model version.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant_id
required
Tenant Id
string format: uuid
version_id
required
Version Id
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
RetireRequest

Request body for retiring a model version.

object
performed_by
Performed By

User or agent performing the retirement.

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

Reason for retiring this version.

string
"" <= 1000 characters

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
FineTunedModelVersionResponse

Response body for a fine-tuned model version.

object
base_model
required
Base Model
string
canary_traffic_pct
Canary Traffic Pct
integer
0
created_at
required
Created At
string format: date-time
deployment_status
required
Deployment Status
string
evaluation_metrics
required
Evaluation Metrics
object
key
additional properties
any
hyperparameters
required
Hyperparameters
object
key
additional properties
any
id
required
Id
string format: uuid
promoted_at
Any of:
string format: date-time
promoted_by
Any of:
string
provider
required
Provider
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
Tenant Id
string format: uuid
training_data_hash
required
Training Data Hash
string
version_number
required
Version Number
integer
Example
{
  "canary_traffic_pct": 0
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}