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