Skip to content
UltimateTeam.ai Docs

Register Model

POST
/api/v1/finetuning/models/{tenant_id}
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/finetuning/models/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "base_model": "example", "evaluation_metrics": {}, "hyperparameters": {}, "provider": "example", "provider_model_id": "example", "training_data_hash": "example" }'

Register a new fine-tuned model version.

Creates a new version in draft status. Enterprise-only.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
FineTunedModelCreate

Request body for registering a new fine-tuned model version.

object
base_model
required
Base Model

Base model identifier (e.g. ‘gpt-4o-2024-08-06’).

string
>= 1 characters <= 200 characters
evaluation_metrics
Evaluation Metrics

Initial evaluation metrics from training (loss, etc.).

object
key
additional properties
any
hyperparameters
Hyperparameters

Training hyperparameters (epochs, learning_rate, etc.).

object
key
additional properties
any
provider
required
Provider

LLM provider (openai, google, anthropic).

string
>= 1 characters <= 50 characters
provider_model_id
Any of:
string
<= 500 characters
training_data_hash
required
Training Data Hash

SHA-256 hash of the training dataset for reproducibility.

string
>= 1 characters <= 128 characters
Examplegenerated
{
  "base_model": "example",
  "evaluation_metrics": {},
  "hyperparameters": {},
  "provider": "example",
  "provider_model_id": "example",
  "training_data_hash": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201”

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"
    }
  ]
}