Skip to main content
PUT
Update experiment variant

Authorizations

x-api-key
string
header
required

Your unique Avido API key

x-application-id
string
header
required

Your unique Avido Application ID

Path Parameters

id
string<uuid>
required

The unique identifier of the experiment

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"123e4567-e89b-12d3-a456-426614174000"

variantId
string<uuid>
required

The unique identifier of the variant

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"321e4567-e89b-12d3-a456-426614174000"

Body

application/json

Request body for updating an experiment variant

title
string

Updated title of the variant

Maximum string length: 256
Example:

"Improved Variant"

description
string

Updated description of the variant

Maximum string length: 2048
Example:

"Switched to reasoning model with higher max_output_tokens"

status
enum<string>
Available options:
REJECTED
configPatch
object

The config patch to apply to the system, entire config if baseline

Example:

Response

Successfully updated experiment variant

Response containing a single experiment variant

data
object
required