Get AI Config

GET

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

GET

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

$ curl https://app.launchdarkly.com/api/v2/projects/projectKey/ai-configs/configKey \
>      -H "Authorization: <apiKey>"

1 {
2   "description": "description",
3   "key": "key",
4   "name": "name",
5   "tags": [
6     "tags",
7     "tags"
8   ],
9   "version": 0,
10   "variations": [
11     {
12       "key": "key",
13       "_id": "_id",
14       "model": "{}",
15       "name": "name",
16       "createdAt": 1,
17       "version": 5,
18       "_links": {
19         "parent": {
20           "href": "href",
21           "type": "type"
22         }
23       },
24       "color": "color",
25       "comment": "comment",
26       "description": "description",
27       "instructions": "instructions",
28       "messages": [
29         {
30           "content": "content",
31           "role": "role"
32         },
33         {
34           "content": "content",
35           "role": "role"
36         }
37       ],
38       "modelConfigKey": "modelConfigKey",
39       "modelConfigVersion": 6,
40       "outputFormat": {
41         "key": ""
42       },
43       "state": "state",
44       "_archivedAt": 5,
45       "_publishedAt": 2,
46       "tools": [
47         {
48           "key": "key",
49           "version": 7,
50           "customParameters": {
51             "key": ""
52           }
53         },
54         {
55           "key": "key",
56           "version": 7,
57           "customParameters": {
58             "key": ""
59           }
60         }
61       ],
62       "skills": [
63         {
64           "key": "key",
65           "version": 9
66         },
67         {
68           "key": "key",
69           "version": 9
70         }
71       ],
72       "judgeConfiguration": {
73         "judges": [
74           {
75             "judgeConfigKey": "judgeConfigKey",
76             "samplingRate": 0.36160767
77           },
78           {
79             "judgeConfigKey": "judgeConfigKey",
80             "samplingRate": 0.36160767
81           }
82         ]
83       },
84       "judgingConfigKeys": [
85         "judgingConfigKeys",
86         "judgingConfigKeys"
87       ]
88     },
89     {
90       "key": "key",
91       "_id": "_id",
92       "model": "{}",
93       "name": "name",
94       "createdAt": 1,
95       "version": 5,
96       "_links": {
97         "parent": {
98           "href": "href",
99           "type": "type"
100         }
101       },
102       "color": "color",
103       "comment": "comment",
104       "description": "description",
105       "instructions": "instructions",
106       "messages": [
107         {
108           "content": "content",
109           "role": "role"
110         },
111         {
112           "content": "content",
113           "role": "role"
114         }
115       ],
116       "modelConfigKey": "modelConfigKey",
117       "modelConfigVersion": 6,
118       "outputFormat": {
119         "key": ""
120       },
121       "state": "state",
122       "_archivedAt": 5,
123       "_publishedAt": 2,
124       "tools": [
125         {
126           "key": "key",
127           "version": 7,
128           "customParameters": {
129             "key": ""
130           }
131         },
132         {
133           "key": "key",
134           "version": 7,
135           "customParameters": {
136             "key": ""
137           }
138         }
139       ],
140       "skills": [
141         {
142           "key": "key",
143           "version": 9
144         },
145         {
146           "key": "key",
147           "version": 9
148         }
149       ],
150       "judgeConfiguration": {
151         "judges": [
152           {
153             "judgeConfigKey": "judgeConfigKey",
154             "samplingRate": 0.36160767
155           },
156           {
157             "judgeConfigKey": "judgeConfigKey",
158             "samplingRate": 0.36160767
159           }
160         ]
161       },
162       "judgingConfigKeys": [
163         "judgingConfigKeys",
164         "judgingConfigKeys"
165       ]
166     }
167   ],
168   "createdAt": 2,
169   "updatedAt": 4,
170   "_access": {
171     "denied": [
172       {
173         "action": "action",
174         "reason": {
175           "effect": "allow",
176           "resources": [
177             "proj/*:env/*;qa_*:/flag/*"
178           ],
179           "notResources": [
180             "notResources",
181             "notResources"
182           ],
183           "actions": [
184             "*"
185           ],
186           "notActions": [
187             "string",
188             "string"
189           ],
190           "role_name": "role_name"
191         }
192       },
193       {
194         "action": "action",
195         "reason": {
196           "effect": "allow",
197           "resources": [
198             "proj/*:env/*;qa_*:/flag/*"
199           ],
200           "notResources": [
201             "notResources",
202             "notResources"
203           ],
204           "actions": [
205             "*"
206           ],
207           "notActions": [
208             "string",
209             "string"
210           ],
211           "role_name": "role_name"
212         }
213       }
214     ],
215     "allowed": [
216       {
217         "action": "action",
218         "reason": {
219           "effect": "allow",
220           "resources": [
221             "proj/*:env/*;qa_*:/flag/*"
222           ],
223           "notResources": [
224             "notResources",
225             "notResources"
226           ],
227           "actions": [
228             "*"
229           ],
230           "notActions": [
231             "string",
232             "string"
233           ],
234           "role_name": "role_name"
235         }
236       },
237       {
238         "action": "action",
239         "reason": {
240           "effect": "allow",
241           "resources": [
242             "proj/*:env/*;qa_*:/flag/*"
243           ],
244           "notResources": [
245             "notResources",
246             "notResources"
247           ],
248           "actions": [
249             "*"
250           ],
251           "notActions": [
252             "string",
253             "string"
254           ],
255           "role_name": "role_name"
256         }
257       }
258     ]
259   },
260   "_links": {
261     "self": {
262       "href": "href",
263       "type": "type"
264     },
265     "parent": {
266       "href": "href",
267       "type": "type"
268     }
269   },
270   "_site": {
271     "href": "href",
272     "type": "type"
273   },
274   "_maintainer": {
275     "_id": "string",
276     "email": "string",
277     "kind": "kind",
278     "role": "string"
279   },
280   "mode": "completion",
281   "evaluationMetricKey": "evaluationMetricKey",
282   "isInverted": true,
283   "dependencies": [
284     {
285       "type": "agent-graph",
286       "key": "key"
287     },
288     {
289       "type": "agent-graph",
290       "key": "key"
291     }
292   ],
293   "evaluationMetricKeys": [
294     "evaluationMetricKeys",
295     "evaluationMetricKeys"
296   ]
297 }

Retrieve a specific AI Config by its key.

Authentication

Authorizationstring

API Key authentication via header

Path parameters

projectKeystringRequired

configKeystringRequired

Response

AI Config found

descriptionstring

keystring

namestring

tagslist of strings

versioninteger

variationslist of objects

createdAtlong

updatedAtlong

_accessobjectOptional

_linksobjectOptional

The location and content type of related resources

_siteobjectOptional

_maintainerobjectOptional

modeenumOptionalDefaults to completion

evaluationMetricKeystringOptional

Evaluation metric key for this config

isInvertedbooleanOptional

Whether the evaluation metric is inverted, meaning a lower value is better if set as true

dependencieslist of objectsOptional

Resources that depend on this config, grouped by type

evaluationMetricKeyslist of stringsOptionalDeprecated

List of evaluation metric keys for this config

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error