Update AI Config variation

PATCH

/api/v2/projects/:projectKey/ai-configs/:configKey/variations/:variationKey

PATCH

/api/v2/projects/:projectKey/ai-configs/:configKey/variations/:variationKey

$ curl -X PATCH https://app.launchdarkly.com/api/v2/projects/projectKey/ai-configs/configKey/variations/variationKey \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "comment": "comment",
>   "description": "description",
>   "instructions": "instructions",
>   "messages": [
>     {
>       "content": "content",
>       "role": "role"
>     },
>     {
>       "content": "content",
>       "role": "role"
>     }
>   ],
>   "model": "{}",
>   "modelConfigKey": "modelConfigKey",
>   "modelConfigVersion": 1,
>   "name": "name",
>   "outputFormat": {
>     "key": ""
>   },
>   "published": true,
>   "state": "state",
>   "tools": [
>     {
>       "key": "key",
>       "version": 6
>     },
>     {
>       "key": "key",
>       "version": 6
>     }
>   ],
>   "toolKeys": [
>     "toolKeys",
>     "toolKeys"
>   ],
>   "skills": [
>     {
>       "key": "key",
>       "version": 1
>     },
>     {
>       "key": "key",
>       "version": 1
>     }
>   ],
>   "judgeConfiguration": {
>     "judges": [
>       {
>         "judgeConfigKey": "judgeConfigKey",
>         "samplingRate": 0.36160767
>       },
>       {
>         "judgeConfigKey": "judgeConfigKey",
>         "samplingRate": 0.36160767
>       }
>     ]
>   }
> }'

1 {
2   "key": "key",
3   "_id": "_id",
4   "model": "{}",
5   "name": "name",
6   "createdAt": 1,
7   "version": 5,
8   "_links": {
9     "parent": {
10       "href": "href",
11       "type": "type"
12     }
13   },
14   "color": "color",
15   "comment": "comment",
16   "description": "description",
17   "instructions": "instructions",
18   "messages": [
19     {
20       "content": "content",
21       "role": "role"
22     },
23     {
24       "content": "content",
25       "role": "role"
26     }
27   ],
28   "modelConfigKey": "modelConfigKey",
29   "modelConfigVersion": 6,
30   "outputFormat": {
31     "key": ""
32   },
33   "state": "state",
34   "_archivedAt": 5,
35   "_publishedAt": 2,
36   "tools": [
37     {
38       "key": "key",
39       "version": 7,
40       "customParameters": {
41         "key": ""
42       }
43     },
44     {
45       "key": "key",
46       "version": 7,
47       "customParameters": {
48         "key": ""
49       }
50     }
51   ],
52   "skills": [
53     {
54       "key": "key",
55       "version": 9
56     },
57     {
58       "key": "key",
59       "version": 9
60     }
61   ],
62   "judgeConfiguration": {
63     "judges": [
64       {
65         "judgeConfigKey": "judgeConfigKey",
66         "samplingRate": 0.36160767
67       },
68       {
69         "judgeConfigKey": "judgeConfigKey",
70         "samplingRate": 0.36160767
71       }
72     ]
73   },
74   "judgingConfigKeys": [
75     "judgingConfigKeys",
76     "judgingConfigKeys"
77   ]
78 }

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

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

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequired

configKeystringRequired

variationKeystringRequired

Request

AI Config variation object to update

commentstringOptional

Human-readable description of what this patch changes

descriptionstringOptional

Description for agent when the config is in agent mode.

instructionsstringOptional

Instructions for agent when the config is in agent mode.

messageslist of objectsOptional

modelobjectOptional

modelConfigKeystringOptional

modelConfigVersionintegerOptional>=1

The exact model config version to set this variation to. Requires modelConfigKey to be set (either in this patch or already on the variation), and the version must exist for that model config. When omitted, the variation keeps the version it is currently set to, unless the patch changes modelConfigKey, in which case the variation records the new model config’s current (latest) version.

namestringOptional

outputFormatmap from strings to anyOptional

JSON Schema defining the structured output format for the variation.

publishedbooleanOptional

statestringOptional

One of 'archived', 'published'

toolslist of objectsOptional

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

toolKeyslist of stringsOptional

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

skillslist of objectsOptional

List of agent skills to attach to this variation. Replaces the current attachments.

judgeConfigurationobjectOptional

Response

AI Config variation updated

keystring

_idstring

modelobject

namestring

createdAtlong

versioninteger

_linksobjectOptional

colorstringOptional

commentstringOptional

descriptionstringOptional

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

instructionsstringOptional

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

messageslist of objectsOptional

modelConfigKeystringOptional

modelConfigVersionintegerOptional

The version of the model config that this variation is pinned to, when it references a custom model config. Absent when the variation does not reference a model config, when the variation is not pinned to a specific version, or when custom model config versioning is not enabled for the project.

outputFormatmap from strings to anyOptional

JSON Schema defining the structured output format for the variation.

statestringOptional

_archivedAtlongOptional

_publishedAtlongOptional

toolslist of objectsOptional

skillslist of objectsOptional

judgeConfigurationobjectOptional

judgingConfigKeyslist of stringsOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error