Sign in

v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB
AI Configs

Update AI Config variation

Edit an existing variation of an AI Config. This creates a new version of the variation.

The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields.

Here's an example:

  {
    "messages": [
      {
        "role": "system",
        "content": "The new message"
      }
    ]
  }
patch/api/v2/projects/{projectKey}/ai-configs/{configKey}/variations/{variationKey}

Path parameters

projectKeystring required
configKeystring required
variationKeystring required

Request body

commentstring

Human-readable description of what this patch changes

descriptionstring

Description for agent when AI Config is in agent mode.

instructionsstring

Instructions for agent when AI Config is in agent mode.

modelobject
modelConfigKeystring
namestring
publishedboolean
statestring

One of 'archived', 'published'

toolKeysstring[]

List of tool keys to use for this variation. The latest version of the tool will be used.

Example request

{
  "judgeConfiguration": {
    "judges": [
      {
        "samplingRate": 0.7061401,
        "judgeConfigKey": "judgeConfigKey"
      },
      {
        "samplingRate": 0.7061401,
        "judgeConfigKey": "judgeConfigKey"
      }
    ]
  },
  "instructions": "instructions",
  "toolKeys": [
    "toolKeys",
    "toolKeys"
  ],
  "name": "name",
  "description": "description",
  "messages": [
    {
      "role": "role",
      "content": "content"
    },
    {
      "role": "role",
      "content": "content"
    }
  ],
  "comment": "comment",
  "model": "{}",
  "published": true,
  "state": "state",
  "modelConfigKey": "modelConfigKey",
  "tools": [
    {
      "version": 0,
      "key": "key"
    },
    {
      "version": 0,
      "key": "key"
    }
  ]
}

Response

AI Config variation updated

colorstring
commentstring
descriptionstring

Returns the description for the agent. This is only returned for agent variations.

instructionsstring

Returns the instructions for the agent. This is only returned for agent variations.

keystring required
_idstring required
modelobject required
modelConfigKeystring
namestring required
createdAtinteger required
versioninteger required
statestring
_archivedAtinteger
_publishedAtinteger
judgingConfigKeysstring[]

Example response

{
  "judgeConfiguration": {
    "judges": [
      {
        "samplingRate": 0.7061401,
        "judgeConfigKey": "judgeConfigKey"
      },
      {
        "samplingRate": 0.7061401,
        "judgeConfigKey": "judgeConfigKey"
      }
    ]
  },
  "instructions": "instructions",
  "color": "color",
  "_links": {
    "parent": {
      "href": "href",
      "type": "type"
    }
  },
  "description": "description",
  "modelConfigKey": "modelConfigKey",
  "judgingConfigKeys": [
    "judgingConfigKeys",
    "judgingConfigKeys"
  ],
  "version": 1,
  "tools": [
    {
      "customParameters": {
        "key": ""
      },
      "version": 2,
      "key": "key"
    },
    {
      "customParameters": {
        "key": ""
      },
      "version": 2,
      "key": "key"
    }
  ],
  "createdAt": 6,
  "_publishedAt": 5,
  "_archivedAt": 5,
  "name": "name",
  "messages": [
    {
      "role": "role",
      "content": "content"
    },
    {
      "role": "role",
      "content": "content"
    }
  ],
  "comment": "comment",
  "model": "{}",
  "_id": "_id",
  "state": "state",
  "key": "key"
}