Skip to main content
POST
/
v0
/
experiments
/
{id}
/
variants
Create an experiment variant
curl --request POST \
  --url https://api.avidoai.com/v0/experiments/{id}/variants \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-application-id: <api-key>' \
  --data '
{
  "title": "Variant A",
  "description": "Adjust temperature and top_p",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "configPatch": {
    "temperature": 0.5
  }
}
'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "experimentId": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-05T12:34:56.789Z",
    "modifiedAt": "2024-01-05T12:34:56.789Z",
    "title": "Credit Card Block",
    "description": "Wants to block their credit card",
    "status": "DRAFT",
    "configPatch": {
      "temperature": 0.5
    },
    "parentId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

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

Example:

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

Body

application/json

Request body for creating a new experiment variant

​
title
string
required

The title of the variant

Required string length: 1 - 255
Example:

"Variant A"

​
description
string
required

The variant description

Example:

"Adjust temperature and top_p"

​
parentId
string<uuid>

Parent variant ID for inherited variants (non-baseline variants)

Example:

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

​
configPatch
object

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

Example:
{ "temperature": 0.5 }

Response

Successfully created experiment variant

Response containing a single experiment variant

​
data
object
required