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 '
{
  "configPatch": {
    "llm": {
      "temperature": 0.5
    }
  },
  "title": "Variant A",
  "description": "Adjust temperature and top_p",
  "parentId": "123e4567-e89b-12d3-a456-426614174000"
}
'
{
  "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": {
      "llm": {
        "temperature": 0.5
      }
    },
    "config": {
      "llm": {
        "temperature": 0.5
      }
    },
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "result": {
      "passed": 1,
      "failed": 1,
      "total": 1,
      "passRate": 50,
      "evals": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "type": "NATURALNESS",
          "passed": 1,
          "failed": 1,
          "total": 1,
          "passRate": 50
        }
      ]
    }
  }
}

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

​
configPatch
object
required

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

Example:
{ "llm": { "temperature": 0.5 } }
​
title
string

The title of the variant

Example:

"Variant A"

​
description
string

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"

Response

Successfully created experiment variant

Response containing a single experiment variant

​
data
object
required