Skip to content
UltimateTeam.ai Docs

Create A/B test

POST
/api/v1/tuning/ab-tests
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/tuning/ab-tests \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "agent_role": "example", "behavior_dimension": "example", "min_tenants": 50, "name": "example", "significance_threshold": 0.05, "variants": [ { "config": {}, "name": "example" } ] }'

Create a new agent response A/B test.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
AgentResponseTestCreate

Request body for creating an agent response A/B test.

object
agent_role
required
Agent Role
string
>= 1 characters <= 100 characters
behavior_dimension
required
Behavior Dimension
string
>= 1 characters <= 100 characters
min_tenants
Min Tenants
integer
default: 50 >= 1
name
required
Name
string
>= 1 characters <= 255 characters
significance_threshold
Significance Threshold
number
default: 0.05 > 0 < 1
variants
required
Variants
Array<object>
AgentResponseVariantCreate

Request body for creating a response test variant.

object
config
Config
object
key
additional properties
any
name
required
Name
string
>= 1 characters <= 100 characters

Responses

Section titled “ Responses ”

201

Section titled “201”

Successful Response

Media typeapplication/json
AgentResponseTestResponse

Response body for an agent response A/B test.

object
agent_role
required
Agent Role
string
behavior_dimension
required
Behavior Dimension
string
concluded_at
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
id
required
Id
string format: uuid
min_tenants
required
Min Tenants
integer
name
required
Name
string
significance_threshold
required
Significance Threshold
number
status
required
Status
string
variants
required
Variants
Array<object>
AgentResponseVariantResponse

Response body for a single response test variant.

object
acceptance_count
required
Acceptance Count
integer
acceptance_rate
Acceptance Rate
number
0
config
required
Config
object
key
additional properties
any
id
required
Id
string format: uuid
name
required
Name
string
override_count
required
Override Count
integer
satisfaction_sum
required
Satisfaction Sum
number
tenant_count
required
Tenant Count
integer
winner_variant
Any of:
string
Example
{
  "variants": [
    {
      "acceptance_rate": 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"
    }
  ]
}