Skip to content
UltimateTeam.ai Docs

Deterministic variant assignment for an onboarding session

POST
/api/v1/ux/ab-tests/{test_id}/assign
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/ux/ab-tests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/assign \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

UX-01: Assign an onboarding session to a variant deterministically via SHA-256 hashing. MUST return within 100ms.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
test_id
required
Test Id
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
VariantAssignmentRequest

Request body for POST /api/v1/ux/ab-tests/{test_id}/assign.

object
session_id
required
Session Id
string format: uuid
Examplegenerated
{
  "session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
VariantAssignmentResponse

Response body for POST /api/v1/ux/ab-tests/{test_id}/assign.

object
config
Config
object
key
additional properties
any
variant_id
required
Variant Id
string format: uuid
variant_name
required
Variant Name
string
Examplegenerated
{
  "config": {},
  "variant_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "variant_name": "example"
}

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