Skip to content
UltimateTeam.ai Docs

Promote prompt version

POST
/api/v1/tuning/prompts/{version_id}/promote
curl --request POST \
  --url 'https://api.ultimateteam.ai/api/v1/tuning/prompts/example/promote?traffic_pct=100' \
  --header 'X-API-Key: <X-API-Key>'

Promote a prompt version to active.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
version_id
required
Version Id
string

Query Parameters

Section titled “Query Parameters”
traffic_pct
Traffic Pct
integer
default: 100 >= 1 <= 100

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
PromptVersionResponse

Response body for a prompt version.

object
activated_at
Any of:
string format: date-time
agent_role
required
Agent Role
string
changelog
required
Changelog
string
content
required
Content
string
created_at
required
Created At
string format: date-time
evaluation_scores
required
Evaluation Scores
object
key
additional properties
any
id
required
Id
string format: uuid
performance_metrics
required
Performance Metrics
object
key
additional properties
any
status
required
Status
string
traffic_pct
required
Traffic Pct
integer
version_number
required
Version Number
integer
Examplegenerated
{
  "activated_at": "2026-04-15T12:00:00Z",
  "agent_role": "example",
  "changelog": "example",
  "content": "example",
  "created_at": "2026-04-15T12:00:00Z",
  "evaluation_scores": {},
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "performance_metrics": {},
  "status": "example",
  "traffic_pct": 1,
  "version_number": 1
}

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