@volter/twin-openai 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -0
- package/README.md +168 -0
- package/package.json +62 -0
- package/src/cli.ts +26 -0
- package/src/index.ts +108 -0
- package/src/openai-budget.ts +173 -0
- package/src/openai-capabilities.ts +1556 -0
- package/src/openai-conformance.ts +112 -0
- package/src/openai-connector.ts +337 -0
- package/src/openai-models.ts +36 -0
- package/src/openai-scenario.ts +136 -0
- package/src/openai-server.ts +167 -0
- package/src/openai-stub.ts +247 -0
- package/src/openai-twin.ts +2100 -0
- package/src/openai-types.ts +126 -0
- package/src/openai-webhooks.ts +128 -0
- package/test-fixtures/openai-openapi-operations.SOURCE.md +19 -0
- package/test-fixtures/openai-openapi-operations.json +2959 -0
|
@@ -0,0 +1,2959 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.0.3",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "OpenAI API (spec-census scoped subset)",
|
|
5
|
+
"version": "2.3.0",
|
|
6
|
+
"description": "A scope-filtered SUBSET of the upstream spec (https://github.com/openai/openai-openapi), derived by scripts/spec-census-bootstrap.ts: every operation under the committed scopePaths, operation metadata only (operationId, summary, tags, first response) \u2014 schemas dropped so the fixture stays small and offline. It is ONLY the operation-inventory denominator for ../openai-spec-census.json; see openai-openapi-operations.SOURCE.md for provenance."
|
|
7
|
+
},
|
|
8
|
+
"servers": [
|
|
9
|
+
{
|
|
10
|
+
"url": "https://api.openai.com/v1"
|
|
11
|
+
}
|
|
12
|
+
],
|
|
13
|
+
"x-source": {
|
|
14
|
+
"vendor": "openai",
|
|
15
|
+
"upstream": "https://github.com/openai/openai-openapi",
|
|
16
|
+
"upstreamFile": "openapi.yaml",
|
|
17
|
+
"vendored": "derived by scripts/spec-census-bootstrap.ts from openapi.yaml fetched 2026-09-02 \u2014 scope-filtered to scopePaths, schemas dropped; 6 query-string path variant(s) (e.g. /responses?beta=true) folded into their base path",
|
|
18
|
+
"curatedOn": "2026-09-02",
|
|
19
|
+
"scope": "/assistants, /audio, /batches, /chat/, /containers, /embeddings, /evals, /files, /fine_tuning, /images, /models, /moderations, /organization, /responses, /threads, /uploads, /vector_stores"
|
|
20
|
+
},
|
|
21
|
+
"paths": {
|
|
22
|
+
"/assistants": {
|
|
23
|
+
"get": {
|
|
24
|
+
"operationId": "listAssistants",
|
|
25
|
+
"summary": "Returns a list of assistants.",
|
|
26
|
+
"tags": [
|
|
27
|
+
"Assistants"
|
|
28
|
+
],
|
|
29
|
+
"responses": {
|
|
30
|
+
"200": {
|
|
31
|
+
"description": "OK"
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
"post": {
|
|
36
|
+
"operationId": "createAssistant",
|
|
37
|
+
"summary": "Create an assistant with a model and instructions.",
|
|
38
|
+
"tags": [
|
|
39
|
+
"Assistants"
|
|
40
|
+
],
|
|
41
|
+
"responses": {
|
|
42
|
+
"200": {
|
|
43
|
+
"description": "OK"
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
},
|
|
48
|
+
"/assistants/{assistant_id}": {
|
|
49
|
+
"delete": {
|
|
50
|
+
"operationId": "deleteAssistant",
|
|
51
|
+
"summary": "Delete an assistant.",
|
|
52
|
+
"tags": [
|
|
53
|
+
"Assistants"
|
|
54
|
+
],
|
|
55
|
+
"responses": {
|
|
56
|
+
"200": {
|
|
57
|
+
"description": "OK"
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
},
|
|
61
|
+
"get": {
|
|
62
|
+
"operationId": "getAssistant",
|
|
63
|
+
"summary": "Retrieves an assistant.",
|
|
64
|
+
"tags": [
|
|
65
|
+
"Assistants"
|
|
66
|
+
],
|
|
67
|
+
"responses": {
|
|
68
|
+
"200": {
|
|
69
|
+
"description": "OK"
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
},
|
|
73
|
+
"post": {
|
|
74
|
+
"operationId": "modifyAssistant",
|
|
75
|
+
"summary": "Modifies an assistant.",
|
|
76
|
+
"tags": [
|
|
77
|
+
"Assistants"
|
|
78
|
+
],
|
|
79
|
+
"responses": {
|
|
80
|
+
"200": {
|
|
81
|
+
"description": "OK"
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
},
|
|
86
|
+
"/audio/speech": {
|
|
87
|
+
"post": {
|
|
88
|
+
"operationId": "createSpeech",
|
|
89
|
+
"summary": "Generates audio from the input text.",
|
|
90
|
+
"tags": [
|
|
91
|
+
"Audio"
|
|
92
|
+
],
|
|
93
|
+
"responses": {
|
|
94
|
+
"200": {
|
|
95
|
+
"description": "OK"
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
},
|
|
100
|
+
"/audio/transcriptions": {
|
|
101
|
+
"post": {
|
|
102
|
+
"operationId": "createTranscription",
|
|
103
|
+
"summary": "Transcribes audio into the input language.",
|
|
104
|
+
"tags": [
|
|
105
|
+
"Audio"
|
|
106
|
+
],
|
|
107
|
+
"responses": {
|
|
108
|
+
"200": {
|
|
109
|
+
"description": "OK"
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
},
|
|
114
|
+
"/audio/translations": {
|
|
115
|
+
"post": {
|
|
116
|
+
"operationId": "createTranslation",
|
|
117
|
+
"summary": "Translates audio into English.",
|
|
118
|
+
"tags": [
|
|
119
|
+
"Audio"
|
|
120
|
+
],
|
|
121
|
+
"responses": {
|
|
122
|
+
"200": {
|
|
123
|
+
"description": "OK"
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
},
|
|
128
|
+
"/audio/voice_consents": {
|
|
129
|
+
"get": {
|
|
130
|
+
"operationId": "listVoiceConsents",
|
|
131
|
+
"summary": "Returns a list of voice consent recordings.",
|
|
132
|
+
"tags": [
|
|
133
|
+
"Audio"
|
|
134
|
+
],
|
|
135
|
+
"responses": {
|
|
136
|
+
"200": {
|
|
137
|
+
"description": "OK"
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
},
|
|
141
|
+
"post": {
|
|
142
|
+
"operationId": "createVoiceConsent",
|
|
143
|
+
"summary": "Upload a voice consent recording.",
|
|
144
|
+
"tags": [
|
|
145
|
+
"Audio"
|
|
146
|
+
],
|
|
147
|
+
"responses": {
|
|
148
|
+
"200": {
|
|
149
|
+
"description": "OK"
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
},
|
|
154
|
+
"/audio/voice_consents/{consent_id}": {
|
|
155
|
+
"delete": {
|
|
156
|
+
"operationId": "deleteVoiceConsent",
|
|
157
|
+
"summary": "Deletes a voice consent recording.",
|
|
158
|
+
"tags": [
|
|
159
|
+
"Audio"
|
|
160
|
+
],
|
|
161
|
+
"responses": {
|
|
162
|
+
"200": {
|
|
163
|
+
"description": "OK"
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
},
|
|
167
|
+
"get": {
|
|
168
|
+
"operationId": "getVoiceConsent",
|
|
169
|
+
"summary": "Retrieves a voice consent recording.",
|
|
170
|
+
"tags": [
|
|
171
|
+
"Audio"
|
|
172
|
+
],
|
|
173
|
+
"responses": {
|
|
174
|
+
"200": {
|
|
175
|
+
"description": "OK"
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
},
|
|
179
|
+
"post": {
|
|
180
|
+
"operationId": "updateVoiceConsent",
|
|
181
|
+
"summary": "Updates a voice consent recording (metadata only).",
|
|
182
|
+
"tags": [
|
|
183
|
+
"Audio"
|
|
184
|
+
],
|
|
185
|
+
"responses": {
|
|
186
|
+
"200": {
|
|
187
|
+
"description": "OK"
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
},
|
|
192
|
+
"/audio/voices": {
|
|
193
|
+
"post": {
|
|
194
|
+
"operationId": "createVoice",
|
|
195
|
+
"summary": "Creates a custom voice.",
|
|
196
|
+
"tags": [
|
|
197
|
+
"Audio"
|
|
198
|
+
],
|
|
199
|
+
"responses": {
|
|
200
|
+
"200": {
|
|
201
|
+
"description": "OK"
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
},
|
|
206
|
+
"/batches": {
|
|
207
|
+
"get": {
|
|
208
|
+
"operationId": "listBatches",
|
|
209
|
+
"summary": "List your organization's batches.",
|
|
210
|
+
"tags": [
|
|
211
|
+
"Batch"
|
|
212
|
+
],
|
|
213
|
+
"responses": {
|
|
214
|
+
"200": {
|
|
215
|
+
"description": "Batch listed successfully."
|
|
216
|
+
}
|
|
217
|
+
}
|
|
218
|
+
},
|
|
219
|
+
"post": {
|
|
220
|
+
"operationId": "createBatch",
|
|
221
|
+
"summary": "Creates and executes a batch from an uploaded file of requests",
|
|
222
|
+
"tags": [
|
|
223
|
+
"Batch"
|
|
224
|
+
],
|
|
225
|
+
"responses": {
|
|
226
|
+
"200": {
|
|
227
|
+
"description": "Batch created successfully."
|
|
228
|
+
}
|
|
229
|
+
}
|
|
230
|
+
}
|
|
231
|
+
},
|
|
232
|
+
"/batches/{batch_id}": {
|
|
233
|
+
"get": {
|
|
234
|
+
"operationId": "retrieveBatch",
|
|
235
|
+
"summary": "Retrieves a batch.",
|
|
236
|
+
"tags": [
|
|
237
|
+
"Batch"
|
|
238
|
+
],
|
|
239
|
+
"responses": {
|
|
240
|
+
"200": {
|
|
241
|
+
"description": "Batch retrieved successfully."
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
},
|
|
246
|
+
"/batches/{batch_id}/cancel": {
|
|
247
|
+
"post": {
|
|
248
|
+
"operationId": "cancelBatch",
|
|
249
|
+
"summary": "Cancels an in-progress batch",
|
|
250
|
+
"tags": [
|
|
251
|
+
"Batch"
|
|
252
|
+
],
|
|
253
|
+
"responses": {
|
|
254
|
+
"200": {
|
|
255
|
+
"description": "Batch is cancelling. Returns the cancelling batch's details."
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
},
|
|
260
|
+
"/chat/completions": {
|
|
261
|
+
"get": {
|
|
262
|
+
"operationId": "listChatCompletions",
|
|
263
|
+
"summary": "List stored Chat Completions",
|
|
264
|
+
"tags": [
|
|
265
|
+
"Chat"
|
|
266
|
+
],
|
|
267
|
+
"responses": {
|
|
268
|
+
"200": {
|
|
269
|
+
"description": "A list of Chat Completions"
|
|
270
|
+
}
|
|
271
|
+
}
|
|
272
|
+
},
|
|
273
|
+
"post": {
|
|
274
|
+
"operationId": "createChatCompletion",
|
|
275
|
+
"summary": "**Starting a new project?** We recommend trying [Responses](/docs/api-reference/responses)",
|
|
276
|
+
"tags": [
|
|
277
|
+
"Chat"
|
|
278
|
+
],
|
|
279
|
+
"responses": {
|
|
280
|
+
"200": {
|
|
281
|
+
"description": "OK"
|
|
282
|
+
}
|
|
283
|
+
}
|
|
284
|
+
}
|
|
285
|
+
},
|
|
286
|
+
"/chat/completions/{completion_id}": {
|
|
287
|
+
"delete": {
|
|
288
|
+
"operationId": "deleteChatCompletion",
|
|
289
|
+
"summary": "Delete a stored chat completion",
|
|
290
|
+
"tags": [
|
|
291
|
+
"Chat"
|
|
292
|
+
],
|
|
293
|
+
"responses": {
|
|
294
|
+
"200": {
|
|
295
|
+
"description": "The chat completion was deleted successfully."
|
|
296
|
+
}
|
|
297
|
+
}
|
|
298
|
+
},
|
|
299
|
+
"get": {
|
|
300
|
+
"operationId": "getChatCompletion",
|
|
301
|
+
"summary": "Get a stored chat completion",
|
|
302
|
+
"tags": [
|
|
303
|
+
"Chat"
|
|
304
|
+
],
|
|
305
|
+
"responses": {
|
|
306
|
+
"200": {
|
|
307
|
+
"description": "A chat completion"
|
|
308
|
+
}
|
|
309
|
+
}
|
|
310
|
+
},
|
|
311
|
+
"post": {
|
|
312
|
+
"operationId": "updateChatCompletion",
|
|
313
|
+
"summary": "Modify a stored chat completion",
|
|
314
|
+
"tags": [
|
|
315
|
+
"Chat"
|
|
316
|
+
],
|
|
317
|
+
"responses": {
|
|
318
|
+
"200": {
|
|
319
|
+
"description": "A chat completion"
|
|
320
|
+
}
|
|
321
|
+
}
|
|
322
|
+
}
|
|
323
|
+
},
|
|
324
|
+
"/chat/completions/{completion_id}/messages": {
|
|
325
|
+
"get": {
|
|
326
|
+
"operationId": "getChatCompletionMessages",
|
|
327
|
+
"summary": "Get the messages in a stored chat completion",
|
|
328
|
+
"tags": [
|
|
329
|
+
"Chat"
|
|
330
|
+
],
|
|
331
|
+
"responses": {
|
|
332
|
+
"200": {
|
|
333
|
+
"description": "A list of messages"
|
|
334
|
+
}
|
|
335
|
+
}
|
|
336
|
+
}
|
|
337
|
+
},
|
|
338
|
+
"/containers": {
|
|
339
|
+
"get": {
|
|
340
|
+
"operationId": "ListContainers",
|
|
341
|
+
"summary": "List Containers",
|
|
342
|
+
"tags": [
|
|
343
|
+
"containers"
|
|
344
|
+
],
|
|
345
|
+
"responses": {
|
|
346
|
+
"200": {
|
|
347
|
+
"description": "Success"
|
|
348
|
+
}
|
|
349
|
+
}
|
|
350
|
+
},
|
|
351
|
+
"post": {
|
|
352
|
+
"operationId": "CreateContainer",
|
|
353
|
+
"summary": "Create Container",
|
|
354
|
+
"tags": [
|
|
355
|
+
"containers"
|
|
356
|
+
],
|
|
357
|
+
"responses": {
|
|
358
|
+
"200": {
|
|
359
|
+
"description": "Success"
|
|
360
|
+
}
|
|
361
|
+
}
|
|
362
|
+
}
|
|
363
|
+
},
|
|
364
|
+
"/containers/{container_id}": {
|
|
365
|
+
"delete": {
|
|
366
|
+
"operationId": "DeleteContainer",
|
|
367
|
+
"summary": "Delete Container",
|
|
368
|
+
"tags": [
|
|
369
|
+
"containers"
|
|
370
|
+
],
|
|
371
|
+
"responses": {
|
|
372
|
+
"200": {
|
|
373
|
+
"description": "OK"
|
|
374
|
+
}
|
|
375
|
+
}
|
|
376
|
+
},
|
|
377
|
+
"get": {
|
|
378
|
+
"operationId": "RetrieveContainer",
|
|
379
|
+
"summary": "Retrieve Container",
|
|
380
|
+
"tags": [
|
|
381
|
+
"containers"
|
|
382
|
+
],
|
|
383
|
+
"responses": {
|
|
384
|
+
"200": {
|
|
385
|
+
"description": "Success"
|
|
386
|
+
}
|
|
387
|
+
}
|
|
388
|
+
}
|
|
389
|
+
},
|
|
390
|
+
"/containers/{container_id}/files": {
|
|
391
|
+
"get": {
|
|
392
|
+
"operationId": "ListContainerFiles",
|
|
393
|
+
"summary": "List Container files",
|
|
394
|
+
"tags": [
|
|
395
|
+
"containers"
|
|
396
|
+
],
|
|
397
|
+
"responses": {
|
|
398
|
+
"200": {
|
|
399
|
+
"description": "Success"
|
|
400
|
+
}
|
|
401
|
+
}
|
|
402
|
+
},
|
|
403
|
+
"post": {
|
|
404
|
+
"operationId": "CreateContainerFile",
|
|
405
|
+
"summary": "Create a Container File",
|
|
406
|
+
"tags": [
|
|
407
|
+
"containers"
|
|
408
|
+
],
|
|
409
|
+
"responses": {
|
|
410
|
+
"200": {
|
|
411
|
+
"description": "Success"
|
|
412
|
+
}
|
|
413
|
+
}
|
|
414
|
+
}
|
|
415
|
+
},
|
|
416
|
+
"/containers/{container_id}/files/{file_id}": {
|
|
417
|
+
"delete": {
|
|
418
|
+
"operationId": "DeleteContainerFile",
|
|
419
|
+
"summary": "Delete Container File",
|
|
420
|
+
"tags": [
|
|
421
|
+
"containers"
|
|
422
|
+
],
|
|
423
|
+
"responses": {
|
|
424
|
+
"200": {
|
|
425
|
+
"description": "OK"
|
|
426
|
+
}
|
|
427
|
+
}
|
|
428
|
+
},
|
|
429
|
+
"get": {
|
|
430
|
+
"operationId": "RetrieveContainerFile",
|
|
431
|
+
"summary": "Retrieve Container File",
|
|
432
|
+
"tags": [
|
|
433
|
+
"containers"
|
|
434
|
+
],
|
|
435
|
+
"responses": {
|
|
436
|
+
"200": {
|
|
437
|
+
"description": "Success"
|
|
438
|
+
}
|
|
439
|
+
}
|
|
440
|
+
}
|
|
441
|
+
},
|
|
442
|
+
"/containers/{container_id}/files/{file_id}/content": {
|
|
443
|
+
"get": {
|
|
444
|
+
"operationId": "RetrieveContainerFileContent",
|
|
445
|
+
"summary": "Retrieve Container File Content",
|
|
446
|
+
"tags": [
|
|
447
|
+
"containers"
|
|
448
|
+
],
|
|
449
|
+
"responses": {
|
|
450
|
+
"200": {
|
|
451
|
+
"description": "Success"
|
|
452
|
+
}
|
|
453
|
+
}
|
|
454
|
+
}
|
|
455
|
+
},
|
|
456
|
+
"/embeddings": {
|
|
457
|
+
"post": {
|
|
458
|
+
"operationId": "createEmbedding",
|
|
459
|
+
"summary": "Creates an embedding vector representing the input text.",
|
|
460
|
+
"tags": [
|
|
461
|
+
"Embeddings"
|
|
462
|
+
],
|
|
463
|
+
"responses": {
|
|
464
|
+
"200": {
|
|
465
|
+
"description": "OK"
|
|
466
|
+
}
|
|
467
|
+
}
|
|
468
|
+
}
|
|
469
|
+
},
|
|
470
|
+
"/evals": {
|
|
471
|
+
"get": {
|
|
472
|
+
"operationId": "listEvals",
|
|
473
|
+
"summary": "List evaluations for a project.",
|
|
474
|
+
"tags": [
|
|
475
|
+
"Evals"
|
|
476
|
+
],
|
|
477
|
+
"responses": {
|
|
478
|
+
"200": {
|
|
479
|
+
"description": "A list of evals"
|
|
480
|
+
}
|
|
481
|
+
}
|
|
482
|
+
},
|
|
483
|
+
"post": {
|
|
484
|
+
"operationId": "createEval",
|
|
485
|
+
"summary": "Create the structure of an evaluation that can be used to test a model's performance.",
|
|
486
|
+
"tags": [
|
|
487
|
+
"Evals"
|
|
488
|
+
],
|
|
489
|
+
"responses": {
|
|
490
|
+
"201": {
|
|
491
|
+
"description": "OK"
|
|
492
|
+
}
|
|
493
|
+
}
|
|
494
|
+
}
|
|
495
|
+
},
|
|
496
|
+
"/evals/{eval_id}": {
|
|
497
|
+
"delete": {
|
|
498
|
+
"operationId": "deleteEval",
|
|
499
|
+
"summary": "Delete an evaluation.",
|
|
500
|
+
"tags": [
|
|
501
|
+
"Evals"
|
|
502
|
+
],
|
|
503
|
+
"responses": {
|
|
504
|
+
"200": {
|
|
505
|
+
"description": "Successfully deleted the evaluation."
|
|
506
|
+
}
|
|
507
|
+
}
|
|
508
|
+
},
|
|
509
|
+
"get": {
|
|
510
|
+
"operationId": "getEval",
|
|
511
|
+
"summary": "Get an evaluation by ID.",
|
|
512
|
+
"tags": [
|
|
513
|
+
"Evals"
|
|
514
|
+
],
|
|
515
|
+
"responses": {
|
|
516
|
+
"200": {
|
|
517
|
+
"description": "The evaluation"
|
|
518
|
+
}
|
|
519
|
+
}
|
|
520
|
+
},
|
|
521
|
+
"post": {
|
|
522
|
+
"operationId": "updateEval",
|
|
523
|
+
"summary": "Update certain properties of an evaluation.",
|
|
524
|
+
"tags": [
|
|
525
|
+
"Evals"
|
|
526
|
+
],
|
|
527
|
+
"responses": {
|
|
528
|
+
"200": {
|
|
529
|
+
"description": "The updated evaluation"
|
|
530
|
+
}
|
|
531
|
+
}
|
|
532
|
+
}
|
|
533
|
+
},
|
|
534
|
+
"/evals/{eval_id}/runs": {
|
|
535
|
+
"get": {
|
|
536
|
+
"operationId": "getEvalRuns",
|
|
537
|
+
"summary": "Get a list of runs for an evaluation.",
|
|
538
|
+
"tags": [
|
|
539
|
+
"Evals"
|
|
540
|
+
],
|
|
541
|
+
"responses": {
|
|
542
|
+
"200": {
|
|
543
|
+
"description": "A list of runs for the evaluation"
|
|
544
|
+
}
|
|
545
|
+
}
|
|
546
|
+
},
|
|
547
|
+
"post": {
|
|
548
|
+
"operationId": "createEvalRun",
|
|
549
|
+
"summary": "Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test",
|
|
550
|
+
"tags": [
|
|
551
|
+
"Evals"
|
|
552
|
+
],
|
|
553
|
+
"responses": {
|
|
554
|
+
"201": {
|
|
555
|
+
"description": "Successfully created a run for the evaluation"
|
|
556
|
+
}
|
|
557
|
+
}
|
|
558
|
+
}
|
|
559
|
+
},
|
|
560
|
+
"/evals/{eval_id}/runs/{run_id}": {
|
|
561
|
+
"delete": {
|
|
562
|
+
"operationId": "deleteEvalRun",
|
|
563
|
+
"summary": "Delete an eval run.",
|
|
564
|
+
"tags": [
|
|
565
|
+
"Evals"
|
|
566
|
+
],
|
|
567
|
+
"responses": {
|
|
568
|
+
"200": {
|
|
569
|
+
"description": "Successfully deleted the eval run"
|
|
570
|
+
}
|
|
571
|
+
}
|
|
572
|
+
},
|
|
573
|
+
"get": {
|
|
574
|
+
"operationId": "getEvalRun",
|
|
575
|
+
"summary": "Get an evaluation run by ID.",
|
|
576
|
+
"tags": [
|
|
577
|
+
"Evals"
|
|
578
|
+
],
|
|
579
|
+
"responses": {
|
|
580
|
+
"200": {
|
|
581
|
+
"description": "The evaluation run"
|
|
582
|
+
}
|
|
583
|
+
}
|
|
584
|
+
},
|
|
585
|
+
"post": {
|
|
586
|
+
"operationId": "cancelEvalRun",
|
|
587
|
+
"summary": "Cancel an ongoing evaluation run.",
|
|
588
|
+
"tags": [
|
|
589
|
+
"Evals"
|
|
590
|
+
],
|
|
591
|
+
"responses": {
|
|
592
|
+
"200": {
|
|
593
|
+
"description": "The canceled eval run object"
|
|
594
|
+
}
|
|
595
|
+
}
|
|
596
|
+
}
|
|
597
|
+
},
|
|
598
|
+
"/evals/{eval_id}/runs/{run_id}/output_items": {
|
|
599
|
+
"get": {
|
|
600
|
+
"operationId": "getEvalRunOutputItems",
|
|
601
|
+
"summary": "Get a list of output items for an evaluation run.",
|
|
602
|
+
"tags": [
|
|
603
|
+
"Evals"
|
|
604
|
+
],
|
|
605
|
+
"responses": {
|
|
606
|
+
"200": {
|
|
607
|
+
"description": "A list of output items for the evaluation run"
|
|
608
|
+
}
|
|
609
|
+
}
|
|
610
|
+
}
|
|
611
|
+
},
|
|
612
|
+
"/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}": {
|
|
613
|
+
"get": {
|
|
614
|
+
"operationId": "getEvalRunOutputItem",
|
|
615
|
+
"summary": "Get an evaluation run output item by ID.",
|
|
616
|
+
"tags": [
|
|
617
|
+
"Evals"
|
|
618
|
+
],
|
|
619
|
+
"responses": {
|
|
620
|
+
"200": {
|
|
621
|
+
"description": "The evaluation run output item"
|
|
622
|
+
}
|
|
623
|
+
}
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
"/files": {
|
|
627
|
+
"get": {
|
|
628
|
+
"operationId": "listFiles",
|
|
629
|
+
"summary": "Returns a list of files.",
|
|
630
|
+
"tags": [
|
|
631
|
+
"Files"
|
|
632
|
+
],
|
|
633
|
+
"responses": {
|
|
634
|
+
"200": {
|
|
635
|
+
"description": "OK"
|
|
636
|
+
}
|
|
637
|
+
}
|
|
638
|
+
},
|
|
639
|
+
"post": {
|
|
640
|
+
"operationId": "createFile",
|
|
641
|
+
"summary": "Upload a file that can be used across various endpoints",
|
|
642
|
+
"tags": [
|
|
643
|
+
"Files"
|
|
644
|
+
],
|
|
645
|
+
"responses": {
|
|
646
|
+
"200": {
|
|
647
|
+
"description": "OK"
|
|
648
|
+
}
|
|
649
|
+
}
|
|
650
|
+
}
|
|
651
|
+
},
|
|
652
|
+
"/files/{file_id}": {
|
|
653
|
+
"delete": {
|
|
654
|
+
"operationId": "deleteFile",
|
|
655
|
+
"summary": "Delete a file and remove it from all vector stores.",
|
|
656
|
+
"tags": [
|
|
657
|
+
"Files"
|
|
658
|
+
],
|
|
659
|
+
"responses": {
|
|
660
|
+
"200": {
|
|
661
|
+
"description": "OK"
|
|
662
|
+
}
|
|
663
|
+
}
|
|
664
|
+
},
|
|
665
|
+
"get": {
|
|
666
|
+
"operationId": "retrieveFile",
|
|
667
|
+
"summary": "Returns information about a specific file.",
|
|
668
|
+
"tags": [
|
|
669
|
+
"Files"
|
|
670
|
+
],
|
|
671
|
+
"responses": {
|
|
672
|
+
"200": {
|
|
673
|
+
"description": "OK"
|
|
674
|
+
}
|
|
675
|
+
}
|
|
676
|
+
}
|
|
677
|
+
},
|
|
678
|
+
"/files/{file_id}/content": {
|
|
679
|
+
"get": {
|
|
680
|
+
"operationId": "downloadFile",
|
|
681
|
+
"summary": "Returns a response containing the contents of the specified file.",
|
|
682
|
+
"tags": [
|
|
683
|
+
"Files"
|
|
684
|
+
],
|
|
685
|
+
"responses": {
|
|
686
|
+
"200": {
|
|
687
|
+
"description": "OK"
|
|
688
|
+
}
|
|
689
|
+
}
|
|
690
|
+
}
|
|
691
|
+
},
|
|
692
|
+
"/fine_tuning/alpha/graders/run": {
|
|
693
|
+
"post": {
|
|
694
|
+
"operationId": "runGrader",
|
|
695
|
+
"summary": "Run a grader.",
|
|
696
|
+
"tags": [
|
|
697
|
+
"Fine-tuning"
|
|
698
|
+
],
|
|
699
|
+
"responses": {
|
|
700
|
+
"200": {
|
|
701
|
+
"description": "OK"
|
|
702
|
+
}
|
|
703
|
+
}
|
|
704
|
+
}
|
|
705
|
+
},
|
|
706
|
+
"/fine_tuning/alpha/graders/validate": {
|
|
707
|
+
"post": {
|
|
708
|
+
"operationId": "validateGrader",
|
|
709
|
+
"summary": "Validate a grader.",
|
|
710
|
+
"tags": [
|
|
711
|
+
"Fine-tuning"
|
|
712
|
+
],
|
|
713
|
+
"responses": {
|
|
714
|
+
"200": {
|
|
715
|
+
"description": "OK"
|
|
716
|
+
}
|
|
717
|
+
}
|
|
718
|
+
}
|
|
719
|
+
},
|
|
720
|
+
"/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions": {
|
|
721
|
+
"get": {
|
|
722
|
+
"operationId": "listFineTuningCheckpointPermissions",
|
|
723
|
+
"summary": "**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).",
|
|
724
|
+
"tags": [
|
|
725
|
+
"Fine-tuning"
|
|
726
|
+
],
|
|
727
|
+
"responses": {
|
|
728
|
+
"200": {
|
|
729
|
+
"description": "OK"
|
|
730
|
+
}
|
|
731
|
+
}
|
|
732
|
+
},
|
|
733
|
+
"post": {
|
|
734
|
+
"operationId": "createFineTuningCheckpointPermission",
|
|
735
|
+
"summary": "**NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).",
|
|
736
|
+
"tags": [
|
|
737
|
+
"Fine-tuning"
|
|
738
|
+
],
|
|
739
|
+
"responses": {
|
|
740
|
+
"200": {
|
|
741
|
+
"description": "OK"
|
|
742
|
+
}
|
|
743
|
+
}
|
|
744
|
+
}
|
|
745
|
+
},
|
|
746
|
+
"/fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}": {
|
|
747
|
+
"delete": {
|
|
748
|
+
"operationId": "deleteFineTuningCheckpointPermission",
|
|
749
|
+
"summary": "**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).",
|
|
750
|
+
"tags": [
|
|
751
|
+
"Fine-tuning"
|
|
752
|
+
],
|
|
753
|
+
"responses": {
|
|
754
|
+
"200": {
|
|
755
|
+
"description": "OK"
|
|
756
|
+
}
|
|
757
|
+
}
|
|
758
|
+
}
|
|
759
|
+
},
|
|
760
|
+
"/fine_tuning/jobs": {
|
|
761
|
+
"get": {
|
|
762
|
+
"operationId": "listPaginatedFineTuningJobs",
|
|
763
|
+
"summary": "List your organization's fine-tuning jobs",
|
|
764
|
+
"tags": [
|
|
765
|
+
"Fine-tuning"
|
|
766
|
+
],
|
|
767
|
+
"responses": {
|
|
768
|
+
"200": {
|
|
769
|
+
"description": "OK"
|
|
770
|
+
}
|
|
771
|
+
}
|
|
772
|
+
},
|
|
773
|
+
"post": {
|
|
774
|
+
"operationId": "createFineTuningJob",
|
|
775
|
+
"summary": "Creates a fine-tuning job which begins the process of creating a new model from a given dataset.",
|
|
776
|
+
"tags": [
|
|
777
|
+
"Fine-tuning"
|
|
778
|
+
],
|
|
779
|
+
"responses": {
|
|
780
|
+
"200": {
|
|
781
|
+
"description": "OK"
|
|
782
|
+
}
|
|
783
|
+
}
|
|
784
|
+
}
|
|
785
|
+
},
|
|
786
|
+
"/fine_tuning/jobs/{fine_tuning_job_id}": {
|
|
787
|
+
"get": {
|
|
788
|
+
"operationId": "retrieveFineTuningJob",
|
|
789
|
+
"summary": "Get info about a fine-tuning job.",
|
|
790
|
+
"tags": [
|
|
791
|
+
"Fine-tuning"
|
|
792
|
+
],
|
|
793
|
+
"responses": {
|
|
794
|
+
"200": {
|
|
795
|
+
"description": "OK"
|
|
796
|
+
}
|
|
797
|
+
}
|
|
798
|
+
}
|
|
799
|
+
},
|
|
800
|
+
"/fine_tuning/jobs/{fine_tuning_job_id}/cancel": {
|
|
801
|
+
"post": {
|
|
802
|
+
"operationId": "cancelFineTuningJob",
|
|
803
|
+
"summary": "Immediately cancel a fine-tune job.",
|
|
804
|
+
"tags": [
|
|
805
|
+
"Fine-tuning"
|
|
806
|
+
],
|
|
807
|
+
"responses": {
|
|
808
|
+
"200": {
|
|
809
|
+
"description": "OK"
|
|
810
|
+
}
|
|
811
|
+
}
|
|
812
|
+
}
|
|
813
|
+
},
|
|
814
|
+
"/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints": {
|
|
815
|
+
"get": {
|
|
816
|
+
"operationId": "listFineTuningJobCheckpoints",
|
|
817
|
+
"summary": "List checkpoints for a fine-tuning job.",
|
|
818
|
+
"tags": [
|
|
819
|
+
"Fine-tuning"
|
|
820
|
+
],
|
|
821
|
+
"responses": {
|
|
822
|
+
"200": {
|
|
823
|
+
"description": "OK"
|
|
824
|
+
}
|
|
825
|
+
}
|
|
826
|
+
}
|
|
827
|
+
},
|
|
828
|
+
"/fine_tuning/jobs/{fine_tuning_job_id}/events": {
|
|
829
|
+
"get": {
|
|
830
|
+
"operationId": "listFineTuningEvents",
|
|
831
|
+
"summary": "Get status updates for a fine-tuning job.",
|
|
832
|
+
"tags": [
|
|
833
|
+
"Fine-tuning"
|
|
834
|
+
],
|
|
835
|
+
"responses": {
|
|
836
|
+
"200": {
|
|
837
|
+
"description": "OK"
|
|
838
|
+
}
|
|
839
|
+
}
|
|
840
|
+
}
|
|
841
|
+
},
|
|
842
|
+
"/fine_tuning/jobs/{fine_tuning_job_id}/pause": {
|
|
843
|
+
"post": {
|
|
844
|
+
"operationId": "pauseFineTuningJob",
|
|
845
|
+
"summary": "Pause a fine-tune job.",
|
|
846
|
+
"tags": [
|
|
847
|
+
"Fine-tuning"
|
|
848
|
+
],
|
|
849
|
+
"responses": {
|
|
850
|
+
"200": {
|
|
851
|
+
"description": "OK"
|
|
852
|
+
}
|
|
853
|
+
}
|
|
854
|
+
}
|
|
855
|
+
},
|
|
856
|
+
"/fine_tuning/jobs/{fine_tuning_job_id}/resume": {
|
|
857
|
+
"post": {
|
|
858
|
+
"operationId": "resumeFineTuningJob",
|
|
859
|
+
"summary": "Resume a fine-tune job.",
|
|
860
|
+
"tags": [
|
|
861
|
+
"Fine-tuning"
|
|
862
|
+
],
|
|
863
|
+
"responses": {
|
|
864
|
+
"200": {
|
|
865
|
+
"description": "OK"
|
|
866
|
+
}
|
|
867
|
+
}
|
|
868
|
+
}
|
|
869
|
+
},
|
|
870
|
+
"/images/edits": {
|
|
871
|
+
"post": {
|
|
872
|
+
"operationId": "createImageEdit",
|
|
873
|
+
"summary": "Creates an edited or extended image given one or more source images and a prompt",
|
|
874
|
+
"tags": [
|
|
875
|
+
"Images"
|
|
876
|
+
],
|
|
877
|
+
"responses": {
|
|
878
|
+
"200": {
|
|
879
|
+
"description": "OK"
|
|
880
|
+
}
|
|
881
|
+
}
|
|
882
|
+
}
|
|
883
|
+
},
|
|
884
|
+
"/images/generations": {
|
|
885
|
+
"post": {
|
|
886
|
+
"operationId": "createImage",
|
|
887
|
+
"summary": "Creates an image given a prompt",
|
|
888
|
+
"tags": [
|
|
889
|
+
"Images"
|
|
890
|
+
],
|
|
891
|
+
"responses": {
|
|
892
|
+
"200": {
|
|
893
|
+
"description": "OK"
|
|
894
|
+
}
|
|
895
|
+
}
|
|
896
|
+
}
|
|
897
|
+
},
|
|
898
|
+
"/images/variations": {
|
|
899
|
+
"post": {
|
|
900
|
+
"operationId": "createImageVariation",
|
|
901
|
+
"summary": "Creates a variation of a given image",
|
|
902
|
+
"tags": [
|
|
903
|
+
"Images"
|
|
904
|
+
],
|
|
905
|
+
"responses": {
|
|
906
|
+
"200": {
|
|
907
|
+
"description": "OK"
|
|
908
|
+
}
|
|
909
|
+
}
|
|
910
|
+
}
|
|
911
|
+
},
|
|
912
|
+
"/models": {
|
|
913
|
+
"get": {
|
|
914
|
+
"operationId": "listModels",
|
|
915
|
+
"summary": "Lists the currently available models, and provides basic information about each one such as the owner and availability.",
|
|
916
|
+
"tags": [
|
|
917
|
+
"Models"
|
|
918
|
+
],
|
|
919
|
+
"responses": {
|
|
920
|
+
"200": {
|
|
921
|
+
"description": "OK"
|
|
922
|
+
}
|
|
923
|
+
}
|
|
924
|
+
}
|
|
925
|
+
},
|
|
926
|
+
"/models/{model}": {
|
|
927
|
+
"delete": {
|
|
928
|
+
"operationId": "deleteModel",
|
|
929
|
+
"summary": "Delete a fine-tuned model",
|
|
930
|
+
"tags": [
|
|
931
|
+
"Models"
|
|
932
|
+
],
|
|
933
|
+
"responses": {
|
|
934
|
+
"200": {
|
|
935
|
+
"description": "OK"
|
|
936
|
+
}
|
|
937
|
+
}
|
|
938
|
+
},
|
|
939
|
+
"get": {
|
|
940
|
+
"operationId": "retrieveModel",
|
|
941
|
+
"summary": "Retrieves a model instance, providing basic information about the model such as the owner and permissioning.",
|
|
942
|
+
"tags": [
|
|
943
|
+
"Models"
|
|
944
|
+
],
|
|
945
|
+
"responses": {
|
|
946
|
+
"200": {
|
|
947
|
+
"description": "OK"
|
|
948
|
+
}
|
|
949
|
+
}
|
|
950
|
+
}
|
|
951
|
+
},
|
|
952
|
+
"/moderations": {
|
|
953
|
+
"post": {
|
|
954
|
+
"operationId": "createModeration",
|
|
955
|
+
"summary": "Classifies if text and/or image inputs are potentially harmful",
|
|
956
|
+
"tags": [
|
|
957
|
+
"Moderations"
|
|
958
|
+
],
|
|
959
|
+
"responses": {
|
|
960
|
+
"200": {
|
|
961
|
+
"description": "OK"
|
|
962
|
+
}
|
|
963
|
+
}
|
|
964
|
+
}
|
|
965
|
+
},
|
|
966
|
+
"/organization/admin_api_keys": {
|
|
967
|
+
"get": {
|
|
968
|
+
"operationId": "admin-api-keys-list",
|
|
969
|
+
"summary": "List organization API keys",
|
|
970
|
+
"tags": [
|
|
971
|
+
"organization"
|
|
972
|
+
],
|
|
973
|
+
"responses": {
|
|
974
|
+
"200": {
|
|
975
|
+
"description": "A list of organization API keys."
|
|
976
|
+
}
|
|
977
|
+
}
|
|
978
|
+
},
|
|
979
|
+
"post": {
|
|
980
|
+
"operationId": "admin-api-keys-create",
|
|
981
|
+
"summary": "Create an organization admin API key",
|
|
982
|
+
"tags": [
|
|
983
|
+
"organization"
|
|
984
|
+
],
|
|
985
|
+
"responses": {
|
|
986
|
+
"200": {
|
|
987
|
+
"description": "The newly created admin API key."
|
|
988
|
+
}
|
|
989
|
+
}
|
|
990
|
+
}
|
|
991
|
+
},
|
|
992
|
+
"/organization/admin_api_keys/{key_id}": {
|
|
993
|
+
"delete": {
|
|
994
|
+
"operationId": "admin-api-keys-delete",
|
|
995
|
+
"summary": "Delete an organization admin API key",
|
|
996
|
+
"tags": [
|
|
997
|
+
"organization"
|
|
998
|
+
],
|
|
999
|
+
"responses": {
|
|
1000
|
+
"200": {
|
|
1001
|
+
"description": "Confirmation that the API key was deleted."
|
|
1002
|
+
}
|
|
1003
|
+
}
|
|
1004
|
+
},
|
|
1005
|
+
"get": {
|
|
1006
|
+
"operationId": "admin-api-keys-get",
|
|
1007
|
+
"summary": "Retrieve a single organization API key",
|
|
1008
|
+
"tags": [
|
|
1009
|
+
"organization"
|
|
1010
|
+
],
|
|
1011
|
+
"responses": {
|
|
1012
|
+
"200": {
|
|
1013
|
+
"description": "Details of the requested API key."
|
|
1014
|
+
}
|
|
1015
|
+
}
|
|
1016
|
+
}
|
|
1017
|
+
},
|
|
1018
|
+
"/organization/audit_logs": {
|
|
1019
|
+
"get": {
|
|
1020
|
+
"operationId": "list-audit-logs",
|
|
1021
|
+
"summary": "List user actions and configuration changes within this organization.",
|
|
1022
|
+
"tags": [
|
|
1023
|
+
"Audit Logs"
|
|
1024
|
+
],
|
|
1025
|
+
"responses": {
|
|
1026
|
+
"200": {
|
|
1027
|
+
"description": "Audit logs listed successfully."
|
|
1028
|
+
}
|
|
1029
|
+
}
|
|
1030
|
+
}
|
|
1031
|
+
},
|
|
1032
|
+
"/organization/certificates": {
|
|
1033
|
+
"get": {
|
|
1034
|
+
"operationId": "listOrganizationCertificates",
|
|
1035
|
+
"summary": "List uploaded certificates for this organization.",
|
|
1036
|
+
"tags": [
|
|
1037
|
+
"Certificates"
|
|
1038
|
+
],
|
|
1039
|
+
"responses": {
|
|
1040
|
+
"200": {
|
|
1041
|
+
"description": "Certificates listed successfully."
|
|
1042
|
+
}
|
|
1043
|
+
}
|
|
1044
|
+
},
|
|
1045
|
+
"post": {
|
|
1046
|
+
"operationId": "uploadCertificate",
|
|
1047
|
+
"summary": "Upload a certificate to the organization",
|
|
1048
|
+
"tags": [
|
|
1049
|
+
"Certificates"
|
|
1050
|
+
],
|
|
1051
|
+
"responses": {
|
|
1052
|
+
"200": {
|
|
1053
|
+
"description": "Certificate uploaded successfully."
|
|
1054
|
+
}
|
|
1055
|
+
}
|
|
1056
|
+
}
|
|
1057
|
+
},
|
|
1058
|
+
"/organization/certificates/{certificate_id}": {
|
|
1059
|
+
"delete": {
|
|
1060
|
+
"operationId": "deleteCertificate",
|
|
1061
|
+
"summary": "Delete a certificate from the organization.",
|
|
1062
|
+
"tags": [
|
|
1063
|
+
"Certificates"
|
|
1064
|
+
],
|
|
1065
|
+
"responses": {
|
|
1066
|
+
"200": {
|
|
1067
|
+
"description": "Certificate deleted successfully."
|
|
1068
|
+
}
|
|
1069
|
+
}
|
|
1070
|
+
},
|
|
1071
|
+
"get": {
|
|
1072
|
+
"operationId": "getCertificate",
|
|
1073
|
+
"summary": "Get a certificate that has been uploaded to the organization.",
|
|
1074
|
+
"tags": [
|
|
1075
|
+
"Certificates"
|
|
1076
|
+
],
|
|
1077
|
+
"responses": {
|
|
1078
|
+
"200": {
|
|
1079
|
+
"description": "Certificate retrieved successfully."
|
|
1080
|
+
}
|
|
1081
|
+
}
|
|
1082
|
+
},
|
|
1083
|
+
"post": {
|
|
1084
|
+
"operationId": "modifyCertificate",
|
|
1085
|
+
"summary": "Modify a certificate",
|
|
1086
|
+
"tags": [
|
|
1087
|
+
"Certificates"
|
|
1088
|
+
],
|
|
1089
|
+
"responses": {
|
|
1090
|
+
"200": {
|
|
1091
|
+
"description": "Certificate modified successfully."
|
|
1092
|
+
}
|
|
1093
|
+
}
|
|
1094
|
+
}
|
|
1095
|
+
},
|
|
1096
|
+
"/organization/certificates/activate": {
|
|
1097
|
+
"post": {
|
|
1098
|
+
"operationId": "activateOrganizationCertificates",
|
|
1099
|
+
"summary": "Activate certificates at the organization level.",
|
|
1100
|
+
"tags": [
|
|
1101
|
+
"Certificates"
|
|
1102
|
+
],
|
|
1103
|
+
"responses": {
|
|
1104
|
+
"200": {
|
|
1105
|
+
"description": "Certificates activated successfully."
|
|
1106
|
+
}
|
|
1107
|
+
}
|
|
1108
|
+
}
|
|
1109
|
+
},
|
|
1110
|
+
"/organization/certificates/deactivate": {
|
|
1111
|
+
"post": {
|
|
1112
|
+
"operationId": "deactivateOrganizationCertificates",
|
|
1113
|
+
"summary": "Deactivate certificates at the organization level.",
|
|
1114
|
+
"tags": [
|
|
1115
|
+
"Certificates"
|
|
1116
|
+
],
|
|
1117
|
+
"responses": {
|
|
1118
|
+
"200": {
|
|
1119
|
+
"description": "Certificates deactivated successfully."
|
|
1120
|
+
}
|
|
1121
|
+
}
|
|
1122
|
+
}
|
|
1123
|
+
},
|
|
1124
|
+
"/organization/costs": {
|
|
1125
|
+
"get": {
|
|
1126
|
+
"operationId": "usage-costs",
|
|
1127
|
+
"summary": "Get costs details for the organization.",
|
|
1128
|
+
"tags": [
|
|
1129
|
+
"Usage"
|
|
1130
|
+
],
|
|
1131
|
+
"responses": {
|
|
1132
|
+
"200": {
|
|
1133
|
+
"description": "Costs data retrieved successfully."
|
|
1134
|
+
}
|
|
1135
|
+
}
|
|
1136
|
+
}
|
|
1137
|
+
},
|
|
1138
|
+
"/organization/data_retention": {
|
|
1139
|
+
"get": {
|
|
1140
|
+
"operationId": "retrieve-organization-data-retention",
|
|
1141
|
+
"summary": "Retrieves organization data retention controls.",
|
|
1142
|
+
"tags": [
|
|
1143
|
+
"Data retention"
|
|
1144
|
+
],
|
|
1145
|
+
"responses": {
|
|
1146
|
+
"200": {
|
|
1147
|
+
"description": "Organization data retention controls retrieved successfully."
|
|
1148
|
+
}
|
|
1149
|
+
}
|
|
1150
|
+
},
|
|
1151
|
+
"post": {
|
|
1152
|
+
"operationId": "update-organization-data-retention",
|
|
1153
|
+
"summary": "Updates organization data retention controls.",
|
|
1154
|
+
"tags": [
|
|
1155
|
+
"Data retention"
|
|
1156
|
+
],
|
|
1157
|
+
"responses": {
|
|
1158
|
+
"200": {
|
|
1159
|
+
"description": "Organization data retention controls updated successfully."
|
|
1160
|
+
}
|
|
1161
|
+
}
|
|
1162
|
+
}
|
|
1163
|
+
},
|
|
1164
|
+
"/organization/groups": {
|
|
1165
|
+
"get": {
|
|
1166
|
+
"operationId": "list-groups",
|
|
1167
|
+
"summary": "Lists all groups in the organization.",
|
|
1168
|
+
"tags": [
|
|
1169
|
+
"Groups"
|
|
1170
|
+
],
|
|
1171
|
+
"responses": {
|
|
1172
|
+
"200": {
|
|
1173
|
+
"description": "Groups listed successfully."
|
|
1174
|
+
}
|
|
1175
|
+
}
|
|
1176
|
+
},
|
|
1177
|
+
"post": {
|
|
1178
|
+
"operationId": "create-group",
|
|
1179
|
+
"summary": "Creates a new group in the organization.",
|
|
1180
|
+
"tags": [
|
|
1181
|
+
"Groups"
|
|
1182
|
+
],
|
|
1183
|
+
"responses": {
|
|
1184
|
+
"200": {
|
|
1185
|
+
"description": "Group created successfully."
|
|
1186
|
+
}
|
|
1187
|
+
}
|
|
1188
|
+
}
|
|
1189
|
+
},
|
|
1190
|
+
"/organization/groups/{group_id}": {
|
|
1191
|
+
"delete": {
|
|
1192
|
+
"operationId": "delete-group",
|
|
1193
|
+
"summary": "Deletes a group from the organization.",
|
|
1194
|
+
"tags": [
|
|
1195
|
+
"Groups"
|
|
1196
|
+
],
|
|
1197
|
+
"responses": {
|
|
1198
|
+
"200": {
|
|
1199
|
+
"description": "Group deleted successfully."
|
|
1200
|
+
}
|
|
1201
|
+
}
|
|
1202
|
+
},
|
|
1203
|
+
"get": {
|
|
1204
|
+
"operationId": "retrieve-group",
|
|
1205
|
+
"summary": "Retrieves a group.",
|
|
1206
|
+
"tags": [
|
|
1207
|
+
"Groups"
|
|
1208
|
+
],
|
|
1209
|
+
"responses": {
|
|
1210
|
+
"200": {
|
|
1211
|
+
"description": "Group retrieved successfully."
|
|
1212
|
+
}
|
|
1213
|
+
}
|
|
1214
|
+
},
|
|
1215
|
+
"post": {
|
|
1216
|
+
"operationId": "update-group",
|
|
1217
|
+
"summary": "Updates a group's information.",
|
|
1218
|
+
"tags": [
|
|
1219
|
+
"Groups"
|
|
1220
|
+
],
|
|
1221
|
+
"responses": {
|
|
1222
|
+
"200": {
|
|
1223
|
+
"description": "Group updated successfully."
|
|
1224
|
+
}
|
|
1225
|
+
}
|
|
1226
|
+
}
|
|
1227
|
+
},
|
|
1228
|
+
"/organization/groups/{group_id}/roles": {
|
|
1229
|
+
"get": {
|
|
1230
|
+
"operationId": "list-group-role-assignments",
|
|
1231
|
+
"summary": "Lists the organization roles assigned to a group within the organization.",
|
|
1232
|
+
"tags": [
|
|
1233
|
+
"Group organization role assignments"
|
|
1234
|
+
],
|
|
1235
|
+
"responses": {
|
|
1236
|
+
"200": {
|
|
1237
|
+
"description": "Group organization role assignments listed successfully."
|
|
1238
|
+
}
|
|
1239
|
+
}
|
|
1240
|
+
},
|
|
1241
|
+
"post": {
|
|
1242
|
+
"operationId": "assign-group-role",
|
|
1243
|
+
"summary": "Assigns an organization role to a group within the organization.",
|
|
1244
|
+
"tags": [
|
|
1245
|
+
"Group organization role assignments"
|
|
1246
|
+
],
|
|
1247
|
+
"responses": {
|
|
1248
|
+
"200": {
|
|
1249
|
+
"description": "Organization role assigned to the group successfully."
|
|
1250
|
+
}
|
|
1251
|
+
}
|
|
1252
|
+
}
|
|
1253
|
+
},
|
|
1254
|
+
"/organization/groups/{group_id}/roles/{role_id}": {
|
|
1255
|
+
"delete": {
|
|
1256
|
+
"operationId": "unassign-group-role",
|
|
1257
|
+
"summary": "Unassigns an organization role from a group within the organization.",
|
|
1258
|
+
"tags": [
|
|
1259
|
+
"Group organization role assignments"
|
|
1260
|
+
],
|
|
1261
|
+
"responses": {
|
|
1262
|
+
"200": {
|
|
1263
|
+
"description": "Organization role unassigned from the group successfully."
|
|
1264
|
+
}
|
|
1265
|
+
}
|
|
1266
|
+
},
|
|
1267
|
+
"get": {
|
|
1268
|
+
"operationId": "retrieve-group-role",
|
|
1269
|
+
"summary": "Retrieves an organization role assigned to a group.",
|
|
1270
|
+
"tags": [
|
|
1271
|
+
"Group organization role assignments"
|
|
1272
|
+
],
|
|
1273
|
+
"responses": {
|
|
1274
|
+
"200": {
|
|
1275
|
+
"description": "Organization role retrieved for the group successfully."
|
|
1276
|
+
}
|
|
1277
|
+
}
|
|
1278
|
+
}
|
|
1279
|
+
},
|
|
1280
|
+
"/organization/groups/{group_id}/users": {
|
|
1281
|
+
"get": {
|
|
1282
|
+
"operationId": "list-group-users",
|
|
1283
|
+
"summary": "Lists the users assigned to a group.",
|
|
1284
|
+
"tags": [
|
|
1285
|
+
"Group users"
|
|
1286
|
+
],
|
|
1287
|
+
"responses": {
|
|
1288
|
+
"200": {
|
|
1289
|
+
"description": "Group users listed successfully."
|
|
1290
|
+
}
|
|
1291
|
+
}
|
|
1292
|
+
},
|
|
1293
|
+
"post": {
|
|
1294
|
+
"operationId": "add-group-user",
|
|
1295
|
+
"summary": "Adds a user to a group.",
|
|
1296
|
+
"tags": [
|
|
1297
|
+
"Group users"
|
|
1298
|
+
],
|
|
1299
|
+
"responses": {
|
|
1300
|
+
"200": {
|
|
1301
|
+
"description": "User added to the group successfully."
|
|
1302
|
+
}
|
|
1303
|
+
}
|
|
1304
|
+
}
|
|
1305
|
+
},
|
|
1306
|
+
"/organization/groups/{group_id}/users/{user_id}": {
|
|
1307
|
+
"delete": {
|
|
1308
|
+
"operationId": "remove-group-user",
|
|
1309
|
+
"summary": "Removes a user from a group.",
|
|
1310
|
+
"tags": [
|
|
1311
|
+
"Group users"
|
|
1312
|
+
],
|
|
1313
|
+
"responses": {
|
|
1314
|
+
"200": {
|
|
1315
|
+
"description": "User removed from the group successfully."
|
|
1316
|
+
}
|
|
1317
|
+
}
|
|
1318
|
+
},
|
|
1319
|
+
"get": {
|
|
1320
|
+
"operationId": "retrieve-group-user",
|
|
1321
|
+
"summary": "Retrieves a user in a group.",
|
|
1322
|
+
"tags": [
|
|
1323
|
+
"Group users"
|
|
1324
|
+
],
|
|
1325
|
+
"responses": {
|
|
1326
|
+
"200": {
|
|
1327
|
+
"description": "User retrieved from the group successfully."
|
|
1328
|
+
}
|
|
1329
|
+
}
|
|
1330
|
+
}
|
|
1331
|
+
},
|
|
1332
|
+
"/organization/invites": {
|
|
1333
|
+
"get": {
|
|
1334
|
+
"operationId": "list-invites",
|
|
1335
|
+
"summary": "Returns a list of invites in the organization.",
|
|
1336
|
+
"tags": [
|
|
1337
|
+
"Invites"
|
|
1338
|
+
],
|
|
1339
|
+
"responses": {
|
|
1340
|
+
"200": {
|
|
1341
|
+
"description": "Invites listed successfully."
|
|
1342
|
+
}
|
|
1343
|
+
}
|
|
1344
|
+
},
|
|
1345
|
+
"post": {
|
|
1346
|
+
"operationId": "inviteUser",
|
|
1347
|
+
"summary": "Create an invite for a user to the organization",
|
|
1348
|
+
"tags": [
|
|
1349
|
+
"Invites"
|
|
1350
|
+
],
|
|
1351
|
+
"responses": {
|
|
1352
|
+
"200": {
|
|
1353
|
+
"description": "User invited successfully."
|
|
1354
|
+
}
|
|
1355
|
+
}
|
|
1356
|
+
}
|
|
1357
|
+
},
|
|
1358
|
+
"/organization/invites/{invite_id}": {
|
|
1359
|
+
"delete": {
|
|
1360
|
+
"operationId": "delete-invite",
|
|
1361
|
+
"summary": "Delete an invite",
|
|
1362
|
+
"tags": [
|
|
1363
|
+
"Invites"
|
|
1364
|
+
],
|
|
1365
|
+
"responses": {
|
|
1366
|
+
"200": {
|
|
1367
|
+
"description": "Invite deleted successfully."
|
|
1368
|
+
}
|
|
1369
|
+
}
|
|
1370
|
+
},
|
|
1371
|
+
"get": {
|
|
1372
|
+
"operationId": "retrieve-invite",
|
|
1373
|
+
"summary": "Retrieves an invite.",
|
|
1374
|
+
"tags": [
|
|
1375
|
+
"Invites"
|
|
1376
|
+
],
|
|
1377
|
+
"responses": {
|
|
1378
|
+
"200": {
|
|
1379
|
+
"description": "Invite retrieved successfully."
|
|
1380
|
+
}
|
|
1381
|
+
}
|
|
1382
|
+
}
|
|
1383
|
+
},
|
|
1384
|
+
"/organization/projects": {
|
|
1385
|
+
"get": {
|
|
1386
|
+
"operationId": "list-projects",
|
|
1387
|
+
"summary": "Returns a list of projects.",
|
|
1388
|
+
"tags": [
|
|
1389
|
+
"Projects"
|
|
1390
|
+
],
|
|
1391
|
+
"responses": {
|
|
1392
|
+
"200": {
|
|
1393
|
+
"description": "Projects listed successfully."
|
|
1394
|
+
}
|
|
1395
|
+
}
|
|
1396
|
+
},
|
|
1397
|
+
"post": {
|
|
1398
|
+
"operationId": "create-project",
|
|
1399
|
+
"summary": "Create a new project in the organization",
|
|
1400
|
+
"tags": [
|
|
1401
|
+
"Projects"
|
|
1402
|
+
],
|
|
1403
|
+
"responses": {
|
|
1404
|
+
"200": {
|
|
1405
|
+
"description": "Project created successfully."
|
|
1406
|
+
}
|
|
1407
|
+
}
|
|
1408
|
+
}
|
|
1409
|
+
},
|
|
1410
|
+
"/organization/projects/{project_id}": {
|
|
1411
|
+
"get": {
|
|
1412
|
+
"operationId": "retrieve-project",
|
|
1413
|
+
"summary": "Retrieves a project.",
|
|
1414
|
+
"tags": [
|
|
1415
|
+
"Projects"
|
|
1416
|
+
],
|
|
1417
|
+
"responses": {
|
|
1418
|
+
"200": {
|
|
1419
|
+
"description": "Project retrieved successfully."
|
|
1420
|
+
}
|
|
1421
|
+
}
|
|
1422
|
+
},
|
|
1423
|
+
"post": {
|
|
1424
|
+
"operationId": "modify-project",
|
|
1425
|
+
"summary": "Modifies a project in the organization.",
|
|
1426
|
+
"tags": [
|
|
1427
|
+
"Projects"
|
|
1428
|
+
],
|
|
1429
|
+
"responses": {
|
|
1430
|
+
"200": {
|
|
1431
|
+
"description": "Project updated successfully."
|
|
1432
|
+
}
|
|
1433
|
+
}
|
|
1434
|
+
}
|
|
1435
|
+
},
|
|
1436
|
+
"/organization/projects/{project_id}/api_keys": {
|
|
1437
|
+
"get": {
|
|
1438
|
+
"operationId": "list-project-api-keys",
|
|
1439
|
+
"summary": "Returns a list of API keys in the project.",
|
|
1440
|
+
"tags": [
|
|
1441
|
+
"Projects"
|
|
1442
|
+
],
|
|
1443
|
+
"responses": {
|
|
1444
|
+
"200": {
|
|
1445
|
+
"description": "Project API keys listed successfully."
|
|
1446
|
+
}
|
|
1447
|
+
}
|
|
1448
|
+
}
|
|
1449
|
+
},
|
|
1450
|
+
"/organization/projects/{project_id}/api_keys/{api_key_id}": {
|
|
1451
|
+
"delete": {
|
|
1452
|
+
"operationId": "delete-project-api-key",
|
|
1453
|
+
"summary": "Deletes an API key from the project.",
|
|
1454
|
+
"tags": [
|
|
1455
|
+
"Projects"
|
|
1456
|
+
],
|
|
1457
|
+
"responses": {
|
|
1458
|
+
"200": {
|
|
1459
|
+
"description": "Project API key deleted successfully."
|
|
1460
|
+
}
|
|
1461
|
+
}
|
|
1462
|
+
},
|
|
1463
|
+
"get": {
|
|
1464
|
+
"operationId": "retrieve-project-api-key",
|
|
1465
|
+
"summary": "Retrieves an API key in the project.",
|
|
1466
|
+
"tags": [
|
|
1467
|
+
"Projects"
|
|
1468
|
+
],
|
|
1469
|
+
"responses": {
|
|
1470
|
+
"200": {
|
|
1471
|
+
"description": "Project API key retrieved successfully."
|
|
1472
|
+
}
|
|
1473
|
+
}
|
|
1474
|
+
}
|
|
1475
|
+
},
|
|
1476
|
+
"/organization/projects/{project_id}/archive": {
|
|
1477
|
+
"post": {
|
|
1478
|
+
"operationId": "archive-project",
|
|
1479
|
+
"summary": "Archives a project in the organization",
|
|
1480
|
+
"tags": [
|
|
1481
|
+
"Projects"
|
|
1482
|
+
],
|
|
1483
|
+
"responses": {
|
|
1484
|
+
"200": {
|
|
1485
|
+
"description": "Project archived successfully."
|
|
1486
|
+
}
|
|
1487
|
+
}
|
|
1488
|
+
}
|
|
1489
|
+
},
|
|
1490
|
+
"/organization/projects/{project_id}/certificates": {
|
|
1491
|
+
"get": {
|
|
1492
|
+
"operationId": "listProjectCertificates",
|
|
1493
|
+
"summary": "List certificates for this project.",
|
|
1494
|
+
"tags": [
|
|
1495
|
+
"Certificates"
|
|
1496
|
+
],
|
|
1497
|
+
"responses": {
|
|
1498
|
+
"200": {
|
|
1499
|
+
"description": "Certificates listed successfully."
|
|
1500
|
+
}
|
|
1501
|
+
}
|
|
1502
|
+
}
|
|
1503
|
+
},
|
|
1504
|
+
"/organization/projects/{project_id}/certificates/activate": {
|
|
1505
|
+
"post": {
|
|
1506
|
+
"operationId": "activateProjectCertificates",
|
|
1507
|
+
"summary": "Activate certificates at the project level.",
|
|
1508
|
+
"tags": [
|
|
1509
|
+
"Certificates"
|
|
1510
|
+
],
|
|
1511
|
+
"responses": {
|
|
1512
|
+
"200": {
|
|
1513
|
+
"description": "Certificates activated successfully."
|
|
1514
|
+
}
|
|
1515
|
+
}
|
|
1516
|
+
}
|
|
1517
|
+
},
|
|
1518
|
+
"/organization/projects/{project_id}/certificates/deactivate": {
|
|
1519
|
+
"post": {
|
|
1520
|
+
"operationId": "deactivateProjectCertificates",
|
|
1521
|
+
"summary": "Deactivate certificates at the project level",
|
|
1522
|
+
"tags": [
|
|
1523
|
+
"Certificates"
|
|
1524
|
+
],
|
|
1525
|
+
"responses": {
|
|
1526
|
+
"200": {
|
|
1527
|
+
"description": "Certificates deactivated successfully."
|
|
1528
|
+
}
|
|
1529
|
+
}
|
|
1530
|
+
}
|
|
1531
|
+
},
|
|
1532
|
+
"/organization/projects/{project_id}/data_retention": {
|
|
1533
|
+
"get": {
|
|
1534
|
+
"operationId": "retrieve-project-data-retention",
|
|
1535
|
+
"summary": "Retrieves project data retention controls.",
|
|
1536
|
+
"tags": [
|
|
1537
|
+
"Data retention"
|
|
1538
|
+
],
|
|
1539
|
+
"responses": {
|
|
1540
|
+
"200": {
|
|
1541
|
+
"description": "Project data retention controls retrieved successfully."
|
|
1542
|
+
}
|
|
1543
|
+
}
|
|
1544
|
+
},
|
|
1545
|
+
"post": {
|
|
1546
|
+
"operationId": "update-project-data-retention",
|
|
1547
|
+
"summary": "Updates project data retention controls.",
|
|
1548
|
+
"tags": [
|
|
1549
|
+
"Data retention"
|
|
1550
|
+
],
|
|
1551
|
+
"responses": {
|
|
1552
|
+
"200": {
|
|
1553
|
+
"description": "Project data retention controls updated successfully."
|
|
1554
|
+
}
|
|
1555
|
+
}
|
|
1556
|
+
}
|
|
1557
|
+
},
|
|
1558
|
+
"/organization/projects/{project_id}/groups": {
|
|
1559
|
+
"get": {
|
|
1560
|
+
"operationId": "list-project-groups",
|
|
1561
|
+
"summary": "Lists the groups that have access to a project.",
|
|
1562
|
+
"tags": [
|
|
1563
|
+
"Project groups"
|
|
1564
|
+
],
|
|
1565
|
+
"responses": {
|
|
1566
|
+
"200": {
|
|
1567
|
+
"description": "Project groups listed successfully."
|
|
1568
|
+
}
|
|
1569
|
+
}
|
|
1570
|
+
},
|
|
1571
|
+
"post": {
|
|
1572
|
+
"operationId": "add-project-group",
|
|
1573
|
+
"summary": "Grants a group access to a project.",
|
|
1574
|
+
"tags": [
|
|
1575
|
+
"Project groups"
|
|
1576
|
+
],
|
|
1577
|
+
"responses": {
|
|
1578
|
+
"200": {
|
|
1579
|
+
"description": "Group granted access to the project successfully."
|
|
1580
|
+
}
|
|
1581
|
+
}
|
|
1582
|
+
}
|
|
1583
|
+
},
|
|
1584
|
+
"/organization/projects/{project_id}/groups/{group_id}": {
|
|
1585
|
+
"delete": {
|
|
1586
|
+
"operationId": "remove-project-group",
|
|
1587
|
+
"summary": "Revokes a group's access to a project.",
|
|
1588
|
+
"tags": [
|
|
1589
|
+
"Project groups"
|
|
1590
|
+
],
|
|
1591
|
+
"responses": {
|
|
1592
|
+
"200": {
|
|
1593
|
+
"description": "Group removed from the project successfully."
|
|
1594
|
+
}
|
|
1595
|
+
}
|
|
1596
|
+
},
|
|
1597
|
+
"get": {
|
|
1598
|
+
"operationId": "retrieve-project-group",
|
|
1599
|
+
"summary": "Retrieves a project's group.",
|
|
1600
|
+
"tags": [
|
|
1601
|
+
"Project groups"
|
|
1602
|
+
],
|
|
1603
|
+
"responses": {
|
|
1604
|
+
"200": {
|
|
1605
|
+
"description": "Project group retrieved successfully."
|
|
1606
|
+
}
|
|
1607
|
+
}
|
|
1608
|
+
}
|
|
1609
|
+
},
|
|
1610
|
+
"/organization/projects/{project_id}/hosted_tool_permissions": {
|
|
1611
|
+
"get": {
|
|
1612
|
+
"operationId": "retrieve-project-hosted-tool-permissions",
|
|
1613
|
+
"summary": "Returns hosted tool permissions for a project.",
|
|
1614
|
+
"tags": [
|
|
1615
|
+
"Hosted tools"
|
|
1616
|
+
],
|
|
1617
|
+
"responses": {
|
|
1618
|
+
"200": {
|
|
1619
|
+
"description": "Project hosted tool permissions retrieved successfully."
|
|
1620
|
+
}
|
|
1621
|
+
}
|
|
1622
|
+
},
|
|
1623
|
+
"post": {
|
|
1624
|
+
"operationId": "update-project-hosted-tool-permissions",
|
|
1625
|
+
"summary": "Updates hosted tool permissions for a project.",
|
|
1626
|
+
"tags": [
|
|
1627
|
+
"Hosted tools"
|
|
1628
|
+
],
|
|
1629
|
+
"responses": {
|
|
1630
|
+
"200": {
|
|
1631
|
+
"description": "Project hosted tool permissions updated successfully."
|
|
1632
|
+
}
|
|
1633
|
+
}
|
|
1634
|
+
}
|
|
1635
|
+
},
|
|
1636
|
+
"/organization/projects/{project_id}/model_permissions": {
|
|
1637
|
+
"delete": {
|
|
1638
|
+
"operationId": "delete-project-model-permissions",
|
|
1639
|
+
"summary": "Deletes model permissions for a project.",
|
|
1640
|
+
"tags": [
|
|
1641
|
+
"Projects"
|
|
1642
|
+
],
|
|
1643
|
+
"responses": {
|
|
1644
|
+
"200": {
|
|
1645
|
+
"description": "Project model permissions deleted successfully."
|
|
1646
|
+
}
|
|
1647
|
+
}
|
|
1648
|
+
},
|
|
1649
|
+
"get": {
|
|
1650
|
+
"operationId": "retrieve-project-model-permissions",
|
|
1651
|
+
"summary": "Returns model permissions for a project.",
|
|
1652
|
+
"tags": [
|
|
1653
|
+
"Projects"
|
|
1654
|
+
],
|
|
1655
|
+
"responses": {
|
|
1656
|
+
"200": {
|
|
1657
|
+
"description": "Project model permissions retrieved successfully."
|
|
1658
|
+
}
|
|
1659
|
+
}
|
|
1660
|
+
},
|
|
1661
|
+
"post": {
|
|
1662
|
+
"operationId": "update-project-model-permissions",
|
|
1663
|
+
"summary": "Updates model permissions for a project.",
|
|
1664
|
+
"tags": [
|
|
1665
|
+
"Projects"
|
|
1666
|
+
],
|
|
1667
|
+
"responses": {
|
|
1668
|
+
"200": {
|
|
1669
|
+
"description": "Project model permissions updated successfully."
|
|
1670
|
+
}
|
|
1671
|
+
}
|
|
1672
|
+
}
|
|
1673
|
+
},
|
|
1674
|
+
"/organization/projects/{project_id}/rate_limits": {
|
|
1675
|
+
"get": {
|
|
1676
|
+
"operationId": "list-project-rate-limits",
|
|
1677
|
+
"summary": "Returns the rate limits per model for a project.",
|
|
1678
|
+
"tags": [
|
|
1679
|
+
"Projects"
|
|
1680
|
+
],
|
|
1681
|
+
"responses": {
|
|
1682
|
+
"200": {
|
|
1683
|
+
"description": "Project rate limits listed successfully."
|
|
1684
|
+
}
|
|
1685
|
+
}
|
|
1686
|
+
}
|
|
1687
|
+
},
|
|
1688
|
+
"/organization/projects/{project_id}/rate_limits/{rate_limit_id}": {
|
|
1689
|
+
"post": {
|
|
1690
|
+
"operationId": "update-project-rate-limits",
|
|
1691
|
+
"summary": "Updates a project rate limit.",
|
|
1692
|
+
"tags": [
|
|
1693
|
+
"Projects"
|
|
1694
|
+
],
|
|
1695
|
+
"responses": {
|
|
1696
|
+
"200": {
|
|
1697
|
+
"description": "Project rate limit updated successfully."
|
|
1698
|
+
}
|
|
1699
|
+
}
|
|
1700
|
+
}
|
|
1701
|
+
},
|
|
1702
|
+
"/organization/projects/{project_id}/service_accounts": {
|
|
1703
|
+
"get": {
|
|
1704
|
+
"operationId": "list-project-service-accounts",
|
|
1705
|
+
"summary": "Returns a list of service accounts in the project.",
|
|
1706
|
+
"tags": [
|
|
1707
|
+
"Projects"
|
|
1708
|
+
],
|
|
1709
|
+
"responses": {
|
|
1710
|
+
"200": {
|
|
1711
|
+
"description": "Project service accounts listed successfully."
|
|
1712
|
+
}
|
|
1713
|
+
}
|
|
1714
|
+
},
|
|
1715
|
+
"post": {
|
|
1716
|
+
"operationId": "create-project-service-account",
|
|
1717
|
+
"summary": "Creates a new service account in the project",
|
|
1718
|
+
"tags": [
|
|
1719
|
+
"Projects"
|
|
1720
|
+
],
|
|
1721
|
+
"responses": {
|
|
1722
|
+
"200": {
|
|
1723
|
+
"description": "Project service account created successfully."
|
|
1724
|
+
}
|
|
1725
|
+
}
|
|
1726
|
+
}
|
|
1727
|
+
},
|
|
1728
|
+
"/organization/projects/{project_id}/service_accounts/{service_account_id}": {
|
|
1729
|
+
"delete": {
|
|
1730
|
+
"operationId": "delete-project-service-account",
|
|
1731
|
+
"summary": "Deletes a service account from the project.",
|
|
1732
|
+
"tags": [
|
|
1733
|
+
"Projects"
|
|
1734
|
+
],
|
|
1735
|
+
"responses": {
|
|
1736
|
+
"200": {
|
|
1737
|
+
"description": "Project service account deleted successfully."
|
|
1738
|
+
}
|
|
1739
|
+
}
|
|
1740
|
+
},
|
|
1741
|
+
"get": {
|
|
1742
|
+
"operationId": "retrieve-project-service-account",
|
|
1743
|
+
"summary": "Retrieves a service account in the project.",
|
|
1744
|
+
"tags": [
|
|
1745
|
+
"Projects"
|
|
1746
|
+
],
|
|
1747
|
+
"responses": {
|
|
1748
|
+
"200": {
|
|
1749
|
+
"description": "Project service account retrieved successfully."
|
|
1750
|
+
}
|
|
1751
|
+
}
|
|
1752
|
+
},
|
|
1753
|
+
"post": {
|
|
1754
|
+
"operationId": "update-project-service-account",
|
|
1755
|
+
"summary": "Updates a service account in the project.",
|
|
1756
|
+
"tags": [
|
|
1757
|
+
"Projects"
|
|
1758
|
+
],
|
|
1759
|
+
"responses": {
|
|
1760
|
+
"200": {
|
|
1761
|
+
"description": "Project service account updated successfully."
|
|
1762
|
+
}
|
|
1763
|
+
}
|
|
1764
|
+
}
|
|
1765
|
+
},
|
|
1766
|
+
"/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keys": {
|
|
1767
|
+
"post": {
|
|
1768
|
+
"operationId": "CreateanAPIkeyforaserviceaccount",
|
|
1769
|
+
"summary": "Creates an API key for a service account in the project.",
|
|
1770
|
+
"tags": [
|
|
1771
|
+
"organization"
|
|
1772
|
+
],
|
|
1773
|
+
"responses": {
|
|
1774
|
+
"200": {
|
|
1775
|
+
"description": "Service account API key created successfully."
|
|
1776
|
+
}
|
|
1777
|
+
}
|
|
1778
|
+
}
|
|
1779
|
+
},
|
|
1780
|
+
"/organization/projects/{project_id}/spend_alerts": {
|
|
1781
|
+
"get": {
|
|
1782
|
+
"operationId": "list-project-spend-alerts",
|
|
1783
|
+
"summary": "Lists project spend alerts.",
|
|
1784
|
+
"tags": [
|
|
1785
|
+
"Spend alerts"
|
|
1786
|
+
],
|
|
1787
|
+
"responses": {
|
|
1788
|
+
"200": {
|
|
1789
|
+
"description": "Project spend alerts listed successfully."
|
|
1790
|
+
}
|
|
1791
|
+
}
|
|
1792
|
+
},
|
|
1793
|
+
"post": {
|
|
1794
|
+
"operationId": "create-project-spend-alert",
|
|
1795
|
+
"summary": "Creates a project spend alert.",
|
|
1796
|
+
"tags": [
|
|
1797
|
+
"Spend alerts"
|
|
1798
|
+
],
|
|
1799
|
+
"responses": {
|
|
1800
|
+
"200": {
|
|
1801
|
+
"description": "Project spend alert created successfully."
|
|
1802
|
+
}
|
|
1803
|
+
}
|
|
1804
|
+
}
|
|
1805
|
+
},
|
|
1806
|
+
"/organization/projects/{project_id}/spend_alerts/{alert_id}": {
|
|
1807
|
+
"delete": {
|
|
1808
|
+
"operationId": "delete-project-spend-alert",
|
|
1809
|
+
"summary": "Deletes a project spend alert.",
|
|
1810
|
+
"tags": [
|
|
1811
|
+
"Spend alerts"
|
|
1812
|
+
],
|
|
1813
|
+
"responses": {
|
|
1814
|
+
"200": {
|
|
1815
|
+
"description": "Project spend alert deleted successfully."
|
|
1816
|
+
}
|
|
1817
|
+
}
|
|
1818
|
+
},
|
|
1819
|
+
"get": {
|
|
1820
|
+
"operationId": "retrieve-project-spend-alert",
|
|
1821
|
+
"summary": "Retrieves a project spend alert.",
|
|
1822
|
+
"tags": [
|
|
1823
|
+
"Spend alerts"
|
|
1824
|
+
],
|
|
1825
|
+
"responses": {
|
|
1826
|
+
"200": {
|
|
1827
|
+
"description": "Project spend alert retrieved successfully."
|
|
1828
|
+
}
|
|
1829
|
+
}
|
|
1830
|
+
},
|
|
1831
|
+
"post": {
|
|
1832
|
+
"operationId": "update-project-spend-alert",
|
|
1833
|
+
"summary": "Updates a project spend alert.",
|
|
1834
|
+
"tags": [
|
|
1835
|
+
"Spend alerts"
|
|
1836
|
+
],
|
|
1837
|
+
"responses": {
|
|
1838
|
+
"200": {
|
|
1839
|
+
"description": "Project spend alert updated successfully."
|
|
1840
|
+
}
|
|
1841
|
+
}
|
|
1842
|
+
}
|
|
1843
|
+
},
|
|
1844
|
+
"/organization/projects/{project_id}/spend_limit": {
|
|
1845
|
+
"delete": {
|
|
1846
|
+
"operationId": "Deleteprojectspendlimit",
|
|
1847
|
+
"summary": "Delete a project's hard spend limit.",
|
|
1848
|
+
"tags": [
|
|
1849
|
+
"organization"
|
|
1850
|
+
],
|
|
1851
|
+
"responses": {
|
|
1852
|
+
"200": {
|
|
1853
|
+
"description": "Hard spend limit deleted successfully."
|
|
1854
|
+
}
|
|
1855
|
+
}
|
|
1856
|
+
},
|
|
1857
|
+
"get": {
|
|
1858
|
+
"operationId": "Getprojectspendlimit",
|
|
1859
|
+
"summary": "Get a project's hard spend limit.",
|
|
1860
|
+
"tags": [
|
|
1861
|
+
"organization"
|
|
1862
|
+
],
|
|
1863
|
+
"responses": {
|
|
1864
|
+
"200": {
|
|
1865
|
+
"description": "Hard spend limit retrieved successfully."
|
|
1866
|
+
}
|
|
1867
|
+
}
|
|
1868
|
+
},
|
|
1869
|
+
"post": {
|
|
1870
|
+
"operationId": "Updateprojectspendlimit",
|
|
1871
|
+
"summary": "Create or replace a project's hard spend limit.",
|
|
1872
|
+
"tags": [
|
|
1873
|
+
"organization"
|
|
1874
|
+
],
|
|
1875
|
+
"responses": {
|
|
1876
|
+
"200": {
|
|
1877
|
+
"description": "Hard spend limit created or replaced successfully."
|
|
1878
|
+
}
|
|
1879
|
+
}
|
|
1880
|
+
}
|
|
1881
|
+
},
|
|
1882
|
+
"/organization/projects/{project_id}/users": {
|
|
1883
|
+
"get": {
|
|
1884
|
+
"operationId": "list-project-users",
|
|
1885
|
+
"summary": "Returns a list of users in the project.",
|
|
1886
|
+
"tags": [
|
|
1887
|
+
"Projects"
|
|
1888
|
+
],
|
|
1889
|
+
"responses": {
|
|
1890
|
+
"200": {
|
|
1891
|
+
"description": "Project users listed successfully."
|
|
1892
|
+
}
|
|
1893
|
+
}
|
|
1894
|
+
},
|
|
1895
|
+
"post": {
|
|
1896
|
+
"operationId": "create-project-user",
|
|
1897
|
+
"summary": "Adds a user to the project",
|
|
1898
|
+
"tags": [
|
|
1899
|
+
"Projects"
|
|
1900
|
+
],
|
|
1901
|
+
"responses": {
|
|
1902
|
+
"200": {
|
|
1903
|
+
"description": "User added to project successfully."
|
|
1904
|
+
}
|
|
1905
|
+
}
|
|
1906
|
+
}
|
|
1907
|
+
},
|
|
1908
|
+
"/organization/projects/{project_id}/users/{user_id}": {
|
|
1909
|
+
"delete": {
|
|
1910
|
+
"operationId": "delete-project-user",
|
|
1911
|
+
"summary": "Deletes a user from the project.",
|
|
1912
|
+
"tags": [
|
|
1913
|
+
"Projects"
|
|
1914
|
+
],
|
|
1915
|
+
"responses": {
|
|
1916
|
+
"200": {
|
|
1917
|
+
"description": "Project user deleted successfully."
|
|
1918
|
+
}
|
|
1919
|
+
}
|
|
1920
|
+
},
|
|
1921
|
+
"get": {
|
|
1922
|
+
"operationId": "retrieve-project-user",
|
|
1923
|
+
"summary": "Retrieves a user in the project.",
|
|
1924
|
+
"tags": [
|
|
1925
|
+
"Projects"
|
|
1926
|
+
],
|
|
1927
|
+
"responses": {
|
|
1928
|
+
"200": {
|
|
1929
|
+
"description": "Project user retrieved successfully."
|
|
1930
|
+
}
|
|
1931
|
+
}
|
|
1932
|
+
},
|
|
1933
|
+
"post": {
|
|
1934
|
+
"operationId": "modify-project-user",
|
|
1935
|
+
"summary": "Modifies a user's role in the project.",
|
|
1936
|
+
"tags": [
|
|
1937
|
+
"Projects"
|
|
1938
|
+
],
|
|
1939
|
+
"responses": {
|
|
1940
|
+
"200": {
|
|
1941
|
+
"description": "Project user's role updated successfully."
|
|
1942
|
+
}
|
|
1943
|
+
}
|
|
1944
|
+
}
|
|
1945
|
+
},
|
|
1946
|
+
"/organization/roles": {
|
|
1947
|
+
"get": {
|
|
1948
|
+
"operationId": "list-roles",
|
|
1949
|
+
"summary": "Lists the roles configured for the organization.",
|
|
1950
|
+
"tags": [
|
|
1951
|
+
"Roles"
|
|
1952
|
+
],
|
|
1953
|
+
"responses": {
|
|
1954
|
+
"200": {
|
|
1955
|
+
"description": "Roles listed successfully."
|
|
1956
|
+
}
|
|
1957
|
+
}
|
|
1958
|
+
},
|
|
1959
|
+
"post": {
|
|
1960
|
+
"operationId": "create-role",
|
|
1961
|
+
"summary": "Creates a custom role for the organization.",
|
|
1962
|
+
"tags": [
|
|
1963
|
+
"Roles"
|
|
1964
|
+
],
|
|
1965
|
+
"responses": {
|
|
1966
|
+
"200": {
|
|
1967
|
+
"description": "Role created successfully."
|
|
1968
|
+
}
|
|
1969
|
+
}
|
|
1970
|
+
}
|
|
1971
|
+
},
|
|
1972
|
+
"/organization/roles/{role_id}": {
|
|
1973
|
+
"delete": {
|
|
1974
|
+
"operationId": "delete-role",
|
|
1975
|
+
"summary": "Deletes a custom role from the organization.",
|
|
1976
|
+
"tags": [
|
|
1977
|
+
"Roles"
|
|
1978
|
+
],
|
|
1979
|
+
"responses": {
|
|
1980
|
+
"200": {
|
|
1981
|
+
"description": "Role deleted successfully."
|
|
1982
|
+
}
|
|
1983
|
+
}
|
|
1984
|
+
},
|
|
1985
|
+
"get": {
|
|
1986
|
+
"operationId": "retrieve-role",
|
|
1987
|
+
"summary": "Retrieves an organization role.",
|
|
1988
|
+
"tags": [
|
|
1989
|
+
"Roles"
|
|
1990
|
+
],
|
|
1991
|
+
"responses": {
|
|
1992
|
+
"200": {
|
|
1993
|
+
"description": "Role retrieved successfully."
|
|
1994
|
+
}
|
|
1995
|
+
}
|
|
1996
|
+
},
|
|
1997
|
+
"post": {
|
|
1998
|
+
"operationId": "update-role",
|
|
1999
|
+
"summary": "Updates an existing organization role.",
|
|
2000
|
+
"tags": [
|
|
2001
|
+
"Roles"
|
|
2002
|
+
],
|
|
2003
|
+
"responses": {
|
|
2004
|
+
"200": {
|
|
2005
|
+
"description": "Role updated successfully."
|
|
2006
|
+
}
|
|
2007
|
+
}
|
|
2008
|
+
}
|
|
2009
|
+
},
|
|
2010
|
+
"/organization/spend_alerts": {
|
|
2011
|
+
"get": {
|
|
2012
|
+
"operationId": "list-organization-spend-alerts",
|
|
2013
|
+
"summary": "Lists organization spend alerts.",
|
|
2014
|
+
"tags": [
|
|
2015
|
+
"Spend alerts"
|
|
2016
|
+
],
|
|
2017
|
+
"responses": {
|
|
2018
|
+
"200": {
|
|
2019
|
+
"description": "Organization spend alerts listed successfully."
|
|
2020
|
+
}
|
|
2021
|
+
}
|
|
2022
|
+
},
|
|
2023
|
+
"post": {
|
|
2024
|
+
"operationId": "create-organization-spend-alert",
|
|
2025
|
+
"summary": "Creates an organization spend alert.",
|
|
2026
|
+
"tags": [
|
|
2027
|
+
"Spend alerts"
|
|
2028
|
+
],
|
|
2029
|
+
"responses": {
|
|
2030
|
+
"200": {
|
|
2031
|
+
"description": "Organization spend alert created successfully."
|
|
2032
|
+
}
|
|
2033
|
+
}
|
|
2034
|
+
}
|
|
2035
|
+
},
|
|
2036
|
+
"/organization/spend_alerts/{alert_id}": {
|
|
2037
|
+
"delete": {
|
|
2038
|
+
"operationId": "delete-organization-spend-alert",
|
|
2039
|
+
"summary": "Deletes an organization spend alert.",
|
|
2040
|
+
"tags": [
|
|
2041
|
+
"Spend alerts"
|
|
2042
|
+
],
|
|
2043
|
+
"responses": {
|
|
2044
|
+
"200": {
|
|
2045
|
+
"description": "Organization spend alert deleted successfully."
|
|
2046
|
+
}
|
|
2047
|
+
}
|
|
2048
|
+
},
|
|
2049
|
+
"get": {
|
|
2050
|
+
"operationId": "retrieve-organization-spend-alert",
|
|
2051
|
+
"summary": "Retrieves an organization spend alert.",
|
|
2052
|
+
"tags": [
|
|
2053
|
+
"Spend alerts"
|
|
2054
|
+
],
|
|
2055
|
+
"responses": {
|
|
2056
|
+
"200": {
|
|
2057
|
+
"description": "Organization spend alert retrieved successfully."
|
|
2058
|
+
}
|
|
2059
|
+
}
|
|
2060
|
+
},
|
|
2061
|
+
"post": {
|
|
2062
|
+
"operationId": "update-organization-spend-alert",
|
|
2063
|
+
"summary": "Updates an organization spend alert.",
|
|
2064
|
+
"tags": [
|
|
2065
|
+
"Spend alerts"
|
|
2066
|
+
],
|
|
2067
|
+
"responses": {
|
|
2068
|
+
"200": {
|
|
2069
|
+
"description": "Organization spend alert updated successfully."
|
|
2070
|
+
}
|
|
2071
|
+
}
|
|
2072
|
+
}
|
|
2073
|
+
},
|
|
2074
|
+
"/organization/spend_limit": {
|
|
2075
|
+
"delete": {
|
|
2076
|
+
"operationId": "Deleteorganizationspendlimit",
|
|
2077
|
+
"summary": "Delete the organization's hard spend limit.",
|
|
2078
|
+
"tags": [
|
|
2079
|
+
"organization"
|
|
2080
|
+
],
|
|
2081
|
+
"responses": {
|
|
2082
|
+
"200": {
|
|
2083
|
+
"description": "Hard spend limit deleted successfully."
|
|
2084
|
+
}
|
|
2085
|
+
}
|
|
2086
|
+
},
|
|
2087
|
+
"get": {
|
|
2088
|
+
"operationId": "Getorganizationspendlimit",
|
|
2089
|
+
"summary": "Get the organization's hard spend limit.",
|
|
2090
|
+
"tags": [
|
|
2091
|
+
"organization"
|
|
2092
|
+
],
|
|
2093
|
+
"responses": {
|
|
2094
|
+
"200": {
|
|
2095
|
+
"description": "Hard spend limit retrieved successfully."
|
|
2096
|
+
}
|
|
2097
|
+
}
|
|
2098
|
+
},
|
|
2099
|
+
"post": {
|
|
2100
|
+
"operationId": "Updateorganizationspendlimit",
|
|
2101
|
+
"summary": "Create or replace the organization's hard spend limit.",
|
|
2102
|
+
"tags": [
|
|
2103
|
+
"organization"
|
|
2104
|
+
],
|
|
2105
|
+
"responses": {
|
|
2106
|
+
"200": {
|
|
2107
|
+
"description": "Hard spend limit created or replaced successfully."
|
|
2108
|
+
}
|
|
2109
|
+
}
|
|
2110
|
+
}
|
|
2111
|
+
},
|
|
2112
|
+
"/organization/usage/audio_speeches": {
|
|
2113
|
+
"get": {
|
|
2114
|
+
"operationId": "usage-audio-speeches",
|
|
2115
|
+
"summary": "Get audio speeches usage details for the organization.",
|
|
2116
|
+
"tags": [
|
|
2117
|
+
"Usage"
|
|
2118
|
+
],
|
|
2119
|
+
"responses": {
|
|
2120
|
+
"200": {
|
|
2121
|
+
"description": "Usage data retrieved successfully."
|
|
2122
|
+
}
|
|
2123
|
+
}
|
|
2124
|
+
}
|
|
2125
|
+
},
|
|
2126
|
+
"/organization/usage/audio_transcriptions": {
|
|
2127
|
+
"get": {
|
|
2128
|
+
"operationId": "usage-audio-transcriptions",
|
|
2129
|
+
"summary": "Get audio transcriptions usage details for the organization.",
|
|
2130
|
+
"tags": [
|
|
2131
|
+
"Usage"
|
|
2132
|
+
],
|
|
2133
|
+
"responses": {
|
|
2134
|
+
"200": {
|
|
2135
|
+
"description": "Usage data retrieved successfully."
|
|
2136
|
+
}
|
|
2137
|
+
}
|
|
2138
|
+
}
|
|
2139
|
+
},
|
|
2140
|
+
"/organization/usage/code_interpreter_sessions": {
|
|
2141
|
+
"get": {
|
|
2142
|
+
"operationId": "usage-code-interpreter-sessions",
|
|
2143
|
+
"summary": "Get code interpreter sessions usage details for the organization.",
|
|
2144
|
+
"tags": [
|
|
2145
|
+
"Usage"
|
|
2146
|
+
],
|
|
2147
|
+
"responses": {
|
|
2148
|
+
"200": {
|
|
2149
|
+
"description": "Usage data retrieved successfully."
|
|
2150
|
+
}
|
|
2151
|
+
}
|
|
2152
|
+
}
|
|
2153
|
+
},
|
|
2154
|
+
"/organization/usage/completions": {
|
|
2155
|
+
"get": {
|
|
2156
|
+
"operationId": "usage-completions",
|
|
2157
|
+
"summary": "Get completions usage details for the organization.",
|
|
2158
|
+
"tags": [
|
|
2159
|
+
"Usage"
|
|
2160
|
+
],
|
|
2161
|
+
"responses": {
|
|
2162
|
+
"200": {
|
|
2163
|
+
"description": "Usage data retrieved successfully."
|
|
2164
|
+
}
|
|
2165
|
+
}
|
|
2166
|
+
}
|
|
2167
|
+
},
|
|
2168
|
+
"/organization/usage/embeddings": {
|
|
2169
|
+
"get": {
|
|
2170
|
+
"operationId": "usage-embeddings",
|
|
2171
|
+
"summary": "Get embeddings usage details for the organization.",
|
|
2172
|
+
"tags": [
|
|
2173
|
+
"Usage"
|
|
2174
|
+
],
|
|
2175
|
+
"responses": {
|
|
2176
|
+
"200": {
|
|
2177
|
+
"description": "Usage data retrieved successfully."
|
|
2178
|
+
}
|
|
2179
|
+
}
|
|
2180
|
+
}
|
|
2181
|
+
},
|
|
2182
|
+
"/organization/usage/file_search_calls": {
|
|
2183
|
+
"get": {
|
|
2184
|
+
"operationId": "usage-file-search-calls",
|
|
2185
|
+
"summary": "Get file search calls usage details for the organization.",
|
|
2186
|
+
"tags": [
|
|
2187
|
+
"Usage"
|
|
2188
|
+
],
|
|
2189
|
+
"responses": {
|
|
2190
|
+
"200": {
|
|
2191
|
+
"description": "Usage data retrieved successfully."
|
|
2192
|
+
}
|
|
2193
|
+
}
|
|
2194
|
+
}
|
|
2195
|
+
},
|
|
2196
|
+
"/organization/usage/images": {
|
|
2197
|
+
"get": {
|
|
2198
|
+
"operationId": "usage-images",
|
|
2199
|
+
"summary": "Get images usage details for the organization.",
|
|
2200
|
+
"tags": [
|
|
2201
|
+
"Usage"
|
|
2202
|
+
],
|
|
2203
|
+
"responses": {
|
|
2204
|
+
"200": {
|
|
2205
|
+
"description": "Usage data retrieved successfully."
|
|
2206
|
+
}
|
|
2207
|
+
}
|
|
2208
|
+
}
|
|
2209
|
+
},
|
|
2210
|
+
"/organization/usage/moderations": {
|
|
2211
|
+
"get": {
|
|
2212
|
+
"operationId": "usage-moderations",
|
|
2213
|
+
"summary": "Get moderations usage details for the organization.",
|
|
2214
|
+
"tags": [
|
|
2215
|
+
"Usage"
|
|
2216
|
+
],
|
|
2217
|
+
"responses": {
|
|
2218
|
+
"200": {
|
|
2219
|
+
"description": "Usage data retrieved successfully."
|
|
2220
|
+
}
|
|
2221
|
+
}
|
|
2222
|
+
}
|
|
2223
|
+
},
|
|
2224
|
+
"/organization/usage/vector_stores": {
|
|
2225
|
+
"get": {
|
|
2226
|
+
"operationId": "usage-vector-stores",
|
|
2227
|
+
"summary": "Get vector stores usage details for the organization.",
|
|
2228
|
+
"tags": [
|
|
2229
|
+
"Usage"
|
|
2230
|
+
],
|
|
2231
|
+
"responses": {
|
|
2232
|
+
"200": {
|
|
2233
|
+
"description": "Usage data retrieved successfully."
|
|
2234
|
+
}
|
|
2235
|
+
}
|
|
2236
|
+
}
|
|
2237
|
+
},
|
|
2238
|
+
"/organization/usage/web_search_calls": {
|
|
2239
|
+
"get": {
|
|
2240
|
+
"operationId": "usage-web-search-calls",
|
|
2241
|
+
"summary": "Get web search calls usage details for the organization.",
|
|
2242
|
+
"tags": [
|
|
2243
|
+
"Usage"
|
|
2244
|
+
],
|
|
2245
|
+
"responses": {
|
|
2246
|
+
"200": {
|
|
2247
|
+
"description": "Usage data retrieved successfully."
|
|
2248
|
+
}
|
|
2249
|
+
}
|
|
2250
|
+
}
|
|
2251
|
+
},
|
|
2252
|
+
"/organization/users": {
|
|
2253
|
+
"get": {
|
|
2254
|
+
"operationId": "list-users",
|
|
2255
|
+
"summary": "Lists all of the users in the organization.",
|
|
2256
|
+
"tags": [
|
|
2257
|
+
"Users"
|
|
2258
|
+
],
|
|
2259
|
+
"responses": {
|
|
2260
|
+
"200": {
|
|
2261
|
+
"description": "Users listed successfully."
|
|
2262
|
+
}
|
|
2263
|
+
}
|
|
2264
|
+
}
|
|
2265
|
+
},
|
|
2266
|
+
"/organization/users/{user_id}": {
|
|
2267
|
+
"delete": {
|
|
2268
|
+
"operationId": "delete-user",
|
|
2269
|
+
"summary": "Deletes a user from the organization.",
|
|
2270
|
+
"tags": [
|
|
2271
|
+
"Users"
|
|
2272
|
+
],
|
|
2273
|
+
"responses": {
|
|
2274
|
+
"200": {
|
|
2275
|
+
"description": "User deleted successfully."
|
|
2276
|
+
}
|
|
2277
|
+
}
|
|
2278
|
+
},
|
|
2279
|
+
"get": {
|
|
2280
|
+
"operationId": "retrieve-user",
|
|
2281
|
+
"summary": "Retrieves a user by their identifier.",
|
|
2282
|
+
"tags": [
|
|
2283
|
+
"Users"
|
|
2284
|
+
],
|
|
2285
|
+
"responses": {
|
|
2286
|
+
"200": {
|
|
2287
|
+
"description": "User retrieved successfully."
|
|
2288
|
+
}
|
|
2289
|
+
}
|
|
2290
|
+
},
|
|
2291
|
+
"post": {
|
|
2292
|
+
"operationId": "modify-user",
|
|
2293
|
+
"summary": "Modifies a user's role in the organization.",
|
|
2294
|
+
"tags": [
|
|
2295
|
+
"Users"
|
|
2296
|
+
],
|
|
2297
|
+
"responses": {
|
|
2298
|
+
"200": {
|
|
2299
|
+
"description": "User role updated successfully."
|
|
2300
|
+
}
|
|
2301
|
+
}
|
|
2302
|
+
}
|
|
2303
|
+
},
|
|
2304
|
+
"/organization/users/{user_id}/roles": {
|
|
2305
|
+
"get": {
|
|
2306
|
+
"operationId": "list-user-role-assignments",
|
|
2307
|
+
"summary": "Lists the organization roles assigned to a user within the organization.",
|
|
2308
|
+
"tags": [
|
|
2309
|
+
"User organization role assignments"
|
|
2310
|
+
],
|
|
2311
|
+
"responses": {
|
|
2312
|
+
"200": {
|
|
2313
|
+
"description": "User organization role assignments listed successfully."
|
|
2314
|
+
}
|
|
2315
|
+
}
|
|
2316
|
+
},
|
|
2317
|
+
"post": {
|
|
2318
|
+
"operationId": "assign-user-role",
|
|
2319
|
+
"summary": "Assigns an organization role to a user within the organization.",
|
|
2320
|
+
"tags": [
|
|
2321
|
+
"User organization role assignments"
|
|
2322
|
+
],
|
|
2323
|
+
"responses": {
|
|
2324
|
+
"200": {
|
|
2325
|
+
"description": "Organization role assigned to the user successfully."
|
|
2326
|
+
}
|
|
2327
|
+
}
|
|
2328
|
+
}
|
|
2329
|
+
},
|
|
2330
|
+
"/organization/users/{user_id}/roles/{role_id}": {
|
|
2331
|
+
"delete": {
|
|
2332
|
+
"operationId": "unassign-user-role",
|
|
2333
|
+
"summary": "Unassigns an organization role from a user within the organization.",
|
|
2334
|
+
"tags": [
|
|
2335
|
+
"User organization role assignments"
|
|
2336
|
+
],
|
|
2337
|
+
"responses": {
|
|
2338
|
+
"200": {
|
|
2339
|
+
"description": "Organization role unassigned from the user successfully."
|
|
2340
|
+
}
|
|
2341
|
+
}
|
|
2342
|
+
},
|
|
2343
|
+
"get": {
|
|
2344
|
+
"operationId": "retrieve-user-role",
|
|
2345
|
+
"summary": "Retrieves an organization role assigned to a user.",
|
|
2346
|
+
"tags": [
|
|
2347
|
+
"User organization role assignments"
|
|
2348
|
+
],
|
|
2349
|
+
"responses": {
|
|
2350
|
+
"200": {
|
|
2351
|
+
"description": "Organization role retrieved for the user successfully."
|
|
2352
|
+
}
|
|
2353
|
+
}
|
|
2354
|
+
}
|
|
2355
|
+
},
|
|
2356
|
+
"/responses": {
|
|
2357
|
+
"post": {
|
|
2358
|
+
"operationId": "createResponse",
|
|
2359
|
+
"summary": "Creates a model response",
|
|
2360
|
+
"tags": [
|
|
2361
|
+
"Responses"
|
|
2362
|
+
],
|
|
2363
|
+
"responses": {
|
|
2364
|
+
"200": {
|
|
2365
|
+
"description": "OK"
|
|
2366
|
+
}
|
|
2367
|
+
}
|
|
2368
|
+
}
|
|
2369
|
+
},
|
|
2370
|
+
"/responses/{response_id}": {
|
|
2371
|
+
"delete": {
|
|
2372
|
+
"operationId": "deleteResponse",
|
|
2373
|
+
"summary": "Deletes a model response with the given ID.",
|
|
2374
|
+
"tags": [
|
|
2375
|
+
"Responses"
|
|
2376
|
+
],
|
|
2377
|
+
"responses": {
|
|
2378
|
+
"200": {
|
|
2379
|
+
"description": "OK"
|
|
2380
|
+
}
|
|
2381
|
+
}
|
|
2382
|
+
},
|
|
2383
|
+
"get": {
|
|
2384
|
+
"operationId": "getResponse",
|
|
2385
|
+
"summary": "Retrieves a model response with the given ID.",
|
|
2386
|
+
"tags": [
|
|
2387
|
+
"Responses"
|
|
2388
|
+
],
|
|
2389
|
+
"responses": {
|
|
2390
|
+
"200": {
|
|
2391
|
+
"description": "OK"
|
|
2392
|
+
}
|
|
2393
|
+
}
|
|
2394
|
+
}
|
|
2395
|
+
},
|
|
2396
|
+
"/responses/{response_id}/cancel": {
|
|
2397
|
+
"post": {
|
|
2398
|
+
"operationId": "cancelResponse",
|
|
2399
|
+
"summary": "Cancels a model response with the given ID",
|
|
2400
|
+
"tags": [
|
|
2401
|
+
"Responses"
|
|
2402
|
+
],
|
|
2403
|
+
"responses": {
|
|
2404
|
+
"200": {
|
|
2405
|
+
"description": "OK"
|
|
2406
|
+
}
|
|
2407
|
+
}
|
|
2408
|
+
}
|
|
2409
|
+
},
|
|
2410
|
+
"/responses/{response_id}/input_items": {
|
|
2411
|
+
"get": {
|
|
2412
|
+
"operationId": "listInputItems",
|
|
2413
|
+
"summary": "Returns a list of input items for a given response.",
|
|
2414
|
+
"tags": [
|
|
2415
|
+
"Responses"
|
|
2416
|
+
],
|
|
2417
|
+
"responses": {
|
|
2418
|
+
"200": {
|
|
2419
|
+
"description": "OK"
|
|
2420
|
+
}
|
|
2421
|
+
}
|
|
2422
|
+
}
|
|
2423
|
+
},
|
|
2424
|
+
"/responses/compact": {
|
|
2425
|
+
"post": {
|
|
2426
|
+
"operationId": "Compactconversation",
|
|
2427
|
+
"summary": "Compact a conversation",
|
|
2428
|
+
"tags": [
|
|
2429
|
+
"responses"
|
|
2430
|
+
],
|
|
2431
|
+
"responses": {
|
|
2432
|
+
"200": {
|
|
2433
|
+
"description": "Success"
|
|
2434
|
+
}
|
|
2435
|
+
}
|
|
2436
|
+
}
|
|
2437
|
+
},
|
|
2438
|
+
"/responses/input_tokens": {
|
|
2439
|
+
"post": {
|
|
2440
|
+
"operationId": "Getinputtokencounts",
|
|
2441
|
+
"summary": "Returns input token counts of the request.",
|
|
2442
|
+
"tags": [
|
|
2443
|
+
"responses"
|
|
2444
|
+
],
|
|
2445
|
+
"responses": {
|
|
2446
|
+
"200": {
|
|
2447
|
+
"description": "Success"
|
|
2448
|
+
}
|
|
2449
|
+
}
|
|
2450
|
+
}
|
|
2451
|
+
},
|
|
2452
|
+
"/threads": {
|
|
2453
|
+
"post": {
|
|
2454
|
+
"operationId": "createThread",
|
|
2455
|
+
"summary": "Create a thread.",
|
|
2456
|
+
"tags": [
|
|
2457
|
+
"Assistants"
|
|
2458
|
+
],
|
|
2459
|
+
"responses": {
|
|
2460
|
+
"200": {
|
|
2461
|
+
"description": "OK"
|
|
2462
|
+
}
|
|
2463
|
+
}
|
|
2464
|
+
}
|
|
2465
|
+
},
|
|
2466
|
+
"/threads/{thread_id}": {
|
|
2467
|
+
"delete": {
|
|
2468
|
+
"operationId": "deleteThread",
|
|
2469
|
+
"summary": "Delete a thread.",
|
|
2470
|
+
"tags": [
|
|
2471
|
+
"Assistants"
|
|
2472
|
+
],
|
|
2473
|
+
"responses": {
|
|
2474
|
+
"200": {
|
|
2475
|
+
"description": "OK"
|
|
2476
|
+
}
|
|
2477
|
+
}
|
|
2478
|
+
},
|
|
2479
|
+
"get": {
|
|
2480
|
+
"operationId": "getThread",
|
|
2481
|
+
"summary": "Retrieves a thread.",
|
|
2482
|
+
"tags": [
|
|
2483
|
+
"Assistants"
|
|
2484
|
+
],
|
|
2485
|
+
"responses": {
|
|
2486
|
+
"200": {
|
|
2487
|
+
"description": "OK"
|
|
2488
|
+
}
|
|
2489
|
+
}
|
|
2490
|
+
},
|
|
2491
|
+
"post": {
|
|
2492
|
+
"operationId": "modifyThread",
|
|
2493
|
+
"summary": "Modifies a thread.",
|
|
2494
|
+
"tags": [
|
|
2495
|
+
"Assistants"
|
|
2496
|
+
],
|
|
2497
|
+
"responses": {
|
|
2498
|
+
"200": {
|
|
2499
|
+
"description": "OK"
|
|
2500
|
+
}
|
|
2501
|
+
}
|
|
2502
|
+
}
|
|
2503
|
+
},
|
|
2504
|
+
"/threads/{thread_id}/messages": {
|
|
2505
|
+
"get": {
|
|
2506
|
+
"operationId": "listMessages",
|
|
2507
|
+
"summary": "Returns a list of messages for a given thread.",
|
|
2508
|
+
"tags": [
|
|
2509
|
+
"Assistants"
|
|
2510
|
+
],
|
|
2511
|
+
"responses": {
|
|
2512
|
+
"200": {
|
|
2513
|
+
"description": "OK"
|
|
2514
|
+
}
|
|
2515
|
+
}
|
|
2516
|
+
},
|
|
2517
|
+
"post": {
|
|
2518
|
+
"operationId": "createMessage",
|
|
2519
|
+
"summary": "Create a message.",
|
|
2520
|
+
"tags": [
|
|
2521
|
+
"Assistants"
|
|
2522
|
+
],
|
|
2523
|
+
"responses": {
|
|
2524
|
+
"200": {
|
|
2525
|
+
"description": "OK"
|
|
2526
|
+
}
|
|
2527
|
+
}
|
|
2528
|
+
}
|
|
2529
|
+
},
|
|
2530
|
+
"/threads/{thread_id}/messages/{message_id}": {
|
|
2531
|
+
"delete": {
|
|
2532
|
+
"operationId": "deleteMessage",
|
|
2533
|
+
"summary": "Deletes a message.",
|
|
2534
|
+
"tags": [
|
|
2535
|
+
"Assistants"
|
|
2536
|
+
],
|
|
2537
|
+
"responses": {
|
|
2538
|
+
"200": {
|
|
2539
|
+
"description": "OK"
|
|
2540
|
+
}
|
|
2541
|
+
}
|
|
2542
|
+
},
|
|
2543
|
+
"get": {
|
|
2544
|
+
"operationId": "getMessage",
|
|
2545
|
+
"summary": "Retrieve a message.",
|
|
2546
|
+
"tags": [
|
|
2547
|
+
"Assistants"
|
|
2548
|
+
],
|
|
2549
|
+
"responses": {
|
|
2550
|
+
"200": {
|
|
2551
|
+
"description": "OK"
|
|
2552
|
+
}
|
|
2553
|
+
}
|
|
2554
|
+
},
|
|
2555
|
+
"post": {
|
|
2556
|
+
"operationId": "modifyMessage",
|
|
2557
|
+
"summary": "Modifies a message.",
|
|
2558
|
+
"tags": [
|
|
2559
|
+
"Assistants"
|
|
2560
|
+
],
|
|
2561
|
+
"responses": {
|
|
2562
|
+
"200": {
|
|
2563
|
+
"description": "OK"
|
|
2564
|
+
}
|
|
2565
|
+
}
|
|
2566
|
+
}
|
|
2567
|
+
},
|
|
2568
|
+
"/threads/{thread_id}/runs": {
|
|
2569
|
+
"get": {
|
|
2570
|
+
"operationId": "listRuns",
|
|
2571
|
+
"summary": "Returns a list of runs belonging to a thread.",
|
|
2572
|
+
"tags": [
|
|
2573
|
+
"Assistants"
|
|
2574
|
+
],
|
|
2575
|
+
"responses": {
|
|
2576
|
+
"200": {
|
|
2577
|
+
"description": "OK"
|
|
2578
|
+
}
|
|
2579
|
+
}
|
|
2580
|
+
},
|
|
2581
|
+
"post": {
|
|
2582
|
+
"operationId": "createRun",
|
|
2583
|
+
"summary": "Create a run.",
|
|
2584
|
+
"tags": [
|
|
2585
|
+
"Assistants"
|
|
2586
|
+
],
|
|
2587
|
+
"responses": {
|
|
2588
|
+
"200": {
|
|
2589
|
+
"description": "OK"
|
|
2590
|
+
}
|
|
2591
|
+
}
|
|
2592
|
+
}
|
|
2593
|
+
},
|
|
2594
|
+
"/threads/{thread_id}/runs/{run_id}": {
|
|
2595
|
+
"get": {
|
|
2596
|
+
"operationId": "getRun",
|
|
2597
|
+
"summary": "Retrieves a run.",
|
|
2598
|
+
"tags": [
|
|
2599
|
+
"Assistants"
|
|
2600
|
+
],
|
|
2601
|
+
"responses": {
|
|
2602
|
+
"200": {
|
|
2603
|
+
"description": "OK"
|
|
2604
|
+
}
|
|
2605
|
+
}
|
|
2606
|
+
},
|
|
2607
|
+
"post": {
|
|
2608
|
+
"operationId": "modifyRun",
|
|
2609
|
+
"summary": "Modifies a run.",
|
|
2610
|
+
"tags": [
|
|
2611
|
+
"Assistants"
|
|
2612
|
+
],
|
|
2613
|
+
"responses": {
|
|
2614
|
+
"200": {
|
|
2615
|
+
"description": "OK"
|
|
2616
|
+
}
|
|
2617
|
+
}
|
|
2618
|
+
}
|
|
2619
|
+
},
|
|
2620
|
+
"/threads/{thread_id}/runs/{run_id}/cancel": {
|
|
2621
|
+
"post": {
|
|
2622
|
+
"operationId": "cancelRun",
|
|
2623
|
+
"summary": "Cancels a run that is `in_progress`.",
|
|
2624
|
+
"tags": [
|
|
2625
|
+
"Assistants"
|
|
2626
|
+
],
|
|
2627
|
+
"responses": {
|
|
2628
|
+
"200": {
|
|
2629
|
+
"description": "OK"
|
|
2630
|
+
}
|
|
2631
|
+
}
|
|
2632
|
+
}
|
|
2633
|
+
},
|
|
2634
|
+
"/threads/{thread_id}/runs/{run_id}/steps": {
|
|
2635
|
+
"get": {
|
|
2636
|
+
"operationId": "listRunSteps",
|
|
2637
|
+
"summary": "Returns a list of run steps belonging to a run.",
|
|
2638
|
+
"tags": [
|
|
2639
|
+
"Assistants"
|
|
2640
|
+
],
|
|
2641
|
+
"responses": {
|
|
2642
|
+
"200": {
|
|
2643
|
+
"description": "OK"
|
|
2644
|
+
}
|
|
2645
|
+
}
|
|
2646
|
+
}
|
|
2647
|
+
},
|
|
2648
|
+
"/threads/{thread_id}/runs/{run_id}/steps/{step_id}": {
|
|
2649
|
+
"get": {
|
|
2650
|
+
"operationId": "getRunStep",
|
|
2651
|
+
"summary": "Retrieves a run step.",
|
|
2652
|
+
"tags": [
|
|
2653
|
+
"Assistants"
|
|
2654
|
+
],
|
|
2655
|
+
"responses": {
|
|
2656
|
+
"200": {
|
|
2657
|
+
"description": "OK"
|
|
2658
|
+
}
|
|
2659
|
+
}
|
|
2660
|
+
}
|
|
2661
|
+
},
|
|
2662
|
+
"/threads/{thread_id}/runs/{run_id}/submit_tool_outputs": {
|
|
2663
|
+
"post": {
|
|
2664
|
+
"operationId": "submitToolOuputsToRun",
|
|
2665
|
+
"summary": "When a run has the `status: \"requires_action\"` and `required_action.type` is `submit_tool_outputs`, this endpoint can be used to submit the ",
|
|
2666
|
+
"tags": [
|
|
2667
|
+
"Assistants"
|
|
2668
|
+
],
|
|
2669
|
+
"responses": {
|
|
2670
|
+
"200": {
|
|
2671
|
+
"description": "OK"
|
|
2672
|
+
}
|
|
2673
|
+
}
|
|
2674
|
+
}
|
|
2675
|
+
},
|
|
2676
|
+
"/threads/runs": {
|
|
2677
|
+
"post": {
|
|
2678
|
+
"operationId": "createThreadAndRun",
|
|
2679
|
+
"summary": "Create a thread and run it in one request.",
|
|
2680
|
+
"tags": [
|
|
2681
|
+
"Assistants"
|
|
2682
|
+
],
|
|
2683
|
+
"responses": {
|
|
2684
|
+
"200": {
|
|
2685
|
+
"description": "OK"
|
|
2686
|
+
}
|
|
2687
|
+
}
|
|
2688
|
+
}
|
|
2689
|
+
},
|
|
2690
|
+
"/uploads": {
|
|
2691
|
+
"post": {
|
|
2692
|
+
"operationId": "createUpload",
|
|
2693
|
+
"summary": "Creates an intermediate [Upload](/docs/api-reference/uploads/object) object",
|
|
2694
|
+
"tags": [
|
|
2695
|
+
"Uploads"
|
|
2696
|
+
],
|
|
2697
|
+
"responses": {
|
|
2698
|
+
"200": {
|
|
2699
|
+
"description": "OK"
|
|
2700
|
+
}
|
|
2701
|
+
}
|
|
2702
|
+
}
|
|
2703
|
+
},
|
|
2704
|
+
"/uploads/{upload_id}/cancel": {
|
|
2705
|
+
"post": {
|
|
2706
|
+
"operationId": "cancelUpload",
|
|
2707
|
+
"summary": "Cancels the Upload",
|
|
2708
|
+
"tags": [
|
|
2709
|
+
"Uploads"
|
|
2710
|
+
],
|
|
2711
|
+
"responses": {
|
|
2712
|
+
"200": {
|
|
2713
|
+
"description": "OK"
|
|
2714
|
+
}
|
|
2715
|
+
}
|
|
2716
|
+
}
|
|
2717
|
+
},
|
|
2718
|
+
"/uploads/{upload_id}/complete": {
|
|
2719
|
+
"post": {
|
|
2720
|
+
"operationId": "completeUpload",
|
|
2721
|
+
"summary": "Completes the [Upload](/docs/api-reference/uploads/object)",
|
|
2722
|
+
"tags": [
|
|
2723
|
+
"Uploads"
|
|
2724
|
+
],
|
|
2725
|
+
"responses": {
|
|
2726
|
+
"200": {
|
|
2727
|
+
"description": "OK"
|
|
2728
|
+
}
|
|
2729
|
+
}
|
|
2730
|
+
}
|
|
2731
|
+
},
|
|
2732
|
+
"/uploads/{upload_id}/parts": {
|
|
2733
|
+
"post": {
|
|
2734
|
+
"operationId": "addUploadPart",
|
|
2735
|
+
"summary": "Adds a [Part](/docs/api-reference/uploads/part-object) to an [Upload](/docs/api-reference/uploads/object) object",
|
|
2736
|
+
"tags": [
|
|
2737
|
+
"Uploads"
|
|
2738
|
+
],
|
|
2739
|
+
"responses": {
|
|
2740
|
+
"200": {
|
|
2741
|
+
"description": "OK"
|
|
2742
|
+
}
|
|
2743
|
+
}
|
|
2744
|
+
}
|
|
2745
|
+
},
|
|
2746
|
+
"/vector_stores": {
|
|
2747
|
+
"get": {
|
|
2748
|
+
"operationId": "listVectorStores",
|
|
2749
|
+
"summary": "Returns a list of vector stores.",
|
|
2750
|
+
"tags": [
|
|
2751
|
+
"Vector stores"
|
|
2752
|
+
],
|
|
2753
|
+
"responses": {
|
|
2754
|
+
"200": {
|
|
2755
|
+
"description": "OK"
|
|
2756
|
+
}
|
|
2757
|
+
}
|
|
2758
|
+
},
|
|
2759
|
+
"post": {
|
|
2760
|
+
"operationId": "createVectorStore",
|
|
2761
|
+
"summary": "Create a vector store.",
|
|
2762
|
+
"tags": [
|
|
2763
|
+
"Vector stores"
|
|
2764
|
+
],
|
|
2765
|
+
"responses": {
|
|
2766
|
+
"200": {
|
|
2767
|
+
"description": "OK"
|
|
2768
|
+
}
|
|
2769
|
+
}
|
|
2770
|
+
}
|
|
2771
|
+
},
|
|
2772
|
+
"/vector_stores/{vector_store_id}": {
|
|
2773
|
+
"delete": {
|
|
2774
|
+
"operationId": "deleteVectorStore",
|
|
2775
|
+
"summary": "Delete a vector store.",
|
|
2776
|
+
"tags": [
|
|
2777
|
+
"Vector stores"
|
|
2778
|
+
],
|
|
2779
|
+
"responses": {
|
|
2780
|
+
"200": {
|
|
2781
|
+
"description": "OK"
|
|
2782
|
+
}
|
|
2783
|
+
}
|
|
2784
|
+
},
|
|
2785
|
+
"get": {
|
|
2786
|
+
"operationId": "getVectorStore",
|
|
2787
|
+
"summary": "Retrieves a vector store.",
|
|
2788
|
+
"tags": [
|
|
2789
|
+
"Vector stores"
|
|
2790
|
+
],
|
|
2791
|
+
"responses": {
|
|
2792
|
+
"200": {
|
|
2793
|
+
"description": "OK"
|
|
2794
|
+
}
|
|
2795
|
+
}
|
|
2796
|
+
},
|
|
2797
|
+
"post": {
|
|
2798
|
+
"operationId": "modifyVectorStore",
|
|
2799
|
+
"summary": "Modifies a vector store.",
|
|
2800
|
+
"tags": [
|
|
2801
|
+
"Vector stores"
|
|
2802
|
+
],
|
|
2803
|
+
"responses": {
|
|
2804
|
+
"200": {
|
|
2805
|
+
"description": "OK"
|
|
2806
|
+
}
|
|
2807
|
+
}
|
|
2808
|
+
}
|
|
2809
|
+
},
|
|
2810
|
+
"/vector_stores/{vector_store_id}/file_batches": {
|
|
2811
|
+
"post": {
|
|
2812
|
+
"operationId": "createVectorStoreFileBatch",
|
|
2813
|
+
"summary": "Create a vector store file batch.",
|
|
2814
|
+
"tags": [
|
|
2815
|
+
"Vector stores"
|
|
2816
|
+
],
|
|
2817
|
+
"responses": {
|
|
2818
|
+
"200": {
|
|
2819
|
+
"description": "OK"
|
|
2820
|
+
}
|
|
2821
|
+
}
|
|
2822
|
+
}
|
|
2823
|
+
},
|
|
2824
|
+
"/vector_stores/{vector_store_id}/file_batches/{batch_id}": {
|
|
2825
|
+
"get": {
|
|
2826
|
+
"operationId": "getVectorStoreFileBatch",
|
|
2827
|
+
"summary": "Retrieves a vector store file batch.",
|
|
2828
|
+
"tags": [
|
|
2829
|
+
"Vector stores"
|
|
2830
|
+
],
|
|
2831
|
+
"responses": {
|
|
2832
|
+
"200": {
|
|
2833
|
+
"description": "OK"
|
|
2834
|
+
}
|
|
2835
|
+
}
|
|
2836
|
+
}
|
|
2837
|
+
},
|
|
2838
|
+
"/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel": {
|
|
2839
|
+
"post": {
|
|
2840
|
+
"operationId": "cancelVectorStoreFileBatch",
|
|
2841
|
+
"summary": "Cancel a vector store file batch",
|
|
2842
|
+
"tags": [
|
|
2843
|
+
"Vector stores"
|
|
2844
|
+
],
|
|
2845
|
+
"responses": {
|
|
2846
|
+
"200": {
|
|
2847
|
+
"description": "OK"
|
|
2848
|
+
}
|
|
2849
|
+
}
|
|
2850
|
+
}
|
|
2851
|
+
},
|
|
2852
|
+
"/vector_stores/{vector_store_id}/file_batches/{batch_id}/files": {
|
|
2853
|
+
"get": {
|
|
2854
|
+
"operationId": "listFilesInVectorStoreBatch",
|
|
2855
|
+
"summary": "Returns a list of vector store files in a batch.",
|
|
2856
|
+
"tags": [
|
|
2857
|
+
"Vector stores"
|
|
2858
|
+
],
|
|
2859
|
+
"responses": {
|
|
2860
|
+
"200": {
|
|
2861
|
+
"description": "OK"
|
|
2862
|
+
}
|
|
2863
|
+
}
|
|
2864
|
+
}
|
|
2865
|
+
},
|
|
2866
|
+
"/vector_stores/{vector_store_id}/files": {
|
|
2867
|
+
"get": {
|
|
2868
|
+
"operationId": "listVectorStoreFiles",
|
|
2869
|
+
"summary": "Returns a list of vector store files.",
|
|
2870
|
+
"tags": [
|
|
2871
|
+
"Vector stores"
|
|
2872
|
+
],
|
|
2873
|
+
"responses": {
|
|
2874
|
+
"200": {
|
|
2875
|
+
"description": "OK"
|
|
2876
|
+
}
|
|
2877
|
+
}
|
|
2878
|
+
},
|
|
2879
|
+
"post": {
|
|
2880
|
+
"operationId": "createVectorStoreFile",
|
|
2881
|
+
"summary": "Create a vector store file by attaching a [File](/docs/api-reference/files) to a [vector store](/docs/api-reference/vector-stores/object).",
|
|
2882
|
+
"tags": [
|
|
2883
|
+
"Vector stores"
|
|
2884
|
+
],
|
|
2885
|
+
"responses": {
|
|
2886
|
+
"200": {
|
|
2887
|
+
"description": "OK"
|
|
2888
|
+
}
|
|
2889
|
+
}
|
|
2890
|
+
}
|
|
2891
|
+
},
|
|
2892
|
+
"/vector_stores/{vector_store_id}/files/{file_id}": {
|
|
2893
|
+
"delete": {
|
|
2894
|
+
"operationId": "deleteVectorStoreFile",
|
|
2895
|
+
"summary": "Delete a vector store file",
|
|
2896
|
+
"tags": [
|
|
2897
|
+
"Vector stores"
|
|
2898
|
+
],
|
|
2899
|
+
"responses": {
|
|
2900
|
+
"200": {
|
|
2901
|
+
"description": "OK"
|
|
2902
|
+
}
|
|
2903
|
+
}
|
|
2904
|
+
},
|
|
2905
|
+
"get": {
|
|
2906
|
+
"operationId": "getVectorStoreFile",
|
|
2907
|
+
"summary": "Retrieves a vector store file.",
|
|
2908
|
+
"tags": [
|
|
2909
|
+
"Vector stores"
|
|
2910
|
+
],
|
|
2911
|
+
"responses": {
|
|
2912
|
+
"200": {
|
|
2913
|
+
"description": "OK"
|
|
2914
|
+
}
|
|
2915
|
+
}
|
|
2916
|
+
},
|
|
2917
|
+
"post": {
|
|
2918
|
+
"operationId": "updateVectorStoreFileAttributes",
|
|
2919
|
+
"summary": "Update attributes on a vector store file.",
|
|
2920
|
+
"tags": [
|
|
2921
|
+
"Vector stores"
|
|
2922
|
+
],
|
|
2923
|
+
"responses": {
|
|
2924
|
+
"200": {
|
|
2925
|
+
"description": "OK"
|
|
2926
|
+
}
|
|
2927
|
+
}
|
|
2928
|
+
}
|
|
2929
|
+
},
|
|
2930
|
+
"/vector_stores/{vector_store_id}/files/{file_id}/content": {
|
|
2931
|
+
"get": {
|
|
2932
|
+
"operationId": "retrieveVectorStoreFileContent",
|
|
2933
|
+
"summary": "Retrieve the parsed contents of a vector store file.",
|
|
2934
|
+
"tags": [
|
|
2935
|
+
"Vector stores"
|
|
2936
|
+
],
|
|
2937
|
+
"responses": {
|
|
2938
|
+
"200": {
|
|
2939
|
+
"description": "OK"
|
|
2940
|
+
}
|
|
2941
|
+
}
|
|
2942
|
+
}
|
|
2943
|
+
},
|
|
2944
|
+
"/vector_stores/{vector_store_id}/search": {
|
|
2945
|
+
"post": {
|
|
2946
|
+
"operationId": "searchVectorStore",
|
|
2947
|
+
"summary": "Search a vector store for relevant chunks based on a query and file attributes filter.",
|
|
2948
|
+
"tags": [
|
|
2949
|
+
"Vector stores"
|
|
2950
|
+
],
|
|
2951
|
+
"responses": {
|
|
2952
|
+
"200": {
|
|
2953
|
+
"description": "OK"
|
|
2954
|
+
}
|
|
2955
|
+
}
|
|
2956
|
+
}
|
|
2957
|
+
}
|
|
2958
|
+
}
|
|
2959
|
+
}
|