26 26
27### Returns27### Returns
28 28
2929- `data: optional array of AdminAPIKey`- `data: array of AdminAPIKey`
30 30
31 - `id: string`31 - `id: string`
32 32
36 36
37 The Unix timestamp (in seconds) of when the API key was created37 The Unix timestamp (in seconds) of when the API key was created
38 38
3939 - `last_used_at: number` - `object: "organization.admin_api_key"`
40
41 The Unix timestamp (in seconds) of when the API key was last used
42
43 - `name: string`
44
45 The name of the API key
46
47 - `object: string`
48 40
49 The object type, which is always `organization.admin_api_key`41 The object type, which is always `organization.admin_api_key`
50 42
43 - `"organization.admin_api_key"`
44
51 - `owner: object { id, created_at, name, 3 more }`45 - `owner: object { id, created_at, name, 3 more }`
52 46
53 - `id: optional string`47 - `id: optional string`
78 72
79 The redacted value of the API key73 The redacted value of the API key
80 74
8175 - `value: optional string` - `last_used_at: optional number`
82 76
8377 The value of the API key. Only shown on create. The Unix timestamp (in seconds) of when the API key was last used
84 78
8579- `first_id: optional string` - `name: optional string`
86 80
8781- `has_more: optional boolean` The name of the API key
88 82
8983- `last_id: optional string`- `has_more: boolean`
84
85- `object: "list"`
86
87 - `"list"`
90 88
9189- `object: optional string`- `first_id: optional string`
90
91- `last_id: optional string`
92 92
93### Example93### Example
94 94
105 {105 {
106 "id": "key_abc",106 "id": "key_abc",
107 "created_at": 1711471533,107 "created_at": 1711471533,
108 "last_used_at": 1711471534,
109 "name": "Administration Key",
110 "object": "organization.admin_api_key",108 "object": "organization.admin_api_key",
111 "owner": {109 "owner": {
112 "id": "sa_456",110 "id": "sa_456",
117 "type": "user"115 "type": "user"
118 },116 },
119 "redacted_value": "sk-admin...def",117 "redacted_value": "sk-admin...def",
120118 "value": "sk-admin-1234abcd" "last_used_at": 1711471534,
119 "name": "Administration Key"
121 }120 }
122 ],121 ],
123 "first_id": "key_abc",
124 "has_more": false,122 "has_more": false,
125123 "last_id": "key_xyz", "object": "list",
126124 "object": "list" "first_id": "key_abc",
125 "last_id": "key_xyz"
127}126}
128```127```
129 128
176 175
177### Returns176### Returns
178 177
179178- `AdminAPIKey object { id, created_at, last_used_at, 5 more }`- `value: string`
180
181 Represents an individual Admin API key in an org.
182
183 - `id: string`
184
185 The identifier, which can be referenced in API endpoints
186
187 - `created_at: number`
188
189 The Unix timestamp (in seconds) of when the API key was created
190
191 - `last_used_at: number`
192
193 The Unix timestamp (in seconds) of when the API key was last used
194
195 - `name: string`
196
197 The name of the API key
198
199 - `object: string`
200
201 The object type, which is always `organization.admin_api_key`
202
203 - `owner: object { id, created_at, name, 3 more }`
204
205 - `id: optional string`
206
207 The identifier, which can be referenced in API endpoints
208
209 - `created_at: optional number`
210
211 The Unix timestamp (in seconds) of when the user was created
212
213 - `name: optional string`
214
215 The name of the user
216
217 - `object: optional string`
218
219 The object type, which is always organization.user
220
221 - `role: optional string`
222
223 Always `owner`
224
225 - `type: optional string`
226
227 Always `user`
228
229 - `redacted_value: string`
230
231 The redacted value of the API key
232
233 - `value: optional string`
234 179
235 The value of the API key. Only shown on create.180 The value of the API key. Only shown on create.
236 181
251{196{
252 "id": "key_abc",197 "id": "key_abc",
253 "created_at": 1711471533,198 "created_at": 1711471533,
254 "last_used_at": 1711471534,
255 "name": "Administration Key",
256 "object": "organization.admin_api_key",199 "object": "organization.admin_api_key",
257 "owner": {200 "owner": {
258 "id": "sa_456",201 "id": "sa_456",
263 "type": "user"206 "type": "user"
264 },207 },
265 "redacted_value": "sk-admin...def",208 "redacted_value": "sk-admin...def",
209 "last_used_at": 1711471534,
210 "name": "Administration Key",
266 "value": "sk-admin-1234abcd"211 "value": "sk-admin-1234abcd"
267}212}
268```213```
314 259
315### Returns260### Returns
316 261
317262- `AdminAPIKey object { id, created_at, last_used_at, 5 more }`- `AdminAPIKey object { id, created_at, object, 4 more }`
318 263
319 Represents an individual Admin API key in an org.264 Represents an individual Admin API key in an org.
320 265
326 271
327 The Unix timestamp (in seconds) of when the API key was created272 The Unix timestamp (in seconds) of when the API key was created
328 273
329274 - `last_used_at: number` - `object: "organization.admin_api_key"`
330
331 The Unix timestamp (in seconds) of when the API key was last used
332
333 - `name: string`
334
335 The name of the API key
336
337 - `object: string`
338 275
339 The object type, which is always `organization.admin_api_key`276 The object type, which is always `organization.admin_api_key`
340 277
278 - `"organization.admin_api_key"`
279
341 - `owner: object { id, created_at, name, 3 more }`280 - `owner: object { id, created_at, name, 3 more }`
342 281
343 - `id: optional string`282 - `id: optional string`
368 307
369 The redacted value of the API key308 The redacted value of the API key
370 309
371310 - `value: optional string` - `last_used_at: optional number`
372 311
373312 The value of the API key. Only shown on create. The Unix timestamp (in seconds) of when the API key was last used
313
314 - `name: optional string`
315
316 The name of the API key
374 317
375### Example318### Example
376 319
385{328{
386 "id": "key_abc",329 "id": "key_abc",
387 "created_at": 1711471533,330 "created_at": 1711471533,
388 "last_used_at": 1711471534,
389 "name": "Administration Key",
390 "object": "organization.admin_api_key",331 "object": "organization.admin_api_key",
391 "owner": {332 "owner": {
392 "id": "sa_456",333 "id": "sa_456",
397 "type": "user"338 "type": "user"
398 },339 },
399 "redacted_value": "sk-admin...def",340 "redacted_value": "sk-admin...def",
400341 "value": "sk-admin-1234abcd" "last_used_at": 1711471534,
342 "name": "Administration Key"
401}343}
402```344```
403 345
444 386
445### Returns387### Returns
446 388
447389- `id: optional string`- `id: string`
448 390
449391- `deleted: optional boolean`- `deleted: boolean`
450 392
451393- `object: optional string`- `object: "organization.admin_api_key.deleted"`
394
395 - `"organization.admin_api_key.deleted"`
452 396
453### Example397### Example
454 398
490 434
491### Admin API Key435### Admin API Key
492 436
493437- `AdminAPIKey object { id, created_at, last_used_at, 5 more }`- `AdminAPIKey object { id, created_at, object, 4 more }`
494 438
495 Represents an individual Admin API key in an org.439 Represents an individual Admin API key in an org.
496 440
502 446
503 The Unix timestamp (in seconds) of when the API key was created447 The Unix timestamp (in seconds) of when the API key was created
504 448
505449 - `last_used_at: number` - `object: "organization.admin_api_key"`
506
507 The Unix timestamp (in seconds) of when the API key was last used
508
509 - `name: string`
510
511 The name of the API key
512
513 - `object: string`
514 450
515 The object type, which is always `organization.admin_api_key`451 The object type, which is always `organization.admin_api_key`
516 452
453 - `"organization.admin_api_key"`
454
517 - `owner: object { id, created_at, name, 3 more }`455 - `owner: object { id, created_at, name, 3 more }`
518 456
519 - `id: optional string`457 - `id: optional string`
544 482
545 The redacted value of the API key483 The redacted value of the API key
546 484
547485 - `value: optional string` - `last_used_at: optional number`
486
487 The Unix timestamp (in seconds) of when the API key was last used
488
489 - `name: optional string`
490
491 The name of the API key
492
493### Admin API Key Create Response
494
495- `AdminAPIKeyCreateResponse = AdminAPIKey`
496
497 Represents an individual Admin API key in an org.
498
499 - `value: string`
548 500
549 The value of the API key. Only shown on create.501 The value of the API key. Only shown on create.
550 502
552 504
553- `AdminAPIKeyDeleteResponse object { id, deleted, object }`505- `AdminAPIKeyDeleteResponse object { id, deleted, object }`
554 506
555507 - `id: optional string` - `id: string`
556 508
557509 - `deleted: optional boolean` - `deleted: boolean`
558 510
559511 - `object: optional string` - `object: "organization.admin_api_key.deleted"`
512
513 - `"organization.admin_api_key.deleted"`
resources/admin/subresources/organization/subresources/admin_api_keys/methods/create/index.md +3 −57
10 10
11### Returns11### Returns
12 12
1313- `AdminAPIKey object { id, created_at, last_used_at, 5 more }`- `value: string`
14
15 Represents an individual Admin API key in an org.
16
17 - `id: string`
18
19 The identifier, which can be referenced in API endpoints
20
21 - `created_at: number`
22
23 The Unix timestamp (in seconds) of when the API key was created
24
25 - `last_used_at: number`
26
27 The Unix timestamp (in seconds) of when the API key was last used
28
29 - `name: string`
30
31 The name of the API key
32
33 - `object: string`
34
35 The object type, which is always `organization.admin_api_key`
36
37 - `owner: object { id, created_at, name, 3 more }`
38
39 - `id: optional string`
40
41 The identifier, which can be referenced in API endpoints
42
43 - `created_at: optional number`
44
45 The Unix timestamp (in seconds) of when the user was created
46
47 - `name: optional string`
48
49 The name of the user
50
51 - `object: optional string`
52
53 The object type, which is always organization.user
54
55 - `role: optional string`
56
57 Always `owner`
58
59 - `type: optional string`
60
61 Always `user`
62
63 - `redacted_value: string`
64
65 The redacted value of the API key
66
67 - `value: optional string`
68 14
69 The value of the API key. Only shown on create.15 The value of the API key. Only shown on create.
70 16
85{31{
86 "id": "key_abc",32 "id": "key_abc",
87 "created_at": 1711471533,33 "created_at": 1711471533,
88 "last_used_at": 1711471534,
89 "name": "Administration Key",
90 "object": "organization.admin_api_key",34 "object": "organization.admin_api_key",
91 "owner": {35 "owner": {
92 "id": "sa_456",36 "id": "sa_456",
97 "type": "user"41 "type": "user"
98 },42 },
99 "redacted_value": "sk-admin...def",43 "redacted_value": "sk-admin...def",
44 "last_used_at": 1711471534,
45 "name": "Administration Key",
100 "value": "sk-admin-1234abcd"46 "value": "sk-admin-1234abcd"
101}47}
102```48```
12 12
13### Returns13### Returns
14 14
1515- `id: optional string`- `id: string`
16 16
1717- `deleted: optional boolean`- `deleted: boolean`
18 18
1919- `object: optional string`- `object: "organization.admin_api_key.deleted"`
20
21 - `"organization.admin_api_key.deleted"`
20 22
21### Example23### Example
22 24
24 24
25### Returns25### Returns
26 26
2727- `data: optional array of AdminAPIKey`- `data: array of AdminAPIKey`
28 28
29 - `id: string`29 - `id: string`
30 30
34 34
35 The Unix timestamp (in seconds) of when the API key was created35 The Unix timestamp (in seconds) of when the API key was created
36 36
3737 - `last_used_at: number` - `object: "organization.admin_api_key"`
38
39 The Unix timestamp (in seconds) of when the API key was last used
40
41 - `name: string`
42
43 The name of the API key
44
45 - `object: string`
46 38
47 The object type, which is always `organization.admin_api_key`39 The object type, which is always `organization.admin_api_key`
48 40
41 - `"organization.admin_api_key"`
42
49 - `owner: object { id, created_at, name, 3 more }`43 - `owner: object { id, created_at, name, 3 more }`
50 44
51 - `id: optional string`45 - `id: optional string`
76 70
77 The redacted value of the API key71 The redacted value of the API key
78 72
7973 - `value: optional string` - `last_used_at: optional number`
80 74
8175 The value of the API key. Only shown on create. The Unix timestamp (in seconds) of when the API key was last used
82 76
8377- `first_id: optional string` - `name: optional string`
78
79 The name of the API key
84 80
8581- `has_more: optional boolean`- `has_more: boolean`
86 82
8783- `last_id: optional string`- `object: "list"`
84
85 - `"list"`
88 86
8987- `object: optional string`- `first_id: optional string`
88
89- `last_id: optional string`
90 90
91### Example91### Example
92 92
103 {103 {
104 "id": "key_abc",104 "id": "key_abc",
105 "created_at": 1711471533,105 "created_at": 1711471533,
106 "last_used_at": 1711471534,
107 "name": "Administration Key",
108 "object": "organization.admin_api_key",106 "object": "organization.admin_api_key",
109 "owner": {107 "owner": {
110 "id": "sa_456",108 "id": "sa_456",
115 "type": "user"113 "type": "user"
116 },114 },
117 "redacted_value": "sk-admin...def",115 "redacted_value": "sk-admin...def",
118116 "value": "sk-admin-1234abcd" "last_used_at": 1711471534,
117 "name": "Administration Key"
119 }118 }
120 ],119 ],
121 "first_id": "key_abc",
122 "has_more": false,120 "has_more": false,
123121 "last_id": "key_xyz", "object": "list",
124122 "object": "list" "first_id": "key_abc",
123 "last_id": "key_xyz"
125}124}
126```125```
127 126
resources/admin/subresources/organization/subresources/admin_api_keys/methods/retrieve/index.md +12 −15
12 12
13### Returns13### Returns
14 14
1515- `AdminAPIKey object { id, created_at, last_used_at, 5 more }`- `AdminAPIKey object { id, created_at, object, 4 more }`
16 16
17 Represents an individual Admin API key in an org.17 Represents an individual Admin API key in an org.
18 18
24 24
25 The Unix timestamp (in seconds) of when the API key was created25 The Unix timestamp (in seconds) of when the API key was created
26 26
2727 - `last_used_at: number` - `object: "organization.admin_api_key"`
28
29 The Unix timestamp (in seconds) of when the API key was last used
30
31 - `name: string`
32
33 The name of the API key
34
35 - `object: string`
36 28
37 The object type, which is always `organization.admin_api_key`29 The object type, which is always `organization.admin_api_key`
38 30
31 - `"organization.admin_api_key"`
32
39 - `owner: object { id, created_at, name, 3 more }`33 - `owner: object { id, created_at, name, 3 more }`
40 34
41 - `id: optional string`35 - `id: optional string`
66 60
67 The redacted value of the API key61 The redacted value of the API key
68 62
6963 - `value: optional string` - `last_used_at: optional number`
70 64
7165 The value of the API key. Only shown on create. The Unix timestamp (in seconds) of when the API key was last used
66
67 - `name: optional string`
68
69 The name of the API key
72 70
73### Example71### Example
74 72
83{81{
84 "id": "key_abc",82 "id": "key_abc",
85 "created_at": 1711471533,83 "created_at": 1711471533,
86 "last_used_at": 1711471534,
87 "name": "Administration Key",
88 "object": "organization.admin_api_key",84 "object": "organization.admin_api_key",
89 "owner": {85 "owner": {
90 "id": "sa_456",86 "id": "sa_456",
95 "type": "user"91 "type": "user"
96 },92 },
97 "redacted_value": "sk-admin...def",93 "redacted_value": "sk-admin...def",
9894 "value": "sk-admin-1234abcd" "last_used_at": 1711471534,
95 "name": "Administration Key"
99}96}
100```97```
101 98
164 164
165### Returns165### Returns
166 166
167167- `data: array of object { id, actor, effective_at, 49 more }`- `data: array of object { id, effective_at, type, 49 more }`
168 168
169 - `id: string`169 - `id: string`
170 170
171 The ID of this log.171 The ID of this log.
172 172
173 - `actor: object { api_key, session, type }`
174
175 The actor who performed the audit logged action.
176
177 - `api_key: optional object { id, service_account, type, user }`
178
179 The API Key used to perform the audit logged action.
180
181 - `id: optional string`
182
183 The tracking id of the API key.
184
185 - `service_account: optional object { id }`
186
187 The service account that performed the audit logged action.
188
189 - `id: optional string`
190
191 The service account id.
192
193 - `type: optional "user" or "service_account"`
194
195 The type of API key. Can be either `user` or `service_account`.
196
197 - `"user"`
198
199 - `"service_account"`
200
201 - `user: optional object { id, email }`
202
203 The user who performed the audit logged action.
204
205 - `id: optional string`
206
207 The user id.
208
209 - `email: optional string`
210
211 The user email.
212
213 - `session: optional object { ip_address, user }`
214
215 The session in which the audit logged action was performed.
216
217 - `ip_address: optional string`
218
219 The IP address from which the action was performed.
220
221 - `user: optional object { id, email }`
222
223 The user who performed the audit logged action.
224
225 - `id: optional string`
226
227 The user id.
228
229 - `email: optional string`
230
231 The user email.
232
233 - `type: optional "session" or "api_key"`
234
235 The type of actor. Is either `session` or `api_key`.
236
237 - `"session"`
238
239 - `"api_key"`
240
241 - `effective_at: number`173 - `effective_at: number`
242 174
243 The Unix timestamp (in seconds) of the event.175 The Unix timestamp (in seconds) of the event.
348 280
349 - `"user.deleted"`281 - `"user.deleted"`
350 282
283 - `actor: optional object { api_key, session, type }`
284
285 The actor who performed the audit logged action.
286
287 - `api_key: optional object { id, service_account, type, user }`
288
289 The API Key used to perform the audit logged action.
290
291 - `id: optional string`
292
293 The tracking id of the API key.
294
295 - `service_account: optional object { id }`
296
297 The service account that performed the audit logged action.
298
299 - `id: optional string`
300
301 The service account id.
302
303 - `type: optional "user" or "service_account"`
304
305 The type of API key. Can be either `user` or `service_account`.
306
307 - `"user"`
308
309 - `"service_account"`
310
311 - `user: optional object { id, email }`
312
313 The user who performed the audit logged action.
314
315 - `id: optional string`
316
317 The user id.
318
319 - `email: optional string`
320
321 The user email.
322
323 - `session: optional object { ip_address, user }`
324
325 The session in which the audit logged action was performed.
326
327 - `ip_address: optional string`
328
329 The IP address from which the action was performed.
330
331 - `user: optional object { id, email }`
332
333 The user who performed the audit logged action.
334
335 - `id: optional string`
336
337 The user id.
338
339 - `email: optional string`
340
341 The user email.
342
343 - `type: optional "session" or "api_key"`
344
345 The type of actor. Is either `session` or `api_key`.
346
347 - `"session"`
348
349 - `"api_key"`
350
351 - `"api_key.created": optional object { id, data }`351 - `"api_key.created": optional object { id, data }`
352 352
353 The details for events with this `type`.353 The details for events with this `type`.
1052 1052
1053 The role of the user. Is either `owner` or `member`.1053 The role of the user. Is either `owner` or `member`.
1054 1054
1055- `first_id: string`
1056
1057- `has_more: boolean`1055- `has_more: boolean`
1058 1056
1059- `last_id: string`
1060
1061- `object: "list"`1057- `object: "list"`
1062 1058
1063 - `"list"`1059 - `"list"`
1064 1060
1061- `first_id: optional string`
1062
1063- `last_id: optional string`
1064
1065### Example1065### Example
1066 1066
1067```http1067```http
1076 "data": [1076 "data": [
1077 {1077 {
1078 "id": "id",1078 "id": "id",
1079 "effective_at": 0,
1080 "type": "api_key.created",
1079 "actor": {1081 "actor": {
1080 "api_key": {1082 "api_key": {
1081 "id": "id",1083 "id": "id",
1097 },1099 },
1098 "type": "session"1100 "type": "session"
1099 },1101 },
1100 "effective_at": 0,
1101 "type": "api_key.created",
1102 "api_key.created": {1102 "api_key.created": {
1103 "id": "id",1103 "id": "id",
1104 "data": {1104 "data": {
1367 }1367 }
1368 }1368 }
1369 ],1369 ],
1370 "first_id": "audit_log-defb456h8dks",
1371 "has_more": true,1370 "has_more": true,
13721371 "last_id": "audit_log-hnbkd8s93s", "object": "list",
13731372 "object": "list" "first_id": "audit_log-defb456h8dks",
1373 "last_id": "audit_log-hnbkd8s93s"
1374}1374}
1375```1375```
1376 1376
1450 1450
1451### Audit Log List Response1451### Audit Log List Response
1452 1452
14531453- `AuditLogListResponse object { id, actor, effective_at, 49 more }`- `AuditLogListResponse object { id, effective_at, type, 49 more }`
1454 1454
1455 A log of a user action or configuration change within this organization.1455 A log of a user action or configuration change within this organization.
1456 1456
1458 1458
1459 The ID of this log.1459 The ID of this log.
1460 1460
1461 - `actor: object { api_key, session, type }`
1462
1463 The actor who performed the audit logged action.
1464
1465 - `api_key: optional object { id, service_account, type, user }`
1466
1467 The API Key used to perform the audit logged action.
1468
1469 - `id: optional string`
1470
1471 The tracking id of the API key.
1472
1473 - `service_account: optional object { id }`
1474
1475 The service account that performed the audit logged action.
1476
1477 - `id: optional string`
1478
1479 The service account id.
1480
1481 - `type: optional "user" or "service_account"`
1482
1483 The type of API key. Can be either `user` or `service_account`.
1484
1485 - `"user"`
1486
1487 - `"service_account"`
1488
1489 - `user: optional object { id, email }`
1490
1491 The user who performed the audit logged action.
1492
1493 - `id: optional string`
1494
1495 The user id.
1496
1497 - `email: optional string`
1498
1499 The user email.
1500
1501 - `session: optional object { ip_address, user }`
1502
1503 The session in which the audit logged action was performed.
1504
1505 - `ip_address: optional string`
1506
1507 The IP address from which the action was performed.
1508
1509 - `user: optional object { id, email }`
1510
1511 The user who performed the audit logged action.
1512
1513 - `id: optional string`
1514
1515 The user id.
1516
1517 - `email: optional string`
1518
1519 The user email.
1520
1521 - `type: optional "session" or "api_key"`
1522
1523 The type of actor. Is either `session` or `api_key`.
1524
1525 - `"session"`
1526
1527 - `"api_key"`
1528
1529 - `effective_at: number`1461 - `effective_at: number`
1530 1462
1531 The Unix timestamp (in seconds) of the event.1463 The Unix timestamp (in seconds) of the event.
1636 1568
1637 - `"user.deleted"`1569 - `"user.deleted"`
1638 1570
1571 - `actor: optional object { api_key, session, type }`
1572
1573 The actor who performed the audit logged action.
1574
1575 - `api_key: optional object { id, service_account, type, user }`
1576
1577 The API Key used to perform the audit logged action.
1578
1579 - `id: optional string`
1580
1581 The tracking id of the API key.
1582
1583 - `service_account: optional object { id }`
1584
1585 The service account that performed the audit logged action.
1586
1587 - `id: optional string`
1588
1589 The service account id.
1590
1591 - `type: optional "user" or "service_account"`
1592
1593 The type of API key. Can be either `user` or `service_account`.
1594
1595 - `"user"`
1596
1597 - `"service_account"`
1598
1599 - `user: optional object { id, email }`
1600
1601 The user who performed the audit logged action.
1602
1603 - `id: optional string`
1604
1605 The user id.
1606
1607 - `email: optional string`
1608
1609 The user email.
1610
1611 - `session: optional object { ip_address, user }`
1612
1613 The session in which the audit logged action was performed.
1614
1615 - `ip_address: optional string`
1616
1617 The IP address from which the action was performed.
1618
1619 - `user: optional object { id, email }`
1620
1621 The user who performed the audit logged action.
1622
1623 - `id: optional string`
1624
1625 The user id.
1626
1627 - `email: optional string`
1628
1629 The user email.
1630
1631 - `type: optional "session" or "api_key"`
1632
1633 The type of actor. Is either `session` or `api_key`.
1634
1635 - `"session"`
1636
1637 - `"api_key"`
1638
1639 - `"api_key.created": optional object { id, data }`1639 - `"api_key.created": optional object { id, data }`
1640 1640
1641 The details for events with this `type`.1641 The details for events with this `type`.
162 162
163### Returns163### Returns
164 164
165165- `data: array of object { id, actor, effective_at, 49 more }`- `data: array of object { id, effective_at, type, 49 more }`
166 166
167 - `id: string`167 - `id: string`
168 168
169 The ID of this log.169 The ID of this log.
170 170
171 - `actor: object { api_key, session, type }`
172
173 The actor who performed the audit logged action.
174
175 - `api_key: optional object { id, service_account, type, user }`
176
177 The API Key used to perform the audit logged action.
178
179 - `id: optional string`
180
181 The tracking id of the API key.
182
183 - `service_account: optional object { id }`
184
185 The service account that performed the audit logged action.
186
187 - `id: optional string`
188
189 The service account id.
190
191 - `type: optional "user" or "service_account"`
192
193 The type of API key. Can be either `user` or `service_account`.
194
195 - `"user"`
196
197 - `"service_account"`
198
199 - `user: optional object { id, email }`
200
201 The user who performed the audit logged action.
202
203 - `id: optional string`
204
205 The user id.
206
207 - `email: optional string`
208
209 The user email.
210
211 - `session: optional object { ip_address, user }`
212
213 The session in which the audit logged action was performed.
214
215 - `ip_address: optional string`
216
217 The IP address from which the action was performed.
218
219 - `user: optional object { id, email }`
220
221 The user who performed the audit logged action.
222
223 - `id: optional string`
224
225 The user id.
226
227 - `email: optional string`
228
229 The user email.
230
231 - `type: optional "session" or "api_key"`
232
233 The type of actor. Is either `session` or `api_key`.
234
235 - `"session"`
236
237 - `"api_key"`
238
239 - `effective_at: number`171 - `effective_at: number`
240 172
241 The Unix timestamp (in seconds) of the event.173 The Unix timestamp (in seconds) of the event.
346 278
347 - `"user.deleted"`279 - `"user.deleted"`
348 280
281 - `actor: optional object { api_key, session, type }`
282
283 The actor who performed the audit logged action.
284
285 - `api_key: optional object { id, service_account, type, user }`
286
287 The API Key used to perform the audit logged action.
288
289 - `id: optional string`
290
291 The tracking id of the API key.
292
293 - `service_account: optional object { id }`
294
295 The service account that performed the audit logged action.
296
297 - `id: optional string`
298
299 The service account id.
300
301 - `type: optional "user" or "service_account"`
302
303 The type of API key. Can be either `user` or `service_account`.
304
305 - `"user"`
306
307 - `"service_account"`
308
309 - `user: optional object { id, email }`
310
311 The user who performed the audit logged action.
312
313 - `id: optional string`
314
315 The user id.
316
317 - `email: optional string`
318
319 The user email.
320
321 - `session: optional object { ip_address, user }`
322
323 The session in which the audit logged action was performed.
324
325 - `ip_address: optional string`
326
327 The IP address from which the action was performed.
328
329 - `user: optional object { id, email }`
330
331 The user who performed the audit logged action.
332
333 - `id: optional string`
334
335 The user id.
336
337 - `email: optional string`
338
339 The user email.
340
341 - `type: optional "session" or "api_key"`
342
343 The type of actor. Is either `session` or `api_key`.
344
345 - `"session"`
346
347 - `"api_key"`
348
349 - `"api_key.created": optional object { id, data }`349 - `"api_key.created": optional object { id, data }`
350 350
351 The details for events with this `type`.351 The details for events with this `type`.
1050 1050
1051 The role of the user. Is either `owner` or `member`.1051 The role of the user. Is either `owner` or `member`.
1052 1052
1053- `first_id: string`
1054
1055- `has_more: boolean`1053- `has_more: boolean`
1056 1054
1057- `last_id: string`
1058
1059- `object: "list"`1055- `object: "list"`
1060 1056
1061 - `"list"`1057 - `"list"`
1062 1058
1059- `first_id: optional string`
1060
1061- `last_id: optional string`
1062
1063### Example1063### Example
1064 1064
1065```http1065```http
1074 "data": [1074 "data": [
1075 {1075 {
1076 "id": "id",1076 "id": "id",
1077 "effective_at": 0,
1078 "type": "api_key.created",
1077 "actor": {1079 "actor": {
1078 "api_key": {1080 "api_key": {
1079 "id": "id",1081 "id": "id",
1095 },1097 },
1096 "type": "session"1098 "type": "session"
1097 },1099 },
1098 "effective_at": 0,
1099 "type": "api_key.created",
1100 "api_key.created": {1100 "api_key.created": {
1101 "id": "id",1101 "id": "id",
1102 "data": {1102 "data": {
1365 }1365 }
1366 }1366 }
1367 ],1367 ],
1368 "first_id": "audit_log-defb456h8dks",
1369 "has_more": true,1368 "has_more": true,
13701369 "last_id": "audit_log-hnbkd8s93s", "object": "list",
13711370 "object": "list" "first_id": "audit_log-defb456h8dks",
1371 "last_id": "audit_log-hnbkd8s93s"
1372}1372}
1373```1373```
1374 1374
38 38
39 Unix timestamp (in seconds) when the group was created.39 Unix timestamp (in seconds) when the group was created.
40 40
41 - `group_type: string`
42
43 The type of the group.
44
41 - `is_scim_managed: boolean`45 - `is_scim_managed: boolean`
42 46
43 Whether the group is managed through SCIM and controlled by your identity provider.47 Whether the group is managed through SCIM and controlled by your identity provider.
75 {79 {
76 "id": "id",80 "id": "id",
77 "created_at": 0,81 "created_at": 0,
82 "group_type": "group_type",
78 "is_scim_managed": true,83 "is_scim_managed": true,
79 "name": "name"84 "name": "name"
80 }85 }
126 131
127### Returns132### Returns
128 133
129134- `Group object { id, created_at, is_scim_managed, name }`- `Group object { id, created_at, group_type, 2 more }`
130 135
131 Details about an organization group.136 Details about an organization group.
132 137
138 143
139 Unix timestamp (in seconds) when the group was created.144 Unix timestamp (in seconds) when the group was created.
140 145
146 - `group_type: string`
147
148 The type of the group.
149
141 - `is_scim_managed: boolean`150 - `is_scim_managed: boolean`
142 151
143 Whether the group is managed through SCIM and controlled by your identity provider.152 Whether the group is managed through SCIM and controlled by your identity provider.
163{172{
164 "id": "id",173 "id": "id",
165 "created_at": 0,174 "created_at": 0,
175 "group_type": "group_type",
166 "is_scim_managed": true,176 "is_scim_managed": true,
167 "name": "name"177 "name": "name"
168}178}
335 345
336### Group346### Group
337 347
338348- `Group object { id, created_at, is_scim_managed, name }`- `Group object { id, created_at, group_type, 2 more }`
339 349
340 Details about an organization group.350 Details about an organization group.
341 351
347 357
348 Unix timestamp (in seconds) when the group was created.358 Unix timestamp (in seconds) when the group was created.
349 359
360 - `group_type: string`
361
362 The type of the group.
363
350 - `is_scim_managed: boolean`364 - `is_scim_managed: boolean`
351 365
352 Whether the group is managed through SCIM and controlled by your identity provider.366 Whether the group is managed through SCIM and controlled by your identity provider.
429 443
430### Returns444### Returns
431 445
432446- `data: array of OrganizationUser`- `data: array of OrganizationGroupUser`
433 447
434 Users in the current page.448 Users in the current page.
435 449
437 451
438 The identifier, which can be referenced in API endpoints452 The identifier, which can be referenced in API endpoints
439 453
440 - `added_at: number`
441
442 The Unix timestamp (in seconds) of when the user was added.
443
444 - `email: string`454 - `email: string`
445 455
446456 The email address of the user The email address of the user.
447 457
448 - `name: string`458 - `name: string`
449 459
450460 The name of the user The name of the user.
451
452 - `object: "organization.user"`
453
454 The object type, which is always `organization.user`
455
456 - `"organization.user"`
457
458 - `role: "owner" or "reader"`
459
460 `owner` or `reader`
461
462 - `"owner"`
463
464 - `"reader"`
465 461
466- `has_more: boolean`462- `has_more: boolean`
467 463
491 "data": [487 "data": [
492 {488 {
493 "id": "id",489 "id": "id",
494 "added_at": 0,
495 "email": "email",490 "email": "email",
496491 "name": "name", "name": "name"
497 "object": "organization.user",
498 "role": "owner"
499 }492 }
500 ],493 ],
501 "has_more": true,494 "has_more": true,
519 "object": "list",512 "object": "list",
520 "data": [513 "data": [
521 {514 {
522 "object": "organization.user",
523 "id": "user_abc123",515 "id": "user_abc123",
524 "name": "Ada Lovelace",516 "name": "Ada Lovelace",
525517 "email": "ada@example.com", "email": "ada@example.com"
526 "role": "owner",
527 "added_at": 1711471533
528 }518 }
529 ],519 ],
530 "has_more": false,520 "has_more": false,
666 656
667## Domain Types657## Domain Types
668 658
659### Organization Group User
660
661- `OrganizationGroupUser object { id, email, name }`
662
663 Represents an individual user returned when inspecting group membership.
664
665 - `id: string`
666
667 The identifier, which can be referenced in API endpoints
668
669 - `email: string`
670
671 The email address of the user.
672
673 - `name: string`
674
675 The name of the user.
676
669### User Create Response677### User Create Response
670 678
671- `UserCreateResponse object { group_id, object, user_id }`679- `UserCreateResponse object { group_id, object, user_id }`
12 12
13### Returns13### Returns
14 14
1515- `Group object { id, created_at, is_scim_managed, name }`- `Group object { id, created_at, group_type, 2 more }`
16 16
17 Details about an organization group.17 Details about an organization group.
18 18
24 24
25 Unix timestamp (in seconds) when the group was created.25 Unix timestamp (in seconds) when the group was created.
26 26
27 - `group_type: string`
28
29 The type of the group.
30
27 - `is_scim_managed: boolean`31 - `is_scim_managed: boolean`
28 32
29 Whether the group is managed through SCIM and controlled by your identity provider.33 Whether the group is managed through SCIM and controlled by your identity provider.
49{53{
50 "id": "id",54 "id": "id",
51 "created_at": 0,55 "created_at": 0,
56 "group_type": "group_type",
52 "is_scim_managed": true,57 "is_scim_managed": true,
53 "name": "name"58 "name": "name"
54}59}
36 36
37 Unix timestamp (in seconds) when the group was created.37 Unix timestamp (in seconds) when the group was created.
38 38
39 - `group_type: string`
40
41 The type of the group.
42
39 - `is_scim_managed: boolean`43 - `is_scim_managed: boolean`
40 44
41 Whether the group is managed through SCIM and controlled by your identity provider.45 Whether the group is managed through SCIM and controlled by your identity provider.
73 {77 {
74 "id": "id",78 "id": "id",
75 "created_at": 0,79 "created_at": 0,
80 "group_type": "group_type",
76 "is_scim_managed": true,81 "is_scim_managed": true,
77 "name": "name"82 "name": "name"
78 }83 }
30 30
31### Returns31### Returns
32 32
3333- `data: array of OrganizationUser`- `data: array of OrganizationGroupUser`
34 34
35 Users in the current page.35 Users in the current page.
36 36
38 38
39 The identifier, which can be referenced in API endpoints39 The identifier, which can be referenced in API endpoints
40 40
41 - `added_at: number`
42
43 The Unix timestamp (in seconds) of when the user was added.
44
45 - `email: string`41 - `email: string`
46 42
4743 The email address of the user The email address of the user.
48 44
49 - `name: string`45 - `name: string`
50 46
5147 The name of the user The name of the user.
52
53 - `object: "organization.user"`
54
55 The object type, which is always `organization.user`
56
57 - `"organization.user"`
58
59 - `role: "owner" or "reader"`
60
61 `owner` or `reader`
62
63 - `"owner"`
64
65 - `"reader"`
66 48
67- `has_more: boolean`49- `has_more: boolean`
68 50
92 "data": [74 "data": [
93 {75 {
94 "id": "id",76 "id": "id",
95 "added_at": 0,
96 "email": "email",77 "email": "email",
9778 "name": "name", "name": "name"
98 "object": "organization.user",
99 "role": "owner"
100 }79 }
101 ],80 ],
102 "has_more": true,81 "has_more": true,
120 "object": "list",99 "object": "list",
121 "data": [100 "data": [
122 {101 {
123 "object": "organization.user",
124 "id": "user_abc123",102 "id": "user_abc123",
125 "name": "Ada Lovelace",103 "name": "Ada Lovelace",
126104 "email": "ada@example.com", "email": "ada@example.com"
127 "role": "owner",
128 "added_at": 1711471533
129 }105 }
130 ],106 ],
131 "has_more": false,107 "has_more": false,
267 243
268## Domain Types244## Domain Types
269 245
246### Organization Group User
247
248- `OrganizationGroupUser object { id, email, name }`
249
250 Represents an individual user returned when inspecting group membership.
251
252 - `id: string`
253
254 The identifier, which can be referenced in API endpoints
255
256 - `email: string`
257
258 The email address of the user.
259
260 - `name: string`
261
262 The name of the user.
263
270### User Create Response264### User Create Response
271 265
272- `UserCreateResponse object { group_id, object, user_id }`266- `UserCreateResponse object { group_id, object, user_id }`
28 28
29### Returns29### Returns
30 30
3131- `data: array of OrganizationUser`- `data: array of OrganizationGroupUser`
32 32
33 Users in the current page.33 Users in the current page.
34 34
36 36
37 The identifier, which can be referenced in API endpoints37 The identifier, which can be referenced in API endpoints
38 38
39 - `added_at: number`
40
41 The Unix timestamp (in seconds) of when the user was added.
42
43 - `email: string`39 - `email: string`
44 40
4541 The email address of the user The email address of the user.
46 42
47 - `name: string`43 - `name: string`
48 44
4945 The name of the user The name of the user.
50
51 - `object: "organization.user"`
52
53 The object type, which is always `organization.user`
54
55 - `"organization.user"`
56
57 - `role: "owner" or "reader"`
58
59 `owner` or `reader`
60
61 - `"owner"`
62
63 - `"reader"`
64 46
65- `has_more: boolean`47- `has_more: boolean`
66 48
90 "data": [72 "data": [
91 {73 {
92 "id": "id",74 "id": "id",
93 "added_at": 0,
94 "email": "email",75 "email": "email",
9576 "name": "name", "name": "name"
96 "object": "organization.user",
97 "role": "owner"
98 }77 }
99 ],78 ],
100 "has_more": true,79 "has_more": true,
118 "object": "list",97 "object": "list",
119 "data": [98 "data": [
120 {99 {
121 "object": "organization.user",
122 "id": "user_abc123",100 "id": "user_abc123",
123 "name": "Ada Lovelace",101 "name": "Ada Lovelace",
124102 "email": "ada@example.com", "email": "ada@example.com"
125 "role": "owner",
126 "added_at": 1711471533
127 }103 }
128 ],104 ],
129 "has_more": false,105 "has_more": false,
24 24
25 The identifier, which can be referenced in API endpoints25 The identifier, which can be referenced in API endpoints
26 26
27 - `created_at: number`
28
29 The Unix timestamp (in seconds) of when the invite was sent.
30
27 - `email: string`31 - `email: string`
28 32
29 The email address of the individual to whom the invite was sent33 The email address of the individual to whom the invite was sent
30 34
3135 - `expires_at: number` - `object: "organization.invite"`
32 36
3337 The Unix timestamp (in seconds) of when the invite expires. The object type, which is always `organization.invite`
34 38
3539 - `invited_at: number` - `"organization.invite"`
36 40
3741 The Unix timestamp (in seconds) of when the invite was sent. - `projects: array of object { id, role }`
38 42
3943 - `object: "organization.invite"` The projects that were granted membership upon acceptance of the invite.
40 44
4145 The object type, which is always `organization.invite` - `id: string`
42 46
4347 - `"organization.invite"` Project's public ID
48
49 - `role: "member" or "owner"`
50
51 Project membership role
52
53 - `"member"`
54
55 - `"owner"`
44 56
45 - `role: "owner" or "reader"`57 - `role: "owner" or "reader"`
46 58
64 76
65 The Unix timestamp (in seconds) of when the invite was accepted.77 The Unix timestamp (in seconds) of when the invite was accepted.
66 78
6779 - `projects: optional array of object { id, role }` - `expires_at: optional number`
68
69 The projects that were granted membership upon acceptance of the invite.
70
71 - `id: optional string`
72
73 Project's public ID
74
75 - `role: optional "member" or "owner"`
76 80
7781 Project membership role The Unix timestamp (in seconds) of when the invite expires.
78 82
7983 - `"member"`- `has_more: boolean`
80 84
8185 - `"owner"` The `has_more` property is used for pagination to indicate there are additional results.
82 86
83- `object: "list"`87- `object: "list"`
84 88
90 94
91 The first `invite_id` in the retrieved `list`95 The first `invite_id` in the retrieved `list`
92 96
93- `has_more: optional boolean`
94
95 The `has_more` property is used for pagination to indicate there are additional results.
96
97- `last_id: optional string`97- `last_id: optional string`
98 98
99 The last `invite_id` in the retrieved `list`99 The last `invite_id` in the retrieved `list`
112 "data": [112 "data": [
113 {113 {
114 "id": "id",114 "id": "id",
115 "created_at": 0,
115 "email": "email",116 "email": "email",
116 "expires_at": 0,
117 "invited_at": 0,
118 "object": "organization.invite",117 "object": "organization.invite",
119 "role": "owner",
120 "status": "accepted",
121 "accepted_at": 0,
122 "projects": [118 "projects": [
123 {119 {
124 "id": "id",120 "id": "id",
125 "role": "member"121 "role": "member"
126 }122 }
127123 ] ],
124 "role": "owner",
125 "status": "accepted",
126 "accepted_at": 0,
127 "expires_at": 0
128 }128 }
129 ],129 ],
130 "has_more": true,
130 "object": "list",131 "object": "list",
131 "first_id": "first_id",132 "first_id": "first_id",
132 "has_more": true,
133 "last_id": "last_id"133 "last_id": "last_id"
134}134}
135```135```
154 "email": "user@example.com",154 "email": "user@example.com",
155 "role": "owner",155 "role": "owner",
156 "status": "accepted",156 "status": "accepted",
157157 "invited_at": 1711471533, "created_at": 1711471533,
158 "expires_at": 1711471533,158 "expires_at": 1711471533,
159 "accepted_at": 1711471533159 "accepted_at": 1711471533
160 }160 }
203 203
204### Returns204### Returns
205 205
206206- `Invite object { id, email, expires_at, 6 more }`- `Invite object { id, created_at, email, 6 more }`
207 207
208 Represents an individual `invite` to the organization.208 Represents an individual `invite` to the organization.
209 209
211 211
212 The identifier, which can be referenced in API endpoints212 The identifier, which can be referenced in API endpoints
213 213
214 - `created_at: number`
215
216 The Unix timestamp (in seconds) of when the invite was sent.
217
214 - `email: string`218 - `email: string`
215 219
216 The email address of the individual to whom the invite was sent220 The email address of the individual to whom the invite was sent
217 221
218222 - `expires_at: number` - `object: "organization.invite"`
219 223
220224 The Unix timestamp (in seconds) of when the invite expires. The object type, which is always `organization.invite`
221 225
222226 - `invited_at: number` - `"organization.invite"`
223 227
224228 The Unix timestamp (in seconds) of when the invite was sent. - `projects: array of object { id, role }`
225 229
226230 - `object: "organization.invite"` The projects that were granted membership upon acceptance of the invite.
227 231
228232 The object type, which is always `organization.invite` - `id: string`
229 233
230234 - `"organization.invite"` Project's public ID
235
236 - `role: "member" or "owner"`
237
238 Project membership role
239
240 - `"member"`
241
242 - `"owner"`
231 243
232 - `role: "owner" or "reader"`244 - `role: "owner" or "reader"`
233 245
251 263
252 The Unix timestamp (in seconds) of when the invite was accepted.264 The Unix timestamp (in seconds) of when the invite was accepted.
253 265
254266 - `projects: optional array of object { id, role }` - `expires_at: optional number`
255
256 The projects that were granted membership upon acceptance of the invite.
257
258 - `id: optional string`
259
260 Project's public ID
261
262 - `role: optional "member" or "owner"`
263
264 Project membership role
265
266 - `"member"`
267 267
268268 - `"owner"` The Unix timestamp (in seconds) of when the invite expires.
269 269
270### Example270### Example
271 271
284```json284```json
285{285{
286 "id": "id",286 "id": "id",
287 "created_at": 0,
287 "email": "email",288 "email": "email",
288 "expires_at": 0,
289 "invited_at": 0,
290 "object": "organization.invite",289 "object": "organization.invite",
291 "role": "owner",
292 "status": "accepted",
293 "accepted_at": 0,
294 "projects": [290 "projects": [
295 {291 {
296 "id": "id",292 "id": "id",
297 "role": "member"293 "role": "member"
298 }294 }
299295 ] ],
296 "role": "owner",
297 "status": "accepted",
298 "accepted_at": 0,
299 "expires_at": 0
300}300}
301```301```
302 302
331 "email": "anotheruser@example.com",331 "email": "anotheruser@example.com",
332 "role": "reader",332 "role": "reader",
333 "status": "pending",333 "status": "pending",
334334 "invited_at": 1711471533, "created_at": 1711471533,
335 "expires_at": 1711471533,335 "expires_at": 1711471533,
336 "accepted_at": null,336 "accepted_at": null,
337 "projects": [337 "projects": [
359 359
360### Returns360### Returns
361 361
362362- `Invite object { id, email, expires_at, 6 more }`- `Invite object { id, created_at, email, 6 more }`
363 363
364 Represents an individual `invite` to the organization.364 Represents an individual `invite` to the organization.
365 365
367 367
368 The identifier, which can be referenced in API endpoints368 The identifier, which can be referenced in API endpoints
369 369
370 - `created_at: number`
371
372 The Unix timestamp (in seconds) of when the invite was sent.
373
370 - `email: string`374 - `email: string`
371 375
372 The email address of the individual to whom the invite was sent376 The email address of the individual to whom the invite was sent
373 377
374378 - `expires_at: number` - `object: "organization.invite"`
375 379
376380 The Unix timestamp (in seconds) of when the invite expires. The object type, which is always `organization.invite`
377 381
378382 - `invited_at: number` - `"organization.invite"`
379 383
380384 The Unix timestamp (in seconds) of when the invite was sent. - `projects: array of object { id, role }`
381 385
382386 - `object: "organization.invite"` The projects that were granted membership upon acceptance of the invite.
383 387
384388 The object type, which is always `organization.invite` - `id: string`
385 389
386390 - `"organization.invite"` Project's public ID
391
392 - `role: "member" or "owner"`
393
394 Project membership role
395
396 - `"member"`
397
398 - `"owner"`
387 399
388 - `role: "owner" or "reader"`400 - `role: "owner" or "reader"`
389 401
407 419
408 The Unix timestamp (in seconds) of when the invite was accepted.420 The Unix timestamp (in seconds) of when the invite was accepted.
409 421
410422 - `projects: optional array of object { id, role }` - `expires_at: optional number`
411
412 The projects that were granted membership upon acceptance of the invite.
413
414 - `id: optional string`
415 423
416424 Project's public ID The Unix timestamp (in seconds) of when the invite expires.
417
418 - `role: optional "member" or "owner"`
419
420 Project membership role
421
422 - `"member"`
423
424 - `"owner"`
425 425
426### Example426### Example
427 427
435```json435```json
436{436{
437 "id": "id",437 "id": "id",
438 "created_at": 0,
438 "email": "email",439 "email": "email",
439 "expires_at": 0,
440 "invited_at": 0,
441 "object": "organization.invite",440 "object": "organization.invite",
442 "role": "owner",
443 "status": "accepted",
444 "accepted_at": 0,
445 "projects": [441 "projects": [
446 {442 {
447 "id": "id",443 "id": "id",
448 "role": "member"444 "role": "member"
449 }445 }
450446 ] ],
447 "role": "owner",
448 "status": "accepted",
449 "accepted_at": 0,
450 "expires_at": 0
451}451}
452```452```
453 453
468 "email": "user@example.com",468 "email": "user@example.com",
469 "role": "owner",469 "role": "owner",
470 "status": "accepted",470 "status": "accepted",
471471 "invited_at": 1711471533, "created_at": 1711471533,
472 "expires_at": 1711471533,472 "expires_at": 1711471533,
473 "accepted_at": 1711471533473 "accepted_at": 1711471533
474}474}
536 536
537### Invite537### Invite
538 538
539539- `Invite object { id, email, expires_at, 6 more }`- `Invite object { id, created_at, email, 6 more }`
540 540
541 Represents an individual `invite` to the organization.541 Represents an individual `invite` to the organization.
542 542
544 544
545 The identifier, which can be referenced in API endpoints545 The identifier, which can be referenced in API endpoints
546 546
547 - `created_at: number`
548
549 The Unix timestamp (in seconds) of when the invite was sent.
550
547 - `email: string`551 - `email: string`
548 552
549 The email address of the individual to whom the invite was sent553 The email address of the individual to whom the invite was sent
550 554
551555 - `expires_at: number` - `object: "organization.invite"`
552 556
553557 The Unix timestamp (in seconds) of when the invite expires. The object type, which is always `organization.invite`
554 558
555559 - `invited_at: number` - `"organization.invite"`
556 560
557561 The Unix timestamp (in seconds) of when the invite was sent. - `projects: array of object { id, role }`
558 562
559563 - `object: "organization.invite"` The projects that were granted membership upon acceptance of the invite.
560 564
561565 The object type, which is always `organization.invite` - `id: string`
562 566
563567 - `"organization.invite"` Project's public ID
568
569 - `role: "member" or "owner"`
570
571 Project membership role
572
573 - `"member"`
574
575 - `"owner"`
564 576
565 - `role: "owner" or "reader"`577 - `role: "owner" or "reader"`
566 578
584 596
585 The Unix timestamp (in seconds) of when the invite was accepted.597 The Unix timestamp (in seconds) of when the invite was accepted.
586 598
587599 - `projects: optional array of object { id, role }` - `expires_at: optional number`
588
589 The projects that were granted membership upon acceptance of the invite.
590
591 - `id: optional string`
592
593 Project's public ID
594
595 - `role: optional "member" or "owner"`
596
597 Project membership role
598
599 - `"member"`
600 600
601601 - `"owner"` The Unix timestamp (in seconds) of when the invite expires.
602 602
603### Invite Delete Response603### Invite Delete Response
604 604
36 36
37### Returns37### Returns
38 38
3939- `Invite object { id, email, expires_at, 6 more }`- `Invite object { id, created_at, email, 6 more }`
40 40
41 Represents an individual `invite` to the organization.41 Represents an individual `invite` to the organization.
42 42
44 44
45 The identifier, which can be referenced in API endpoints45 The identifier, which can be referenced in API endpoints
46 46
47 - `created_at: number`
48
49 The Unix timestamp (in seconds) of when the invite was sent.
50
47 - `email: string`51 - `email: string`
48 52
49 The email address of the individual to whom the invite was sent53 The email address of the individual to whom the invite was sent
50 54
5155 - `expires_at: number` - `object: "organization.invite"`
52 56
5357 The Unix timestamp (in seconds) of when the invite expires. The object type, which is always `organization.invite`
54 58
5559 - `invited_at: number` - `"organization.invite"`
56 60
5761 The Unix timestamp (in seconds) of when the invite was sent. - `projects: array of object { id, role }`
58 62
5963 - `object: "organization.invite"` The projects that were granted membership upon acceptance of the invite.
60 64
6165 The object type, which is always `organization.invite` - `id: string`
62 66
6367 - `"organization.invite"` Project's public ID
68
69 - `role: "member" or "owner"`
70
71 Project membership role
72
73 - `"member"`
74
75 - `"owner"`
64 76
65 - `role: "owner" or "reader"`77 - `role: "owner" or "reader"`
66 78
84 96
85 The Unix timestamp (in seconds) of when the invite was accepted.97 The Unix timestamp (in seconds) of when the invite was accepted.
86 98
8799 - `projects: optional array of object { id, role }` - `expires_at: optional number`
88
89 The projects that were granted membership upon acceptance of the invite.
90
91 - `id: optional string`
92
93 Project's public ID
94
95 - `role: optional "member" or "owner"`
96
97 Project membership role
98
99 - `"member"`
100 100
101101 - `"owner"` The Unix timestamp (in seconds) of when the invite expires.
102 102
103### Example103### Example
104 104
117```json117```json
118{118{
119 "id": "id",119 "id": "id",
120 "created_at": 0,
120 "email": "email",121 "email": "email",
121 "expires_at": 0,
122 "invited_at": 0,
123 "object": "organization.invite",122 "object": "organization.invite",
124 "role": "owner",
125 "status": "accepted",
126 "accepted_at": 0,
127 "projects": [123 "projects": [
128 {124 {
129 "id": "id",125 "id": "id",
130 "role": "member"126 "role": "member"
131 }127 }
132128 ] ],
129 "role": "owner",
130 "status": "accepted",
131 "accepted_at": 0,
132 "expires_at": 0
133}133}
134```134```
135 135
164 "email": "anotheruser@example.com",164 "email": "anotheruser@example.com",
165 "role": "reader",165 "role": "reader",
166 "status": "pending",166 "status": "pending",
167167 "invited_at": 1711471533, "created_at": 1711471533,
168 "expires_at": 1711471533,168 "expires_at": 1711471533,
169 "accepted_at": null,169 "accepted_at": null,
170 "projects": [170 "projects": [
22 22
23 The identifier, which can be referenced in API endpoints23 The identifier, which can be referenced in API endpoints
24 24
25 - `created_at: number`
26
27 The Unix timestamp (in seconds) of when the invite was sent.
28
25 - `email: string`29 - `email: string`
26 30
27 The email address of the individual to whom the invite was sent31 The email address of the individual to whom the invite was sent
28 32
2933 - `expires_at: number` - `object: "organization.invite"`
30 34
3135 The Unix timestamp (in seconds) of when the invite expires. The object type, which is always `organization.invite`
32 36
3337 - `invited_at: number` - `"organization.invite"`
34 38
3539 The Unix timestamp (in seconds) of when the invite was sent. - `projects: array of object { id, role }`
36 40
3741 - `object: "organization.invite"` The projects that were granted membership upon acceptance of the invite.
38 42
3943 The object type, which is always `organization.invite` - `id: string`
40 44
4145 - `"organization.invite"` Project's public ID
46
47 - `role: "member" or "owner"`
48
49 Project membership role
50
51 - `"member"`
52
53 - `"owner"`
42 54
43 - `role: "owner" or "reader"`55 - `role: "owner" or "reader"`
44 56
62 74
63 The Unix timestamp (in seconds) of when the invite was accepted.75 The Unix timestamp (in seconds) of when the invite was accepted.
64 76
6577 - `projects: optional array of object { id, role }` - `expires_at: optional number`
66
67 The projects that were granted membership upon acceptance of the invite.
68
69 - `id: optional string`
70
71 Project's public ID
72
73 - `role: optional "member" or "owner"`
74 78
7579 Project membership role The Unix timestamp (in seconds) of when the invite expires.
76 80
7781 - `"member"`- `has_more: boolean`
78 82
7983 - `"owner"` The `has_more` property is used for pagination to indicate there are additional results.
80 84
81- `object: "list"`85- `object: "list"`
82 86
88 92
89 The first `invite_id` in the retrieved `list`93 The first `invite_id` in the retrieved `list`
90 94
91- `has_more: optional boolean`
92
93 The `has_more` property is used for pagination to indicate there are additional results.
94
95- `last_id: optional string`95- `last_id: optional string`
96 96
97 The last `invite_id` in the retrieved `list`97 The last `invite_id` in the retrieved `list`
110 "data": [110 "data": [
111 {111 {
112 "id": "id",112 "id": "id",
113 "created_at": 0,
113 "email": "email",114 "email": "email",
114 "expires_at": 0,
115 "invited_at": 0,
116 "object": "organization.invite",115 "object": "organization.invite",
117 "role": "owner",
118 "status": "accepted",
119 "accepted_at": 0,
120 "projects": [116 "projects": [
121 {117 {
122 "id": "id",118 "id": "id",
123 "role": "member"119 "role": "member"
124 }120 }
125121 ] ],
122 "role": "owner",
123 "status": "accepted",
124 "accepted_at": 0,
125 "expires_at": 0
126 }126 }
127 ],127 ],
128 "has_more": true,
128 "object": "list",129 "object": "list",
129 "first_id": "first_id",130 "first_id": "first_id",
130 "has_more": true,
131 "last_id": "last_id"131 "last_id": "last_id"
132}132}
133```133```
152 "email": "user@example.com",152 "email": "user@example.com",
153 "role": "owner",153 "role": "owner",
154 "status": "accepted",154 "status": "accepted",
155155 "invited_at": 1711471533, "created_at": 1711471533,
156 "expires_at": 1711471533,156 "expires_at": 1711471533,
157 "accepted_at": 1711471533157 "accepted_at": 1711471533
158 }158 }
10 10
11### Returns11### Returns
12 12
1313- `Invite object { id, email, expires_at, 6 more }`- `Invite object { id, created_at, email, 6 more }`
14 14
15 Represents an individual `invite` to the organization.15 Represents an individual `invite` to the organization.
16 16
18 18
19 The identifier, which can be referenced in API endpoints19 The identifier, which can be referenced in API endpoints
20 20
21 - `created_at: number`
22
23 The Unix timestamp (in seconds) of when the invite was sent.
24
21 - `email: string`25 - `email: string`
22 26
23 The email address of the individual to whom the invite was sent27 The email address of the individual to whom the invite was sent
24 28
2529 - `expires_at: number` - `object: "organization.invite"`
26 30
2731 The Unix timestamp (in seconds) of when the invite expires. The object type, which is always `organization.invite`
28 32
2933 - `invited_at: number` - `"organization.invite"`
30 34
3135 The Unix timestamp (in seconds) of when the invite was sent. - `projects: array of object { id, role }`
32 36
3337 - `object: "organization.invite"` The projects that were granted membership upon acceptance of the invite.
34 38
3539 The object type, which is always `organization.invite` - `id: string`
36 40
3741 - `"organization.invite"` Project's public ID
42
43 - `role: "member" or "owner"`
44
45 Project membership role
46
47 - `"member"`
48
49 - `"owner"`
38 50
39 - `role: "owner" or "reader"`51 - `role: "owner" or "reader"`
40 52
58 70
59 The Unix timestamp (in seconds) of when the invite was accepted.71 The Unix timestamp (in seconds) of when the invite was accepted.
60 72
6173 - `projects: optional array of object { id, role }` - `expires_at: optional number`
62
63 The projects that were granted membership upon acceptance of the invite.
64
65 - `id: optional string`
66
67 Project's public ID
68
69 - `role: optional "member" or "owner"`
70 74
7175 Project membership role The Unix timestamp (in seconds) of when the invite expires.
72
73 - `"member"`
74
75 - `"owner"`
76 76
77### Example77### Example
78 78
86```json86```json
87{87{
88 "id": "id",88 "id": "id",
89 "created_at": 0,
89 "email": "email",90 "email": "email",
90 "expires_at": 0,
91 "invited_at": 0,
92 "object": "organization.invite",91 "object": "organization.invite",
93 "role": "owner",
94 "status": "accepted",
95 "accepted_at": 0,
96 "projects": [92 "projects": [
97 {93 {
98 "id": "id",94 "id": "id",
99 "role": "member"95 "role": "member"
100 }96 }
10197 ] ],
98 "role": "owner",
99 "status": "accepted",
100 "accepted_at": 0,
101 "expires_at": 0
102}102}
103```103```
104 104
119 "email": "user@example.com",119 "email": "user@example.com",
120 "role": "owner",120 "role": "owner",
121 "status": "accepted",121 "status": "accepted",
122122 "invited_at": 1711471533, "created_at": 1711471533,
123 "expires_at": 1711471533,123 "expires_at": 1711471533,
124 "accepted_at": 1711471533124 "accepted_at": 1711471533
125}125}
32 32
33 The Unix timestamp (in seconds) of when the project was created.33 The Unix timestamp (in seconds) of when the project was created.
34 34
35 - `name: string`
36
37 The name of the project. This appears in reporting.
38
39 - `object: "organization.project"`35 - `object: "organization.project"`
40 36
41 The object type, which is always `organization.project`37 The object type, which is always `organization.project`
42 38
43 - `"organization.project"`39 - `"organization.project"`
44 40
4541 - `status: "active" or "archived"` - `archived_at: optional number`
46 42
4743 `active` or `archived` The Unix timestamp (in seconds) of when the project was archived or `null`.
48 44
4945 - `"active"` - `external_key_id: optional string`
50 46
5147 - `"archived"` The external key associated with the project.
52 48
5349 - `archived_at: optional number` - `name: optional string`
54 50
5551 The Unix timestamp (in seconds) of when the project was archived or `null`. The name of the project. This appears in reporting.
56 52
5753- `first_id: string` - `status: optional string`
58 54
5955- `has_more: boolean` `active` or `archived`
60 56
6157- `last_id: string`- `has_more: boolean`
62 58
63- `object: "list"`59- `object: "list"`
64 60
65 - `"list"`61 - `"list"`
66 62
63- `first_id: optional string`
64
65- `last_id: optional string`
66
67### Example67### Example
68 68
69```http69```http
79 {79 {
80 "id": "id",80 "id": "id",
81 "created_at": 0,81 "created_at": 0,
82 "name": "name",
83 "object": "organization.project",82 "object": "organization.project",
8483 "status": "active", "archived_at": 0,
8584 "archived_at": 0 "external_key_id": "external_key_id",
85 "name": "name",
86 "status": "status"
86 }87 }
87 ],88 ],
88 "first_id": "first_id",
89 "has_more": true,89 "has_more": true,
9090 "last_id": "last_id", "object": "list",
9191 "object": "list" "first_id": "first_id",
92 "last_id": "last_id"
92}93}
93```94```
94 95
133 134
134 The friendly name of the project, this name appears in reports.135 The friendly name of the project, this name appears in reports.
135 136
136137- `geography: optional "US" or "EU" or "JP" or 5 more`- `external_key_id: optional string`
137 138
138139 Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field. External key ID to associate with the project.
139
140 - `"US"`
141
142 - `"EU"`
143
144 - `"JP"`
145
146 - `"IN"`
147
148 - `"KR"`
149 140
150141 - `"CA"`- `geography: optional string`
151 142
152143 - `"AU"` Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field.
153
154 - `"SG"`
155 144
156### Returns145### Returns
157 146
158147- `Project object { id, created_at, name, 3 more }`- `Project object { id, created_at, object, 4 more }`
159 148
160 Represents an individual project.149 Represents an individual project.
161 150
167 156
168 The Unix timestamp (in seconds) of when the project was created.157 The Unix timestamp (in seconds) of when the project was created.
169 158
170 - `name: string`
171
172 The name of the project. This appears in reporting.
173
174 - `object: "organization.project"`159 - `object: "organization.project"`
175 160
176 The object type, which is always `organization.project`161 The object type, which is always `organization.project`
177 162
178 - `"organization.project"`163 - `"organization.project"`
179 164
180165 - `status: "active" or "archived"` - `archived_at: optional number`
181 166
182167 `active` or `archived` The Unix timestamp (in seconds) of when the project was archived or `null`.
183 168
184169 - `"active"` - `external_key_id: optional string`
185 170
186171 - `"archived"` The external key associated with the project.
187 172
188173 - `archived_at: optional number` - `name: optional string`
189 174
190175 The Unix timestamp (in seconds) of when the project was archived or `null`. The name of the project. This appears in reporting.
176
177 - `status: optional string`
178
179 `active` or `archived`
191 180
192### Example181### Example
193 182
206{195{
207 "id": "id",196 "id": "id",
208 "created_at": 0,197 "created_at": 0,
209 "name": "name",
210 "object": "organization.project",198 "object": "organization.project",
211199 "status": "active", "archived_at": 0,
212200 "archived_at": 0 "external_key_id": "external_key_id",
201 "name": "name",
202 "status": "status"
213}203}
214```204```
215 205
249 239
250### Returns240### Returns
251 241
252242- `Project object { id, created_at, name, 3 more }`- `Project object { id, created_at, object, 4 more }`
253 243
254 Represents an individual project.244 Represents an individual project.
255 245
261 251
262 The Unix timestamp (in seconds) of when the project was created.252 The Unix timestamp (in seconds) of when the project was created.
263 253
264 - `name: string`
265
266 The name of the project. This appears in reporting.
267
268 - `object: "organization.project"`254 - `object: "organization.project"`
269 255
270 The object type, which is always `organization.project`256 The object type, which is always `organization.project`
271 257
272 - `"organization.project"`258 - `"organization.project"`
273 259
274260 - `status: "active" or "archived"` - `archived_at: optional number`
275 261
276262 `active` or `archived` The Unix timestamp (in seconds) of when the project was archived or `null`.
277 263
278264 - `"active"` - `external_key_id: optional string`
279 265
280266 - `"archived"` The external key associated with the project.
281 267
282268 - `archived_at: optional number` - `name: optional string`
283 269
284270 The Unix timestamp (in seconds) of when the project was archived or `null`. The name of the project. This appears in reporting.
271
272 - `status: optional string`
273
274 `active` or `archived`
285 275
286### Example276### Example
287 277
296{286{
297 "id": "id",287 "id": "id",
298 "created_at": 0,288 "created_at": 0,
299 "name": "name",
300 "object": "organization.project",289 "object": "organization.project",
301290 "status": "active", "archived_at": 0,
302291 "archived_at": 0 "external_key_id": "external_key_id",
292 "name": "name",
293 "status": "status"
303}294}
304```295```
305 296
336 327
337### Body Parameters328### Body Parameters
338 329
339330- `name: string`- `external_key_id: optional string`
331
332 External key ID to associate with the project.
333
334- `geography: optional string`
335
336 Geography for the project.
337
338- `name: optional string`
340 339
341 The updated name of the project, this name appears in reports.340 The updated name of the project, this name appears in reports.
342 341
343### Returns342### Returns
344 343
345344- `Project object { id, created_at, name, 3 more }`- `Project object { id, created_at, object, 4 more }`
346 345
347 Represents an individual project.346 Represents an individual project.
348 347
354 353
355 The Unix timestamp (in seconds) of when the project was created.354 The Unix timestamp (in seconds) of when the project was created.
356 355
357 - `name: string`
358
359 The name of the project. This appears in reporting.
360
361 - `object: "organization.project"`356 - `object: "organization.project"`
362 357
363 The object type, which is always `organization.project`358 The object type, which is always `organization.project`
364 359
365 - `"organization.project"`360 - `"organization.project"`
366 361
367362 - `status: "active" or "archived"` - `archived_at: optional number`
368 363
369364 `active` or `archived` The Unix timestamp (in seconds) of when the project was archived or `null`.
370 365
371366 - `"active"` - `external_key_id: optional string`
372 367
373368 - `"archived"` The external key associated with the project.
374 369
375370 - `archived_at: optional number` - `name: optional string`
376 371
377372 The Unix timestamp (in seconds) of when the project was archived or `null`. The name of the project. This appears in reporting.
373
374 - `status: optional string`
375
376 `active` or `archived`
378 377
379### Example378### Example
380 379
382curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \381curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \
383 -H 'Content-Type: application/json' \382 -H 'Content-Type: application/json' \
384 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \383 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
385384 -d '{ -d '{}'
386 "name": "name"
387 }'
388```385```
389 386
390#### Response387#### Response
393{390{
394 "id": "id",391 "id": "id",
395 "created_at": 0,392 "created_at": 0,
396 "name": "name",
397 "object": "organization.project",393 "object": "organization.project",
398394 "status": "active", "archived_at": 0,
399395 "archived_at": 0 "external_key_id": "external_key_id",
396 "name": "name",
397 "status": "status"
400}398}
401```399```
402 400
423 421
424### Returns422### Returns
425 423
426424- `Project object { id, created_at, name, 3 more }`- `Project object { id, created_at, object, 4 more }`
427 425
428 Represents an individual project.426 Represents an individual project.
429 427
435 433
436 The Unix timestamp (in seconds) of when the project was created.434 The Unix timestamp (in seconds) of when the project was created.
437 435
438 - `name: string`
439
440 The name of the project. This appears in reporting.
441
442 - `object: "organization.project"`436 - `object: "organization.project"`
443 437
444 The object type, which is always `organization.project`438 The object type, which is always `organization.project`
445 439
446 - `"organization.project"`440 - `"organization.project"`
447 441
448442 - `status: "active" or "archived"` - `archived_at: optional number`
443
444 The Unix timestamp (in seconds) of when the project was archived or `null`.
449 445
450446 `active` or `archived` - `external_key_id: optional string`
451 447
452448 - `"active"` The external key associated with the project.
453 449
454450 - `"archived"` - `name: optional string`
455 451
456452 - `archived_at: optional number` The name of the project. This appears in reporting.
457 453
458454 The Unix timestamp (in seconds) of when the project was archived or `null`. - `status: optional string`
455
456 `active` or `archived`
459 457
460### Example458### Example
461 459
471{469{
472 "id": "id",470 "id": "id",
473 "created_at": 0,471 "created_at": 0,
474 "name": "name",
475 "object": "organization.project",472 "object": "organization.project",
476473 "status": "active", "archived_at": 0,
477474 "archived_at": 0 "external_key_id": "external_key_id",
475 "name": "name",
476 "status": "status"
478}477}
479```478```
480 479
503 502
504### Project503### Project
505 504
506505- `Project object { id, created_at, name, 3 more }`- `Project object { id, created_at, object, 4 more }`
507 506
508 Represents an individual project.507 Represents an individual project.
509 508
515 514
516 The Unix timestamp (in seconds) of when the project was created.515 The Unix timestamp (in seconds) of when the project was created.
517 516
518 - `name: string`
519
520 The name of the project. This appears in reporting.
521
522 - `object: "organization.project"`517 - `object: "organization.project"`
523 518
524 The object type, which is always `organization.project`519 The object type, which is always `organization.project`
525 520
526 - `"organization.project"`521 - `"organization.project"`
527 522
528523 - `status: "active" or "archived"` - `archived_at: optional number`
529 524
530525 `active` or `archived` The Unix timestamp (in seconds) of when the project was archived or `null`.
531 526
532527 - `"active"` - `external_key_id: optional string`
533 528
534529 - `"archived"` The external key associated with the project.
535 530
536531 - `archived_at: optional number` - `name: optional string`
537 532
538533 The Unix timestamp (in seconds) of when the project was archived or `null`. The name of the project. This appears in reporting.
534
535 - `status: optional string`
536
537 `active` or `archived`
539 538
540# Users539# Users
541 540
571 570
572 The Unix timestamp (in seconds) of when the project was added.571 The Unix timestamp (in seconds) of when the project was added.
573 572
574 - `email: string`
575
576 The email address of the user
577
578 - `name: string`
579
580 The name of the user
581
582 - `object: "organization.project.user"`573 - `object: "organization.project.user"`
583 574
584 The object type, which is always `organization.project.user`575 The object type, which is always `organization.project.user`
585 576
586 - `"organization.project.user"`577 - `"organization.project.user"`
587 578
588579 - `role: "owner" or "member"` - `role: string`
589 580
590 `owner` or `member`581 `owner` or `member`
591 582
592583 - `"owner"` - `email: optional string`
593 584
594585 - `"member"` The email address of the user
595 586
596587- `first_id: string` - `name: optional string`
597 588
598589- `has_more: boolean` The name of the user
599 590
600591- `last_id: string`- `has_more: boolean`
601 592
602- `object: string`593- `object: string`
603 594
595- `first_id: optional string`
596
597- `last_id: optional string`
598
604### Example599### Example
605 600
606```http601```http
616 {611 {
617 "id": "id",612 "id": "id",
618 "added_at": 0,613 "added_at": 0,
619 "email": "email",
620 "name": "name",
621 "object": "organization.project.user",614 "object": "organization.project.user",
622615 "role": "owner" "role": "role",
616 "email": "email",
617 "name": "name"
623 }618 }
624 ],619 ],
625 "first_id": "first_id",
626 "has_more": true,620 "has_more": true,
627621 "last_id": "last_id", "object": "object",
628622 "object": "object" "first_id": "first_id",
623 "last_id": "last_id"
629}624}
630```625```
631 626
670 665
671### Body Parameters666### Body Parameters
672 667
673668- `role: "owner" or "member"`- `role: string`
674 669
675 `owner` or `member`670 `owner` or `member`
676 671
677672 - `"owner"`- `email: optional string`
678 673
679674 - `"member"` Email of the user to add.
680 675
681676- `user_id: string`- `user_id: optional string`
682 677
683 The ID of the user.678 The ID of the user.
684 679
685### Returns680### Returns
686 681
687682- `ProjectUser object { id, added_at, email, 3 more }`- `ProjectUser object { id, added_at, object, 3 more }`
688 683
689 Represents an individual user in a project.684 Represents an individual user in a project.
690 685
696 691
697 The Unix timestamp (in seconds) of when the project was added.692 The Unix timestamp (in seconds) of when the project was added.
698 693
699 - `email: string`
700
701 The email address of the user
702
703 - `name: string`
704
705 The name of the user
706
707 - `object: "organization.project.user"`694 - `object: "organization.project.user"`
708 695
709 The object type, which is always `organization.project.user`696 The object type, which is always `organization.project.user`
710 697
711 - `"organization.project.user"`698 - `"organization.project.user"`
712 699
713700 - `role: "owner" or "member"` - `role: string`
714 701
715 `owner` or `member`702 `owner` or `member`
716 703
717704 - `"owner"` - `email: optional string`
718 705
719706 - `"member"` The email address of the user
707
708 - `name: optional string`
709
710 The name of the user
720 711
721### Example712### Example
722 713
725 -H 'Content-Type: application/json' \716 -H 'Content-Type: application/json' \
726 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \717 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
727 -d '{718 -d '{
728719 "role": "owner", "role": "role"
729 "user_id": "user_id"
730 }'720 }'
731```721```
732 722
736{726{
737 "id": "id",727 "id": "id",
738 "added_at": 0,728 "added_at": 0,
739 "email": "email",
740 "name": "name",
741 "object": "organization.project.user",729 "object": "organization.project.user",
742730 "role": "owner" "role": "role",
731 "email": "email",
732 "name": "name"
743}733}
744```734```
745 735
781 771
782### Returns772### Returns
783 773
784774- `ProjectUser object { id, added_at, email, 3 more }`- `ProjectUser object { id, added_at, object, 3 more }`
785 775
786 Represents an individual user in a project.776 Represents an individual user in a project.
787 777
793 783
794 The Unix timestamp (in seconds) of when the project was added.784 The Unix timestamp (in seconds) of when the project was added.
795 785
796 - `email: string`
797
798 The email address of the user
799
800 - `name: string`
801
802 The name of the user
803
804 - `object: "organization.project.user"`786 - `object: "organization.project.user"`
805 787
806 The object type, which is always `organization.project.user`788 The object type, which is always `organization.project.user`
807 789
808 - `"organization.project.user"`790 - `"organization.project.user"`
809 791
810792 - `role: "owner" or "member"` - `role: string`
811 793
812 `owner` or `member`794 `owner` or `member`
813 795
814796 - `"owner"` - `email: optional string`
815 797
816798 - `"member"` The email address of the user
799
800 - `name: optional string`
801
802 The name of the user
817 803
818### Example804### Example
819 805
828{814{
829 "id": "id",815 "id": "id",
830 "added_at": 0,816 "added_at": 0,
831 "email": "email",
832 "name": "name",
833 "object": "organization.project.user",817 "object": "organization.project.user",
834818 "role": "owner" "role": "role",
819 "email": "email",
820 "name": "name"
835}821}
836```822```
837 823
870 856
871### Body Parameters857### Body Parameters
872 858
873859- `role: "owner" or "member"`- `role: optional string`
874 860
875 `owner` or `member`861 `owner` or `member`
876 862
877 - `"owner"`
878
879 - `"member"`
880
881### Returns863### Returns
882 864
883865- `ProjectUser object { id, added_at, email, 3 more }`- `ProjectUser object { id, added_at, object, 3 more }`
884 866
885 Represents an individual user in a project.867 Represents an individual user in a project.
886 868
892 874
893 The Unix timestamp (in seconds) of when the project was added.875 The Unix timestamp (in seconds) of when the project was added.
894 876
895 - `email: string`
896
897 The email address of the user
898
899 - `name: string`
900
901 The name of the user
902
903 - `object: "organization.project.user"`877 - `object: "organization.project.user"`
904 878
905 The object type, which is always `organization.project.user`879 The object type, which is always `organization.project.user`
906 880
907 - `"organization.project.user"`881 - `"organization.project.user"`
908 882
909883 - `role: "owner" or "member"` - `role: string`
910 884
911 `owner` or `member`885 `owner` or `member`
912 886
913887 - `"owner"` - `email: optional string`
914 888
915889 - `"member"` The email address of the user
890
891 - `name: optional string`
892
893 The name of the user
916 894
917### Example895### Example
918 896
920curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \898curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \
921 -H 'Content-Type: application/json' \899 -H 'Content-Type: application/json' \
922 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \900 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
923901 -d '{ -d '{}'
924 "role": "owner"
925 }'
926```902```
927 903
928#### Response904#### Response
931{907{
932 "id": "id",908 "id": "id",
933 "added_at": 0,909 "added_at": 0,
934 "email": "email",
935 "name": "name",
936 "object": "organization.project.user",910 "object": "organization.project.user",
937911 "role": "owner" "role": "role",
912 "email": "email",
913 "name": "name"
938}914}
939```915```
940 916
1027 1003
1028### Project User1004### Project User
1029 1005
10301006- `ProjectUser object { id, added_at, email, 3 more }`- `ProjectUser object { id, added_at, object, 3 more }`
1031 1007
1032 Represents an individual user in a project.1008 Represents an individual user in a project.
1033 1009
1039 1015
1040 The Unix timestamp (in seconds) of when the project was added.1016 The Unix timestamp (in seconds) of when the project was added.
1041 1017
1042 - `email: string`
1043
1044 The email address of the user
1045
1046 - `name: string`
1047
1048 The name of the user
1049
1050 - `object: "organization.project.user"`1018 - `object: "organization.project.user"`
1051 1019
1052 The object type, which is always `organization.project.user`1020 The object type, which is always `organization.project.user`
1053 1021
1054 - `"organization.project.user"`1022 - `"organization.project.user"`
1055 1023
10561024 - `role: "owner" or "member"` - `role: string`
1057 1025
1058 `owner` or `member`1026 `owner` or `member`
1059 1027
10601028 - `"owner"` - `email: optional string`
1061 1029
10621030 - `"member"` The email address of the user
1031
1032 - `name: optional string`
1033
1034 The name of the user
1063 1035
1064### User Delete Response1036### User Delete Response
1065 1037
1319 1291
1320 The Unix timestamp (in seconds) of when the user was added.1292 The Unix timestamp (in seconds) of when the user was added.
1321 1293
13221294 - `email: string` - `object: "organization.user"`
1295
1296 The object type, which is always `organization.user`
1297
1298 - `"organization.user"`
1299
1300 - `api_key_last_used_at: optional number`
1301
1302 The Unix timestamp (in seconds) of the user's last API key usage.
1303
1304 - `created: optional number`
1305
1306 The Unix timestamp (in seconds) of when the user was created.
1307
1308 - `developer_persona: optional string`
1309
1310 The developer persona metadata for the user.
1311
1312 - `email: optional string`
1323 1313
1324 The email address of the user1314 The email address of the user
1325 1315
13261316 - `name: string` - `is_default: optional boolean`
1317
1318 Whether this is the organization's default user.
1319
1320 - `is_scale_tier_authorized_purchaser: optional boolean`
1321
1322 Whether the user is an authorized purchaser for Scale Tier.
1323
1324 - `is_scim_managed: optional boolean`
1325
1326 Whether the user is managed through SCIM.
1327
1328 - `is_service_account: optional boolean`
1329
1330 Whether the user is a service account.
1331
1332 - `name: optional string`
1327 1333
1328 The name of the user1334 The name of the user
1329 1335
13301336 - `object: "organization.user"` - `projects: optional object { data, object }`
1331 1337
13321338 The object type, which is always `organization.user` Projects associated with the user, if included.
1333 1339
13341340 - `"organization.user"` - `data: array of object { id, name, role }`
1341
1342 - `id: optional string`
1343
1344 - `name: optional string`
1345
1346 - `role: optional string`
1347
1348 - `object: "list"`
1349
1350 - `"list"`
1335 1351
13361352 - `role: "owner" or "reader"` - `role: optional string`
1337 1353
1338 `owner` or `reader`1354 `owner` or `reader`
1339 1355
13401356 - `"owner"` - `technical_level: optional string`
1357
1358 The technical level metadata for the user.
1341 1359
13421360 - `"reader"` - `user: optional object { id, object, banned, 5 more }`
1361
1362 Nested user details.
1363
1364 - `id: string`
1365
1366 - `object: "user"`
1367
1368 - `"user"`
1369
1370 - `banned: optional boolean`
1371
1372 - `banned_at: optional number`
1373
1374 - `email: optional string`
1375
1376 - `enabled: optional boolean`
1377
1378 - `name: optional string`
1379
1380 - `picture: optional string`
1343 1381
1344### Example1382### Example
1345 1383
1371 "user": {1409 "user": {
1372 "id": "id",1410 "id": "id",
1373 "added_at": 0,1411 "added_at": 0,
1412 "object": "organization.user",
1413 "api_key_last_used_at": 0,
1414 "created": 0,
1415 "developer_persona": "developer_persona",
1374 "email": "email",1416 "email": "email",
1417 "is_default": true,
1418 "is_scale_tier_authorized_purchaser": true,
1419 "is_scim_managed": true,
1420 "is_service_account": true,
1375 "name": "name",1421 "name": "name",
13761422 "object": "organization.user", "projects": {
13771423 "role": "owner" "data": [
1424 {
1425 "id": "id",
1426 "name": "name",
1427 "role": "role"
1428 }
1429 ],
1430 "object": "list"
1431 },
1432 "role": "role",
1433 "technical_level": "technical_level",
1434 "user": {
1435 "id": "id",
1436 "object": "user",
1437 "banned": true,
1438 "banned_at": 0,
1439 "email": "email",
1440 "enabled": true,
1441 "name": "name",
1442 "picture": "picture"
1443 }
1378 }1444 }
1379}1445}
1380```1446```
1586 1652
1587 The Unix timestamp (in seconds) of when the user was added.1653 The Unix timestamp (in seconds) of when the user was added.
1588 1654
15891655 - `email: string` - `object: "organization.user"`
1656
1657 The object type, which is always `organization.user`
1658
1659 - `"organization.user"`
1660
1661 - `api_key_last_used_at: optional number`
1662
1663 The Unix timestamp (in seconds) of the user's last API key usage.
1664
1665 - `created: optional number`
1666
1667 The Unix timestamp (in seconds) of when the user was created.
1668
1669 - `developer_persona: optional string`
1670
1671 The developer persona metadata for the user.
1672
1673 - `email: optional string`
1590 1674
1591 The email address of the user1675 The email address of the user
1592 1676
15931677 - `name: string` - `is_default: optional boolean`
1678
1679 Whether this is the organization's default user.
1680
1681 - `is_scale_tier_authorized_purchaser: optional boolean`
1682
1683 Whether the user is an authorized purchaser for Scale Tier.
1684
1685 - `is_scim_managed: optional boolean`
1686
1687 Whether the user is managed through SCIM.
1688
1689 - `is_service_account: optional boolean`
1690
1691 Whether the user is a service account.
1692
1693 - `name: optional string`
1594 1694
1595 The name of the user1695 The name of the user
1596 1696
15971697 - `object: "organization.user"` - `projects: optional object { data, object }`
1598 1698
15991699 The object type, which is always `organization.user` Projects associated with the user, if included.
1600 1700
16011701 - `"organization.user"` - `data: array of object { id, name, role }`
1702
1703 - `id: optional string`
1704
1705 - `name: optional string`
1706
1707 - `role: optional string`
1708
1709 - `object: "list"`
1602 1710
16031711 - `role: "owner" or "reader"` - `"list"`
1712
1713 - `role: optional string`
1604 1714
1605 `owner` or `reader`1715 `owner` or `reader`
1606 1716
16071717 - `"owner"` - `technical_level: optional string`
1718
1719 The technical level metadata for the user.
1720
1721 - `user: optional object { id, object, banned, 5 more }`
1722
1723 Nested user details.
1608 1724
16091725 - `"reader"` - `id: string`
1726
1727 - `object: "user"`
1728
1729 - `"user"`
1730
1731 - `banned: optional boolean`
1732
1733 - `banned_at: optional number`
1734
1735 - `email: optional string`
1736
1737 - `enabled: optional boolean`
1738
1739 - `name: optional string`
1740
1741 - `picture: optional string`
1610 1742
1611### Role Delete Response1743### Role Delete Response
1612 1744
1674 1806
1675 - `"member"`1807 - `"member"`
1676 1808
1677- `first_id: string`
1678
1679- `has_more: boolean`1809- `has_more: boolean`
1680 1810
1681- `last_id: string`
1682
1683- `object: "list"`1811- `object: "list"`
1684 1812
1685 - `"list"`1813 - `"list"`
1686 1814
1815- `first_id: optional string`
1816
1817- `last_id: optional string`
1818
1687### Example1819### Example
1688 1820
1689```http1821```http
1704 "role": "owner"1836 "role": "owner"
1705 }1837 }
1706 ],1838 ],
1707 "first_id": "first_id",
1708 "has_more": true,1839 "has_more": true,
17091840 "last_id": "last_id", "object": "list",
17101841 "object": "list" "first_id": "first_id",
1842 "last_id": "last_id"
1711}1843}
1712```1844```
1713 1845
2125 2257
2126 - `owner: object { service_account, type, user }`2258 - `owner: object { service_account, type, user }`
2127 2259
21282260 - `service_account: optional ProjectServiceAccount` - `service_account: optional object { id, created_at, name, role }`
2129 2261
21302262 Represents an individual service account in a project. The service account that owns a project API key.
2131 2263
2132 - `id: string`2264 - `id: string`
2133 2265
2135 2267
2136 - `created_at: number`2268 - `created_at: number`
2137 2269
21382270 The Unix timestamp (in seconds) of when the service account was created The Unix timestamp (in seconds) of when the service account was created.
2139 2271
2140 - `name: string`2272 - `name: string`
2141 2273
21422274 The name of the service account The name of the service account.
2143
2144 - `object: "organization.project.service_account"`
2145
2146 The object type, which is always `organization.project.service_account`
2147
2148 - `"organization.project.service_account"`
2149
2150 - `role: "owner" or "member"`
2151 2275
21522276 `owner` or `member` - `role: string`
2153
2154 - `"owner"`
2155 2277
21562278 - `"member"` The service account's project role.
2157 2279
2158 - `type: optional "user" or "service_account"`2280 - `type: optional "user" or "service_account"`
2159 2281
2163 2285
2164 - `"service_account"`2286 - `"service_account"`
2165 2287
21662288 - `user: optional ProjectUser` - `user: optional object { id, created_at, email, 2 more }`
2167 2289
21682290 Represents an individual user in a project. The user that owns a project API key.
2169 2291
2170 - `id: string`2292 - `id: string`
2171 2293
2172 The identifier, which can be referenced in API endpoints2294 The identifier, which can be referenced in API endpoints
2173 2295
21742296 - `added_at: number` - `created_at: number`
2175 2297
21762298 The Unix timestamp (in seconds) of when the project was added. The Unix timestamp (in seconds) of when the user was created.
2177 2299
2178 - `email: string`2300 - `email: string`
2179 2301
21802302 The email address of the user The email address of the user.
2181 2303
2182 - `name: string`2304 - `name: string`
2183 2305
21842306 The name of the user The name of the user.
2185
2186 - `object: "organization.project.user"`
2187
2188 The object type, which is always `organization.project.user`
2189
2190 - `"organization.project.user"`
2191
2192 - `role: "owner" or "member"`
2193 2307
21942308 `owner` or `member` - `role: string`
2195
2196 - `"owner"`
2197 2309
21982310 - `"member"` The user's project role.
2199 2311
2200 - `redacted_value: string`2312 - `redacted_value: string`
2201 2313
2202 The redacted value of the API key2314 The redacted value of the API key
2203 2315
22042316- `first_id: string`- `has_more: boolean`
2205
2206- `has_more: boolean`
2207
2208- `last_id: string`
2209 2317
2210- `object: "list"`2318- `object: "list"`
2211 2319
2212 - `"list"`2320 - `"list"`
2213 2321
2322- `first_id: optional string`
2323
2324- `last_id: optional string`
2325
2214### Example2326### Example
2215 2327
2216```http2328```http
2234 "id": "id",2346 "id": "id",
2235 "created_at": 0,2347 "created_at": 0,
2236 "name": "name",2348 "name": "name",
22372349 "object": "organization.project.service_account", "role": "role"
2238 "role": "owner"
2239 },2350 },
2240 "type": "user",2351 "type": "user",
2241 "user": {2352 "user": {
2242 "id": "id",2353 "id": "id",
22432354 "added_at": 0, "created_at": 0,
2244 "email": "email",2355 "email": "email",
2245 "name": "name",2356 "name": "name",
22462357 "object": "organization.project.user", "role": "role"
2247 "role": "owner"
2248 }2358 }
2249 },2359 },
2250 "redacted_value": "redacted_value"2360 "redacted_value": "redacted_value"
2251 }2361 }
2252 ],2362 ],
2253 "first_id": "first_id",
2254 "has_more": true,2363 "has_more": true,
22552364 "last_id": "last_id", "object": "list",
22562365 "object": "list" "first_id": "first_id",
2366 "last_id": "last_id"
2257}2367}
2258```2368```
2259 2369
2281 "owner": {2391 "owner": {
2282 "type": "user",2392 "type": "user",
2283 "user": {2393 "user": {
2284 "object": "organization.project.user",
2285 "id": "user_abc",2394 "id": "user_abc",
2286 "name": "First Last",2395 "name": "First Last",
2287 "email": "user@example.com",2396 "email": "user@example.com",
2288 "role": "owner",2397 "role": "owner",
22892398 "added_at": 1711471533 "created_at": 1711471533
2290 }2399 }
2291 }2400 }
2292 }2401 }
2299 2408
2300## Retrieve project API key2409## Retrieve project API key
2301 2410
23022411**get** `/organization/projects/{project_id}/api_keys/{key_id}`**get** `/organization/projects/{project_id}/api_keys/{api_key_id}`
2303 2412
2304Retrieves an API key in the project.2413Retrieves an API key in the project.
2305 2414
2307 2416
2308- `project_id: string`2417- `project_id: string`
2309 2418
23102419- `key_id: string`- `api_key_id: string`
2311 2420
2312### Returns2421### Returns
2313 2422
2339 2448
2340 - `owner: object { service_account, type, user }`2449 - `owner: object { service_account, type, user }`
2341 2450
23422451 - `service_account: optional ProjectServiceAccount` - `service_account: optional object { id, created_at, name, role }`
2343 2452
23442453 Represents an individual service account in a project. The service account that owns a project API key.
2345 2454
2346 - `id: string`2455 - `id: string`
2347 2456
2349 2458
2350 - `created_at: number`2459 - `created_at: number`
2351 2460
23522461 The Unix timestamp (in seconds) of when the service account was created The Unix timestamp (in seconds) of when the service account was created.
2353 2462
2354 - `name: string`2463 - `name: string`
2355 2464
23562465 The name of the service account The name of the service account.
2357
2358 - `object: "organization.project.service_account"`
2359
2360 The object type, which is always `organization.project.service_account`
2361
2362 - `"organization.project.service_account"`
2363
2364 - `role: "owner" or "member"`
2365
2366 `owner` or `member`
2367 2466
23682467 - `"owner"` - `role: string`
2369 2468
23702469 - `"member"` The service account's project role.
2371 2470
2372 - `type: optional "user" or "service_account"`2471 - `type: optional "user" or "service_account"`
2373 2472
2377 2476
2378 - `"service_account"`2477 - `"service_account"`
2379 2478
23802479 - `user: optional ProjectUser` - `user: optional object { id, created_at, email, 2 more }`
2381 2480
23822481 Represents an individual user in a project. The user that owns a project API key.
2383 2482
2384 - `id: string`2483 - `id: string`
2385 2484
2386 The identifier, which can be referenced in API endpoints2485 The identifier, which can be referenced in API endpoints
2387 2486
23882487 - `added_at: number` - `created_at: number`
2389 2488
23902489 The Unix timestamp (in seconds) of when the project was added. The Unix timestamp (in seconds) of when the user was created.
2391 2490
2392 - `email: string`2491 - `email: string`
2393 2492
23942493 The email address of the user The email address of the user.
2395 2494
2396 - `name: string`2495 - `name: string`
2397 2496
23982497 The name of the user The name of the user.
2399
2400 - `object: "organization.project.user"`
2401
2402 The object type, which is always `organization.project.user`
2403
2404 - `"organization.project.user"`
2405
2406 - `role: "owner" or "member"`
2407
2408 `owner` or `member`
2409 2498
24102499 - `"owner"` - `role: string`
2411 2500
24122501 - `"member"` The user's project role.
2413 2502
2414 - `redacted_value: string`2503 - `redacted_value: string`
2415 2504
2418### Example2507### Example
2419 2508
2420```http2509```http
24212510curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$API_KEY_ID \
2422 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"2511 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
2423```2512```
2424 2513
2436 "id": "id",2525 "id": "id",
2437 "created_at": 0,2526 "created_at": 0,
2438 "name": "name",2527 "name": "name",
24392528 "object": "organization.project.service_account", "role": "role"
2440 "role": "owner"
2441 },2529 },
2442 "type": "user",2530 "type": "user",
2443 "user": {2531 "user": {
2444 "id": "id",2532 "id": "id",
24452533 "added_at": 0, "created_at": 0,
2446 "email": "email",2534 "email": "email",
2447 "name": "name",2535 "name": "name",
24482536 "object": "organization.project.user", "role": "role"
2449 "role": "owner"
2450 }2537 }
2451 },2538 },
2452 "redacted_value": "redacted_value"2539 "redacted_value": "redacted_value"
2474 "owner": {2561 "owner": {
2475 "type": "user",2562 "type": "user",
2476 "user": {2563 "user": {
2477 "object": "organization.project.user",
2478 "id": "user_abc",2564 "id": "user_abc",
2479 "name": "First Last",2565 "name": "First Last",
2480 "email": "user@example.com",2566 "email": "user@example.com",
2481 "role": "owner",2567 "role": "owner",
24822568 "added_at": 1711471533 "created_at": 1711471533
2483 }2569 }
2484 }2570 }
2485}2571}
2487 2573
2488## Delete project API key2574## Delete project API key
2489 2575
24902576**delete** `/organization/projects/{project_id}/api_keys/{key_id}`**delete** `/organization/projects/{project_id}/api_keys/{api_key_id}`
2491 2577
2492Deletes an API key from the project.2578Deletes an API key from the project.
2493 2579
2498 2584
2499- `project_id: string`2585- `project_id: string`
2500 2586
25012587- `key_id: string`- `api_key_id: string`
2502 2588
2503### Returns2589### Returns
2504 2590
2513### Example2599### Example
2514 2600
2515```http2601```http
25162602curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$API_KEY_ID \
2517 -X DELETE \2603 -X DELETE \
2518 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"2604 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
2519```2605```
2578 2664
2579 - `owner: object { service_account, type, user }`2665 - `owner: object { service_account, type, user }`
2580 2666
25812667 - `service_account: optional ProjectServiceAccount` - `service_account: optional object { id, created_at, name, role }`
2582 2668
25832669 Represents an individual service account in a project. The service account that owns a project API key.
2584 2670
2585 - `id: string`2671 - `id: string`
2586 2672
2588 2674
2589 - `created_at: number`2675 - `created_at: number`
2590 2676
25912677 The Unix timestamp (in seconds) of when the service account was created The Unix timestamp (in seconds) of when the service account was created.
2592 2678
2593 - `name: string`2679 - `name: string`
2594 2680
25952681 The name of the service account The name of the service account.
2596
2597 - `object: "organization.project.service_account"`
2598
2599 The object type, which is always `organization.project.service_account`
2600
2601 - `"organization.project.service_account"`
2602
2603 - `role: "owner" or "member"`
2604
2605 `owner` or `member`
2606 2682
26072683 - `"owner"` - `role: string`
2608 2684
26092685 - `"member"` The service account's project role.
2610 2686
2611 - `type: optional "user" or "service_account"`2687 - `type: optional "user" or "service_account"`
2612 2688
2616 2692
2617 - `"service_account"`2693 - `"service_account"`
2618 2694
26192695 - `user: optional ProjectUser` - `user: optional object { id, created_at, email, 2 more }`
2620 2696
26212697 Represents an individual user in a project. The user that owns a project API key.
2622 2698
2623 - `id: string`2699 - `id: string`
2624 2700
2625 The identifier, which can be referenced in API endpoints2701 The identifier, which can be referenced in API endpoints
2626 2702
26272703 - `added_at: number` - `created_at: number`
2628 2704
26292705 The Unix timestamp (in seconds) of when the project was added. The Unix timestamp (in seconds) of when the user was created.
2630 2706
2631 - `email: string`2707 - `email: string`
2632 2708
26332709 The email address of the user The email address of the user.
2634 2710
2635 - `name: string`2711 - `name: string`
2636 2712
26372713 The name of the user The name of the user.
2638
2639 - `object: "organization.project.user"`
2640
2641 The object type, which is always `organization.project.user`
2642
2643 - `"organization.project.user"`
2644
2645 - `role: "owner" or "member"`
2646
2647 `owner` or `member`
2648 2714
26492715 - `"owner"` - `role: string`
2650 2716
26512717 - `"member"` The user's project role.
2652 2718
2653 - `redacted_value: string`2719 - `redacted_value: string`
2654 2720
2734 2800
2735 The maximum requests per day. Only present for relevant models.2801 The maximum requests per day. Only present for relevant models.
2736 2802
2737- `first_id: string`
2738
2739- `has_more: boolean`2803- `has_more: boolean`
2740 2804
2741- `last_id: string`
2742
2743- `object: "list"`2805- `object: "list"`
2744 2806
2745 - `"list"`2807 - `"list"`
2746 2808
2809- `first_id: optional string`
2810
2811- `last_id: optional string`
2812
2747### Example2813### Example
2748 2814
2749```http2815```http
2768 "max_requests_per_1_day": 02834 "max_requests_per_1_day": 0
2769 }2835 }
2770 ],2836 ],
2771 "first_id": "first_id",
2772 "has_more": true,2837 "has_more": true,
27732838 "last_id": "last_id", "object": "list",
27742839 "object": "list" "first_id": "first_id",
2840 "last_id": "last_id"
2775}2841}
2776```2842```
2777 2843
3029 3095
3030 Display name of the group.3096 Display name of the group.
3031 3097
3098 - `group_type: string`
3099
3100 The type of the group.
3101
3032 - `object: "project.group"`3102 - `object: "project.group"`
3033 3103
3034 Always `project.group`.3104 Always `project.group`.
3069 "created_at": 0,3139 "created_at": 0,
3070 "group_id": "group_id",3140 "group_id": "group_id",
3071 "group_name": "group_name",3141 "group_name": "group_name",
3142 "group_type": "group_type",
3072 "object": "project.group",3143 "object": "project.group",
3073 "project_id": "project_id"3144 "project_id": "project_id"
3074 }3145 }
3128 3199
3129### Returns3200### Returns
3130 3201
31313202- `ProjectGroup object { created_at, group_id, group_name, 2 more }`- `ProjectGroup object { created_at, group_id, group_name, 3 more }`
3132 3203
3133 Details about a group's membership in a project.3204 Details about a group's membership in a project.
3134 3205
3144 3215
3145 Display name of the group.3216 Display name of the group.
3146 3217
3218 - `group_type: string`
3219
3220 The type of the group.
3221
3147 - `object: "project.group"`3222 - `object: "project.group"`
3148 3223
3149 Always `project.group`.3224 Always `project.group`.
3173 "created_at": 0,3248 "created_at": 0,
3174 "group_id": "group_id",3249 "group_id": "group_id",
3175 "group_name": "group_name",3250 "group_name": "group_name",
3251 "group_type": "group_type",
3176 "object": "project.group",3252 "object": "project.group",
3177 "project_id": "project_id"3253 "project_id": "project_id"
3178}3254}
3264 3340
3265### Project Group3341### Project Group
3266 3342
32673343- `ProjectGroup object { created_at, group_id, group_name, 2 more }`- `ProjectGroup object { created_at, group_id, group_name, 3 more }`
3268 3344
3269 Details about a group's membership in a project.3345 Details about a group's membership in a project.
3270 3346
3280 3356
3281 Display name of the group.3357 Display name of the group.
3282 3358
3359 - `group_type: string`
3360
3361 The type of the group.
3362
3283 - `object: "project.group"`3363 - `object: "project.group"`
3284 3364
3285 Always `project.group`.3365 Always `project.group`.
4340 4420
4341### Returns4421### Returns
4342 4422
43434423- `data: array of Certificate`- `data: array of object { id, active, certificate_details, 3 more }`
4344 4424
4345 - `id: string`4425 - `id: string`
4346 4426
4347 The identifier, which can be referenced in API endpoints4427 The identifier, which can be referenced in API endpoints
4348 4428
43494429 - `certificate_details: object { content, expires_at, valid_at }` - `active: boolean`
4350 4430
43514431 - `content: optional string` Whether the certificate is currently active at the project level.
4352 4432
43534433 The content of the certificate in PEM format. - `certificate_details: object { expires_at, valid_at }`
4354 4434
4355 - `expires_at: optional number`4435 - `expires_at: optional number`
4356 4436
4368 4448
4369 The name of the certificate.4449 The name of the certificate.
4370 4450
43714451 - `object: "certificate" or "organization.certificate" or "organization.project.certificate"` - `object: "organization.project.certificate"`
4372
4373 The object type.
4374 4452
43754453 - If creating, updating, or getting a specific certificate, the object type is `certificate`. The object type, which is always `organization.project.certificate`.
4376 - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`.
4377 - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`.
4378
4379 - `"certificate"`
4380
4381 - `"organization.certificate"`
4382 4454
4383 - `"organization.project.certificate"`4455 - `"organization.project.certificate"`
4384 4456
43854457 - `active: optional boolean`- `first_id: string`
4386
4387 Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate.
4388 4458
4389- `has_more: boolean`4459- `has_more: boolean`
4390 4460
4461- `last_id: string`
4462
4391- `object: "list"`4463- `object: "list"`
4392 4464
4393 - `"list"`4465 - `"list"`
4394 4466
4395- `first_id: optional string`
4396
4397- `last_id: optional string`
4398
4399### Example4467### Example
4400 4468
4401```http4469```http
4410 "data": [4478 "data": [
4411 {4479 {
4412 "id": "id",4480 "id": "id",
4481 "active": true,
4413 "certificate_details": {4482 "certificate_details": {
4414 "content": "content",
4415 "expires_at": 0,4483 "expires_at": 0,
4416 "valid_at": 04484 "valid_at": 0
4417 },4485 },
4418 "created_at": 0,4486 "created_at": 0,
4419 "name": "name",4487 "name": "name",
44204488 "object": "certificate", "object": "organization.project.certificate"
4421 "active": true
4422 }4489 }
4423 ],4490 ],
4424 "has_more": true,
4425 "object": "list",
4426 "first_id": "cert_abc",4491 "first_id": "cert_abc",
44274492 "last_id": "cert_abc" "has_more": true,
4493 "last_id": "cert_abc",
4494 "object": "list"
4428}4495}
4429```4496```
4430 4497
4477 4544
4478### Returns4545### Returns
4479 4546
44804547- `data: array of Certificate`- `data: array of object { id, active, certificate_details, 3 more }`
4481 4548
4482 - `id: string`4549 - `id: string`
4483 4550
4484 The identifier, which can be referenced in API endpoints4551 The identifier, which can be referenced in API endpoints
4485 4552
44864553 - `certificate_details: object { content, expires_at, valid_at }` - `active: boolean`
4487 4554
44884555 - `content: optional string` Whether the certificate is currently active at the project level.
4489 4556
44904557 The content of the certificate in PEM format. - `certificate_details: object { expires_at, valid_at }`
4491 4558
4492 - `expires_at: optional number`4559 - `expires_at: optional number`
4493 4560
4505 4572
4506 The name of the certificate.4573 The name of the certificate.
4507 4574
45084575 - `object: "certificate" or "organization.certificate" or "organization.project.certificate"` - `object: "organization.project.certificate"`
4509 4576
45104577 The object type. The object type, which is always `organization.project.certificate`.
4511
4512 - If creating, updating, or getting a specific certificate, the object type is `certificate`.
4513 - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`.
4514 - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`.
4515
4516 - `"certificate"`
4517
4518 - `"organization.certificate"`
4519 4578
4520 - `"organization.project.certificate"`4579 - `"organization.project.certificate"`
4521 4580
45224581 - `active: optional boolean`- `object: "organization.project.certificate.activation"`
4523
4524 Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate.
4525 4582
45264583- `has_more: boolean` The project certificate activation result type.
4527
4528- `object: "list"`
4529
4530 - `"list"`
4531
4532- `first_id: optional string`
4533 4584
45344585- `last_id: optional string` - `"organization.project.certificate.activation"`
4535 4586
4536### Example4587### Example
4537 4588
4553 "data": [4604 "data": [
4554 {4605 {
4555 "id": "id",4606 "id": "id",
4607 "active": true,
4556 "certificate_details": {4608 "certificate_details": {
4557 "content": "content",
4558 "expires_at": 0,4609 "expires_at": 0,
4559 "valid_at": 04610 "valid_at": 0
4560 },4611 },
4561 "created_at": 0,4612 "created_at": 0,
4562 "name": "name",4613 "name": "name",
45634614 "object": "certificate", "object": "organization.project.certificate"
4564 "active": true
4565 }4615 }
4566 ],4616 ],
45674617 "has_more": true, "object": "organization.project.certificate.activation"
4568 "object": "list",
4569 "first_id": "cert_abc",
4570 "last_id": "cert_abc"
4571}4618}
4572```4619```
4573 4620
4578-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \4625-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
4579-H "Content-Type: application/json" \4626-H "Content-Type: application/json" \
4580-d '{4627-d '{
45814628 "data": ["cert_abc", "cert_def"] "certificate_ids": ["cert_abc", "cert_def"]
4582}'4629}'
4583```4630```
4584 4631
4631 4678
4632### Returns4679### Returns
4633 4680
46344681- `data: array of Certificate`- `data: array of object { id, active, certificate_details, 3 more }`
4635 4682
4636 - `id: string`4683 - `id: string`
4637 4684
4638 The identifier, which can be referenced in API endpoints4685 The identifier, which can be referenced in API endpoints
4639 4686
46404687 - `certificate_details: object { content, expires_at, valid_at }` - `active: boolean`
4641 4688
46424689 - `content: optional string` Whether the certificate is currently active at the project level.
4643 4690
46444691 The content of the certificate in PEM format. - `certificate_details: object { expires_at, valid_at }`
4645 4692
4646 - `expires_at: optional number`4693 - `expires_at: optional number`
4647 4694
4659 4706
4660 The name of the certificate.4707 The name of the certificate.
4661 4708
46624709 - `object: "certificate" or "organization.certificate" or "organization.project.certificate"` - `object: "organization.project.certificate"`
4663 4710
46644711 The object type. The object type, which is always `organization.project.certificate`.
4665
4666 - If creating, updating, or getting a specific certificate, the object type is `certificate`.
4667 - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`.
4668 - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`.
4669
4670 - `"certificate"`
4671
4672 - `"organization.certificate"`
4673 4712
4674 - `"organization.project.certificate"`4713 - `"organization.project.certificate"`
4675 4714
46764715 - `active: optional boolean`- `object: "organization.project.certificate.deactivation"`
4677
4678 Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate.
4679 4716
46804717- `has_more: boolean` The project certificate deactivation result type.
4681
4682- `object: "list"`
4683
4684 - `"list"`
4685
4686- `first_id: optional string`
4687 4718
46884719- `last_id: optional string` - `"organization.project.certificate.deactivation"`
4689 4720
4690### Example4721### Example
4691 4722
4707 "data": [4738 "data": [
4708 {4739 {
4709 "id": "id",4740 "id": "id",
4741 "active": true,
4710 "certificate_details": {4742 "certificate_details": {
4711 "content": "content",
4712 "expires_at": 0,4743 "expires_at": 0,
4713 "valid_at": 04744 "valid_at": 0
4714 },4745 },
4715 "created_at": 0,4746 "created_at": 0,
4716 "name": "name",4747 "name": "name",
47174748 "object": "certificate", "object": "organization.project.certificate"
4718 "active": true
4719 }4749 }
4720 ],4750 ],
47214751 "has_more": true, "object": "organization.project.certificate.deactivation"
4722 "object": "list",
4723 "first_id": "cert_abc",
4724 "last_id": "cert_abc"
4725}4752}
4726```4753```
4727 4754
4732-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \4759-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
4733-H "Content-Type: application/json" \4760-H "Content-Type: application/json" \
4734-d '{4761-d '{
47354762 "data": ["cert_abc", "cert_def"] "certificate_ids": ["cert_abc", "cert_def"]
4736}'4763}'
4737```4764```
4738 4765
4767 ],4794 ],
4768}4795}
4769```4796```
4797
4798## Domain Types
4799
4800### Certificate List Response
4801
4802- `CertificateListResponse object { id, active, certificate_details, 3 more }`
4803
4804 Represents an individual certificate configured at the project level.
4805
4806 - `id: string`
4807
4808 The identifier, which can be referenced in API endpoints
4809
4810 - `active: boolean`
4811
4812 Whether the certificate is currently active at the project level.
4813
4814 - `certificate_details: object { expires_at, valid_at }`
4815
4816 - `expires_at: optional number`
4817
4818 The Unix timestamp (in seconds) of when the certificate expires.
4819
4820 - `valid_at: optional number`
4821
4822 The Unix timestamp (in seconds) of when the certificate becomes valid.
4823
4824 - `created_at: number`
4825
4826 The Unix timestamp (in seconds) of when the certificate was uploaded.
4827
4828 - `name: string`
4829
4830 The name of the certificate.
4831
4832 - `object: "organization.project.certificate"`
4833
4834 The object type, which is always `organization.project.certificate`.
4835
4836 - `"organization.project.certificate"`
4837
4838### Certificate Activate Response
4839
4840- `CertificateActivateResponse object { id, active, certificate_details, 3 more }`
4841
4842 Represents an individual certificate configured at the project level.
4843
4844 - `id: string`
4845
4846 The identifier, which can be referenced in API endpoints
4847
4848 - `active: boolean`
4849
4850 Whether the certificate is currently active at the project level.
4851
4852 - `certificate_details: object { expires_at, valid_at }`
4853
4854 - `expires_at: optional number`
4855
4856 The Unix timestamp (in seconds) of when the certificate expires.
4857
4858 - `valid_at: optional number`
4859
4860 The Unix timestamp (in seconds) of when the certificate becomes valid.
4861
4862 - `created_at: number`
4863
4864 The Unix timestamp (in seconds) of when the certificate was uploaded.
4865
4866 - `name: string`
4867
4868 The name of the certificate.
4869
4870 - `object: "organization.project.certificate"`
4871
4872 The object type, which is always `organization.project.certificate`.
4873
4874 - `"organization.project.certificate"`
4875
4876### Certificate Deactivate Response
4877
4878- `CertificateDeactivateResponse object { id, active, certificate_details, 3 more }`
4879
4880 Represents an individual certificate configured at the project level.
4881
4882 - `id: string`
4883
4884 The identifier, which can be referenced in API endpoints
4885
4886 - `active: boolean`
4887
4888 Whether the certificate is currently active at the project level.
4889
4890 - `certificate_details: object { expires_at, valid_at }`
4891
4892 - `expires_at: optional number`
4893
4894 The Unix timestamp (in seconds) of when the certificate expires.
4895
4896 - `valid_at: optional number`
4897
4898 The Unix timestamp (in seconds) of when the certificate becomes valid.
4899
4900 - `created_at: number`
4901
4902 The Unix timestamp (in seconds) of when the certificate was uploaded.
4903
4904 - `name: string`
4905
4906 The name of the certificate.
4907
4908 - `object: "organization.project.certificate"`
4909
4910 The object type, which is always `organization.project.certificate`.
4911
4912 - `"organization.project.certificate"`
10 10
11 The friendly name of the project, this name appears in reports.11 The friendly name of the project, this name appears in reports.
12 12
1313- `geography: optional "US" or "EU" or "JP" or 5 more`- `external_key_id: optional string`
14 14
1515 Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field. External key ID to associate with the project.
16
17 - `"US"`
18
19 - `"EU"`
20
21 - `"JP"`
22
23 - `"IN"`
24
25 - `"KR"`
26 16
2717 - `"CA"`- `geography: optional string`
28 18
2919 - `"AU"` Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field.
30
31 - `"SG"`
32 20
33### Returns21### Returns
34 22
3523- `Project object { id, created_at, name, 3 more }`- `Project object { id, created_at, object, 4 more }`
36 24
37 Represents an individual project.25 Represents an individual project.
38 26
44 32
45 The Unix timestamp (in seconds) of when the project was created.33 The Unix timestamp (in seconds) of when the project was created.
46 34
47 - `name: string`
48
49 The name of the project. This appears in reporting.
50
51 - `object: "organization.project"`35 - `object: "organization.project"`
52 36
53 The object type, which is always `organization.project`37 The object type, which is always `organization.project`
54 38
55 - `"organization.project"`39 - `"organization.project"`
56 40
5741 - `status: "active" or "archived"` - `archived_at: optional number`
58 42
5943 `active` or `archived` The Unix timestamp (in seconds) of when the project was archived or `null`.
60 44
6145 - `"active"` - `external_key_id: optional string`
62 46
6347 - `"archived"` The external key associated with the project.
64 48
6549 - `archived_at: optional number` - `name: optional string`
66 50
6751 The Unix timestamp (in seconds) of when the project was archived or `null`. The name of the project. This appears in reporting.
52
53 - `status: optional string`
54
55 `active` or `archived`
68 56
69### Example57### Example
70 58
83{71{
84 "id": "id",72 "id": "id",
85 "created_at": 0,73 "created_at": 0,
86 "name": "name",
87 "object": "organization.project",74 "object": "organization.project",
8875 "status": "active", "archived_at": 0,
8976 "archived_at": 0 "external_key_id": "external_key_id",
77 "name": "name",
78 "status": "status"
90}79}
91```80```
92 81
30 30
31 The Unix timestamp (in seconds) of when the project was created.31 The Unix timestamp (in seconds) of when the project was created.
32 32
33 - `name: string`
34
35 The name of the project. This appears in reporting.
36
37 - `object: "organization.project"`33 - `object: "organization.project"`
38 34
39 The object type, which is always `organization.project`35 The object type, which is always `organization.project`
40 36
41 - `"organization.project"`37 - `"organization.project"`
42 38
4339 - `status: "active" or "archived"` - `archived_at: optional number`
44 40
4541 `active` or `archived` The Unix timestamp (in seconds) of when the project was archived or `null`.
46 42
4743 - `"active"` - `external_key_id: optional string`
48 44
4945 - `"archived"` The external key associated with the project.
50 46
5147 - `archived_at: optional number` - `name: optional string`
52 48
5349 The Unix timestamp (in seconds) of when the project was archived or `null`. The name of the project. This appears in reporting.
54 50
5551- `first_id: string` - `status: optional string`
56 52
5753- `has_more: boolean` `active` or `archived`
58 54
5955- `last_id: string`- `has_more: boolean`
60 56
61- `object: "list"`57- `object: "list"`
62 58
63 - `"list"`59 - `"list"`
64 60
61- `first_id: optional string`
62
63- `last_id: optional string`
64
65### Example65### Example
66 66
67```http67```http
77 {77 {
78 "id": "id",78 "id": "id",
79 "created_at": 0,79 "created_at": 0,
80 "name": "name",
81 "object": "organization.project",80 "object": "organization.project",
8281 "status": "active", "archived_at": 0,
8382 "archived_at": 0 "external_key_id": "external_key_id",
83 "name": "name",
84 "status": "status"
84 }85 }
85 ],86 ],
86 "first_id": "first_id",
87 "has_more": true,87 "has_more": true,
8888 "last_id": "last_id", "object": "list",
8989 "object": "list" "first_id": "first_id",
90 "last_id": "last_id"
90}91}
91```92```
92 93
10 10
11### Returns11### Returns
12 12
1313- `Project object { id, created_at, name, 3 more }`- `Project object { id, created_at, object, 4 more }`
14 14
15 Represents an individual project.15 Represents an individual project.
16 16
22 22
23 The Unix timestamp (in seconds) of when the project was created.23 The Unix timestamp (in seconds) of when the project was created.
24 24
25 - `name: string`
26
27 The name of the project. This appears in reporting.
28
29 - `object: "organization.project"`25 - `object: "organization.project"`
30 26
31 The object type, which is always `organization.project`27 The object type, which is always `organization.project`
32 28
33 - `"organization.project"`29 - `"organization.project"`
34 30
3531 - `status: "active" or "archived"` - `archived_at: optional number`
36 32
3733 `active` or `archived` The Unix timestamp (in seconds) of when the project was archived or `null`.
38 34
3935 - `"active"` - `external_key_id: optional string`
40 36
4137 - `"archived"` The external key associated with the project.
42 38
4339 - `archived_at: optional number` - `name: optional string`
44 40
4541 The Unix timestamp (in seconds) of when the project was archived or `null`. The name of the project. This appears in reporting.
42
43 - `status: optional string`
44
45 `active` or `archived`
46 46
47### Example47### Example
48 48
57{57{
58 "id": "id",58 "id": "id",
59 "created_at": 0,59 "created_at": 0,
60 "name": "name",
61 "object": "organization.project",60 "object": "organization.project",
6261 "status": "active", "archived_at": 0,
6362 "archived_at": 0 "external_key_id": "external_key_id",
63 "name": "name",
64 "status": "status"
64}65}
65```66```
66 67
10 10
11### Body Parameters11### Body Parameters
12 12
1313- `name: string`- `external_key_id: optional string`
14
15 External key ID to associate with the project.
16
17- `geography: optional string`
18
19 Geography for the project.
20
21- `name: optional string`
14 22
15 The updated name of the project, this name appears in reports.23 The updated name of the project, this name appears in reports.
16 24
17### Returns25### Returns
18 26
1927- `Project object { id, created_at, name, 3 more }`- `Project object { id, created_at, object, 4 more }`
20 28
21 Represents an individual project.29 Represents an individual project.
22 30
28 36
29 The Unix timestamp (in seconds) of when the project was created.37 The Unix timestamp (in seconds) of when the project was created.
30 38
31 - `name: string`
32
33 The name of the project. This appears in reporting.
34
35 - `object: "organization.project"`39 - `object: "organization.project"`
36 40
37 The object type, which is always `organization.project`41 The object type, which is always `organization.project`
38 42
39 - `"organization.project"`43 - `"organization.project"`
40 44
4145 - `status: "active" or "archived"` - `archived_at: optional number`
42 46
4347 `active` or `archived` The Unix timestamp (in seconds) of when the project was archived or `null`.
44 48
4549 - `"active"` - `external_key_id: optional string`
46 50
4751 - `"archived"` The external key associated with the project.
48 52
4953 - `archived_at: optional number` - `name: optional string`
50 54
5155 The Unix timestamp (in seconds) of when the project was archived or `null`. The name of the project. This appears in reporting.
56
57 - `status: optional string`
58
59 `active` or `archived`
52 60
53### Example61### Example
54 62
56curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \64curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \
57 -H 'Content-Type: application/json' \65 -H 'Content-Type: application/json' \
58 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \66 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
5967 -d '{ -d '{}'
60 "name": "name"
61 }'
62```68```
63 69
64#### Response70#### Response
67{73{
68 "id": "id",74 "id": "id",
69 "created_at": 0,75 "created_at": 0,
70 "name": "name",
71 "object": "organization.project",76 "object": "organization.project",
7277 "status": "active", "archived_at": 0,
7378 "archived_at": 0 "external_key_id": "external_key_id",
79 "name": "name",
80 "status": "status"
74}81}
75```82```
76 83
resources/admin/subresources/organization/subresources/projects/subresources/api_keys/index.md +63 −129
48 48
49 - `owner: object { service_account, type, user }`49 - `owner: object { service_account, type, user }`
50 50
5151 - `service_account: optional ProjectServiceAccount` - `service_account: optional object { id, created_at, name, role }`
52 52
5353 Represents an individual service account in a project. The service account that owns a project API key.
54 54
55 - `id: string`55 - `id: string`
56 56
58 58
59 - `created_at: number`59 - `created_at: number`
60 60
6161 The Unix timestamp (in seconds) of when the service account was created The Unix timestamp (in seconds) of when the service account was created.
62 62
63 - `name: string`63 - `name: string`
64 64
6565 The name of the service account The name of the service account.
66 66
6767 - `object: "organization.project.service_account"` - `role: string`
68 68
6969 The object type, which is always `organization.project.service_account` The service account's project role.
70
71 - `"organization.project.service_account"`
72
73 - `role: "owner" or "member"`
74
75 `owner` or `member`
76
77 - `"owner"`
78
79 - `"member"`
80 70
81 - `type: optional "user" or "service_account"`71 - `type: optional "user" or "service_account"`
82 72
86 76
87 - `"service_account"`77 - `"service_account"`
88 78
8979 - `user: optional ProjectUser` - `user: optional object { id, created_at, email, 2 more }`
90 80
9181 Represents an individual user in a project. The user that owns a project API key.
92 82
93 - `id: string`83 - `id: string`
94 84
95 The identifier, which can be referenced in API endpoints85 The identifier, which can be referenced in API endpoints
96 86
9787 - `added_at: number` - `created_at: number`
98 88
9989 The Unix timestamp (in seconds) of when the project was added. The Unix timestamp (in seconds) of when the user was created.
100 90
101 - `email: string`91 - `email: string`
102 92
10393 The email address of the user The email address of the user.
104 94
105 - `name: string`95 - `name: string`
106 96
10797 The name of the user The name of the user.
108
109 - `object: "organization.project.user"`
110
111 The object type, which is always `organization.project.user`
112
113 - `"organization.project.user"`
114
115 - `role: "owner" or "member"`
116
117 `owner` or `member`
118 98
11999 - `"owner"` - `role: string`
120 100
121101 - `"member"` The user's project role.
122 102
123 - `redacted_value: string`103 - `redacted_value: string`
124 104
125 The redacted value of the API key105 The redacted value of the API key
126 106
127- `first_id: string`
128
129- `has_more: boolean`107- `has_more: boolean`
130 108
131- `last_id: string`
132
133- `object: "list"`109- `object: "list"`
134 110
135 - `"list"`111 - `"list"`
136 112
113- `first_id: optional string`
114
115- `last_id: optional string`
116
137### Example117### Example
138 118
139```http119```http
157 "id": "id",137 "id": "id",
158 "created_at": 0,138 "created_at": 0,
159 "name": "name",139 "name": "name",
160140 "object": "organization.project.service_account", "role": "role"
161 "role": "owner"
162 },141 },
163 "type": "user",142 "type": "user",
164 "user": {143 "user": {
165 "id": "id",144 "id": "id",
166145 "added_at": 0, "created_at": 0,
167 "email": "email",146 "email": "email",
168 "name": "name",147 "name": "name",
169148 "object": "organization.project.user", "role": "role"
170 "role": "owner"
171 }149 }
172 },150 },
173 "redacted_value": "redacted_value"151 "redacted_value": "redacted_value"
174 }152 }
175 ],153 ],
176 "first_id": "first_id",
177 "has_more": true,154 "has_more": true,
178155 "last_id": "last_id", "object": "list",
179156 "object": "list" "first_id": "first_id",
157 "last_id": "last_id"
180}158}
181```159```
182 160
204 "owner": {182 "owner": {
205 "type": "user",183 "type": "user",
206 "user": {184 "user": {
207 "object": "organization.project.user",
208 "id": "user_abc",185 "id": "user_abc",
209 "name": "First Last",186 "name": "First Last",
210 "email": "user@example.com",187 "email": "user@example.com",
211 "role": "owner",188 "role": "owner",
212189 "added_at": 1711471533 "created_at": 1711471533
213 }190 }
214 }191 }
215 }192 }
222 199
223## Retrieve project API key200## Retrieve project API key
224 201
225202**get** `/organization/projects/{project_id}/api_keys/{key_id}`**get** `/organization/projects/{project_id}/api_keys/{api_key_id}`
226 203
227Retrieves an API key in the project.204Retrieves an API key in the project.
228 205
230 207
231- `project_id: string`208- `project_id: string`
232 209
233210- `key_id: string`- `api_key_id: string`
234 211
235### Returns212### Returns
236 213
262 239
263 - `owner: object { service_account, type, user }`240 - `owner: object { service_account, type, user }`
264 241
265242 - `service_account: optional ProjectServiceAccount` - `service_account: optional object { id, created_at, name, role }`
266 243
267244 Represents an individual service account in a project. The service account that owns a project API key.
268 245
269 - `id: string`246 - `id: string`
270 247
272 249
273 - `created_at: number`250 - `created_at: number`
274 251
275252 The Unix timestamp (in seconds) of when the service account was created The Unix timestamp (in seconds) of when the service account was created.
276 253
277 - `name: string`254 - `name: string`
278 255
279256 The name of the service account The name of the service account.
280
281 - `object: "organization.project.service_account"`
282
283 The object type, which is always `organization.project.service_account`
284 257
285258 - `"organization.project.service_account"` - `role: string`
286 259
287260 - `role: "owner" or "member"` The service account's project role.
288
289 `owner` or `member`
290
291 - `"owner"`
292
293 - `"member"`
294 261
295 - `type: optional "user" or "service_account"`262 - `type: optional "user" or "service_account"`
296 263
300 267
301 - `"service_account"`268 - `"service_account"`
302 269
303270 - `user: optional ProjectUser` - `user: optional object { id, created_at, email, 2 more }`
304 271
305272 Represents an individual user in a project. The user that owns a project API key.
306 273
307 - `id: string`274 - `id: string`
308 275
309 The identifier, which can be referenced in API endpoints276 The identifier, which can be referenced in API endpoints
310 277
311278 - `added_at: number` - `created_at: number`
312 279
313280 The Unix timestamp (in seconds) of when the project was added. The Unix timestamp (in seconds) of when the user was created.
314 281
315 - `email: string`282 - `email: string`
316 283
317284 The email address of the user The email address of the user.
318 285
319 - `name: string`286 - `name: string`
320 287
321288 The name of the user The name of the user.
322
323 - `object: "organization.project.user"`
324
325 The object type, which is always `organization.project.user`
326 289
327290 - `"organization.project.user"` - `role: string`
328 291
329292 - `role: "owner" or "member"` The user's project role.
330
331 `owner` or `member`
332
333 - `"owner"`
334
335 - `"member"`
336 293
337 - `redacted_value: string`294 - `redacted_value: string`
338 295
341### Example298### Example
342 299
343```http300```http
344301curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$API_KEY_ID \
345 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"302 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
346```303```
347 304
359 "id": "id",316 "id": "id",
360 "created_at": 0,317 "created_at": 0,
361 "name": "name",318 "name": "name",
362319 "object": "organization.project.service_account", "role": "role"
363 "role": "owner"
364 },320 },
365 "type": "user",321 "type": "user",
366 "user": {322 "user": {
367 "id": "id",323 "id": "id",
368324 "added_at": 0, "created_at": 0,
369 "email": "email",325 "email": "email",
370 "name": "name",326 "name": "name",
371327 "object": "organization.project.user", "role": "role"
372 "role": "owner"
373 }328 }
374 },329 },
375 "redacted_value": "redacted_value"330 "redacted_value": "redacted_value"
397 "owner": {352 "owner": {
398 "type": "user",353 "type": "user",
399 "user": {354 "user": {
400 "object": "organization.project.user",
401 "id": "user_abc",355 "id": "user_abc",
402 "name": "First Last",356 "name": "First Last",
403 "email": "user@example.com",357 "email": "user@example.com",
404 "role": "owner",358 "role": "owner",
405359 "added_at": 1711471533 "created_at": 1711471533
406 }360 }
407 }361 }
408}362}
410 364
411## Delete project API key365## Delete project API key
412 366
413367**delete** `/organization/projects/{project_id}/api_keys/{key_id}`**delete** `/organization/projects/{project_id}/api_keys/{api_key_id}`
414 368
415Deletes an API key from the project.369Deletes an API key from the project.
416 370
421 375
422- `project_id: string`376- `project_id: string`
423 377
424378- `key_id: string`- `api_key_id: string`
425 379
426### Returns380### Returns
427 381
436### Example390### Example
437 391
438```http392```http
439393curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$API_KEY_ID \
440 -X DELETE \394 -X DELETE \
441 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"395 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
442```396```
501 455
502 - `owner: object { service_account, type, user }`456 - `owner: object { service_account, type, user }`
503 457
504458 - `service_account: optional ProjectServiceAccount` - `service_account: optional object { id, created_at, name, role }`
505 459
506460 Represents an individual service account in a project. The service account that owns a project API key.
507 461
508 - `id: string`462 - `id: string`
509 463
511 465
512 - `created_at: number`466 - `created_at: number`
513 467
514468 The Unix timestamp (in seconds) of when the service account was created The Unix timestamp (in seconds) of when the service account was created.
515 469
516 - `name: string`470 - `name: string`
517 471
518472 The name of the service account The name of the service account.
519
520 - `object: "organization.project.service_account"`
521 473
522474 The object type, which is always `organization.project.service_account` - `role: string`
523 475
524476 - `"organization.project.service_account"` The service account's project role.
525
526 - `role: "owner" or "member"`
527
528 `owner` or `member`
529
530 - `"owner"`
531
532 - `"member"`
533 477
534 - `type: optional "user" or "service_account"`478 - `type: optional "user" or "service_account"`
535 479
539 483
540 - `"service_account"`484 - `"service_account"`
541 485
542486 - `user: optional ProjectUser` - `user: optional object { id, created_at, email, 2 more }`
543 487
544488 Represents an individual user in a project. The user that owns a project API key.
545 489
546 - `id: string`490 - `id: string`
547 491
548 The identifier, which can be referenced in API endpoints492 The identifier, which can be referenced in API endpoints
549 493
550494 - `added_at: number` - `created_at: number`
551 495
552496 The Unix timestamp (in seconds) of when the project was added. The Unix timestamp (in seconds) of when the user was created.
553 497
554 - `email: string`498 - `email: string`
555 499
556500 The email address of the user The email address of the user.
557 501
558 - `name: string`502 - `name: string`
559 503
560504 The name of the user The name of the user.
561
562 - `object: "organization.project.user"`
563
564 The object type, which is always `organization.project.user`
565
566 - `"organization.project.user"`
567
568 - `role: "owner" or "member"`
569
570 `owner` or `member`
571 505
572506 - `"owner"` - `role: string`
573 507
574508 - `"member"` The user's project role.
575 509
576 - `redacted_value: string`510 - `redacted_value: string`
577 511
1## Delete project API key1## Delete project API key
2 2
33**delete** `/organization/projects/{project_id}/api_keys/{key_id}`**delete** `/organization/projects/{project_id}/api_keys/{api_key_id}`
4 4
5Deletes an API key from the project.5Deletes an API key from the project.
6 6
11 11
12- `project_id: string`12- `project_id: string`
13 13
1414- `key_id: string`- `api_key_id: string`
15 15
16### Returns16### Returns
17 17
26### Example26### Example
27 27
28```http28```http
2929curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$API_KEY_ID \
30 -X DELETE \30 -X DELETE \
31 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"31 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
32```32```
46 46
47 - `owner: object { service_account, type, user }`47 - `owner: object { service_account, type, user }`
48 48
4949 - `service_account: optional ProjectServiceAccount` - `service_account: optional object { id, created_at, name, role }`
50 50
5151 Represents an individual service account in a project. The service account that owns a project API key.
52 52
53 - `id: string`53 - `id: string`
54 54
56 56
57 - `created_at: number`57 - `created_at: number`
58 58
5959 The Unix timestamp (in seconds) of when the service account was created The Unix timestamp (in seconds) of when the service account was created.
60 60
61 - `name: string`61 - `name: string`
62 62
6363 The name of the service account The name of the service account.
64 64
6565 - `object: "organization.project.service_account"` - `role: string`
66 66
6767 The object type, which is always `organization.project.service_account` The service account's project role.
68
69 - `"organization.project.service_account"`
70
71 - `role: "owner" or "member"`
72
73 `owner` or `member`
74
75 - `"owner"`
76
77 - `"member"`
78 68
79 - `type: optional "user" or "service_account"`69 - `type: optional "user" or "service_account"`
80 70
84 74
85 - `"service_account"`75 - `"service_account"`
86 76
8777 - `user: optional ProjectUser` - `user: optional object { id, created_at, email, 2 more }`
88 78
8979 Represents an individual user in a project. The user that owns a project API key.
90 80
91 - `id: string`81 - `id: string`
92 82
93 The identifier, which can be referenced in API endpoints83 The identifier, which can be referenced in API endpoints
94 84
9585 - `added_at: number` - `created_at: number`
96 86
9787 The Unix timestamp (in seconds) of when the project was added. The Unix timestamp (in seconds) of when the user was created.
98 88
99 - `email: string`89 - `email: string`
100 90
10191 The email address of the user The email address of the user.
102 92
103 - `name: string`93 - `name: string`
104 94
10595 The name of the user The name of the user.
106
107 - `object: "organization.project.user"`
108
109 The object type, which is always `organization.project.user`
110
111 - `"organization.project.user"`
112
113 - `role: "owner" or "member"`
114 96
11597 `owner` or `member` - `role: string`
116 98
11799 - `"owner"` The user's project role.
118
119 - `"member"`
120 100
121 - `redacted_value: string`101 - `redacted_value: string`
122 102
123 The redacted value of the API key103 The redacted value of the API key
124 104
125- `first_id: string`
126
127- `has_more: boolean`105- `has_more: boolean`
128 106
129- `last_id: string`
130
131- `object: "list"`107- `object: "list"`
132 108
133 - `"list"`109 - `"list"`
134 110
111- `first_id: optional string`
112
113- `last_id: optional string`
114
135### Example115### Example
136 116
137```http117```http
155 "id": "id",135 "id": "id",
156 "created_at": 0,136 "created_at": 0,
157 "name": "name",137 "name": "name",
158138 "object": "organization.project.service_account", "role": "role"
159 "role": "owner"
160 },139 },
161 "type": "user",140 "type": "user",
162 "user": {141 "user": {
163 "id": "id",142 "id": "id",
164143 "added_at": 0, "created_at": 0,
165 "email": "email",144 "email": "email",
166 "name": "name",145 "name": "name",
167146 "object": "organization.project.user", "role": "role"
168 "role": "owner"
169 }147 }
170 },148 },
171 "redacted_value": "redacted_value"149 "redacted_value": "redacted_value"
172 }150 }
173 ],151 ],
174 "first_id": "first_id",
175 "has_more": true,152 "has_more": true,
176153 "last_id": "last_id", "object": "list",
177154 "object": "list" "first_id": "first_id",
155 "last_id": "last_id"
178}156}
179```157```
180 158
202 "owner": {180 "owner": {
203 "type": "user",181 "type": "user",
204 "user": {182 "user": {
205 "object": "organization.project.user",
206 "id": "user_abc",183 "id": "user_abc",
207 "name": "First Last",184 "name": "First Last",
208 "email": "user@example.com",185 "email": "user@example.com",
209 "role": "owner",186 "role": "owner",
210187 "added_at": 1711471533 "created_at": 1711471533
211 }188 }
212 }189 }
213 }190 }
1## Retrieve project API key1## Retrieve project API key
2 2
33**get** `/organization/projects/{project_id}/api_keys/{key_id}`**get** `/organization/projects/{project_id}/api_keys/{api_key_id}`
4 4
5Retrieves an API key in the project.5Retrieves an API key in the project.
6 6
8 8
9- `project_id: string`9- `project_id: string`
10 10
1111- `key_id: string`- `api_key_id: string`
12 12
13### Returns13### Returns
14 14
40 40
41 - `owner: object { service_account, type, user }`41 - `owner: object { service_account, type, user }`
42 42
4343 - `service_account: optional ProjectServiceAccount` - `service_account: optional object { id, created_at, name, role }`
44 44
4545 Represents an individual service account in a project. The service account that owns a project API key.
46 46
47 - `id: string`47 - `id: string`
48 48
50 50
51 - `created_at: number`51 - `created_at: number`
52 52
5353 The Unix timestamp (in seconds) of when the service account was created The Unix timestamp (in seconds) of when the service account was created.
54 54
55 - `name: string`55 - `name: string`
56 56
5757 The name of the service account The name of the service account.
58 58
5959 - `object: "organization.project.service_account"` - `role: string`
60 60
6161 The object type, which is always `organization.project.service_account` The service account's project role.
62
63 - `"organization.project.service_account"`
64
65 - `role: "owner" or "member"`
66
67 `owner` or `member`
68
69 - `"owner"`
70
71 - `"member"`
72 62
73 - `type: optional "user" or "service_account"`63 - `type: optional "user" or "service_account"`
74 64
78 68
79 - `"service_account"`69 - `"service_account"`
80 70
8171 - `user: optional ProjectUser` - `user: optional object { id, created_at, email, 2 more }`
82 72
8373 Represents an individual user in a project. The user that owns a project API key.
84 74
85 - `id: string`75 - `id: string`
86 76
87 The identifier, which can be referenced in API endpoints77 The identifier, which can be referenced in API endpoints
88 78
8979 - `added_at: number` - `created_at: number`
90 80
9181 The Unix timestamp (in seconds) of when the project was added. The Unix timestamp (in seconds) of when the user was created.
92 82
93 - `email: string`83 - `email: string`
94 84
9585 The email address of the user The email address of the user.
96 86
97 - `name: string`87 - `name: string`
98 88
9989 The name of the user The name of the user.
100 90
10191 - `object: "organization.project.user"` - `role: string`
102 92
10393 The object type, which is always `organization.project.user` The user's project role.
104
105 - `"organization.project.user"`
106
107 - `role: "owner" or "member"`
108
109 `owner` or `member`
110
111 - `"owner"`
112
113 - `"member"`
114 94
115 - `redacted_value: string`95 - `redacted_value: string`
116 96
119### Example99### Example
120 100
121```http101```http
122102curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$API_KEY_ID \
123 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"103 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
124```104```
125 105
137 "id": "id",117 "id": "id",
138 "created_at": 0,118 "created_at": 0,
139 "name": "name",119 "name": "name",
140120 "object": "organization.project.service_account", "role": "role"
141 "role": "owner"
142 },121 },
143 "type": "user",122 "type": "user",
144 "user": {123 "user": {
145 "id": "id",124 "id": "id",
146125 "added_at": 0, "created_at": 0,
147 "email": "email",126 "email": "email",
148 "name": "name",127 "name": "name",
149128 "object": "organization.project.user", "role": "role"
150 "role": "owner"
151 }129 }
152 },130 },
153 "redacted_value": "redacted_value"131 "redacted_value": "redacted_value"
175 "owner": {153 "owner": {
176 "type": "user",154 "type": "user",
177 "user": {155 "user": {
178 "object": "organization.project.user",
179 "id": "user_abc",156 "id": "user_abc",
180 "name": "First Last",157 "name": "First Last",
181 "email": "user@example.com",158 "email": "user@example.com",
182 "role": "owner",159 "role": "owner",
183160 "added_at": 1711471533 "created_at": 1711471533
184 }161 }
185 }162 }
186}163}
46 46
47 Display name of the group.47 Display name of the group.
48 48
49 - `group_type: string`
50
51 The type of the group.
52
49 - `object: "project.group"`53 - `object: "project.group"`
50 54
51 Always `project.group`.55 Always `project.group`.
86 "created_at": 0,90 "created_at": 0,
87 "group_id": "group_id",91 "group_id": "group_id",
88 "group_name": "group_name",92 "group_name": "group_name",
93 "group_type": "group_type",
89 "object": "project.group",94 "object": "project.group",
90 "project_id": "project_id"95 "project_id": "project_id"
91 }96 }
145 150
146### Returns151### Returns
147 152
148153- `ProjectGroup object { created_at, group_id, group_name, 2 more }`- `ProjectGroup object { created_at, group_id, group_name, 3 more }`
149 154
150 Details about a group's membership in a project.155 Details about a group's membership in a project.
151 156
161 166
162 Display name of the group.167 Display name of the group.
163 168
169 - `group_type: string`
170
171 The type of the group.
172
164 - `object: "project.group"`173 - `object: "project.group"`
165 174
166 Always `project.group`.175 Always `project.group`.
190 "created_at": 0,199 "created_at": 0,
191 "group_id": "group_id",200 "group_id": "group_id",
192 "group_name": "group_name",201 "group_name": "group_name",
202 "group_type": "group_type",
193 "object": "project.group",203 "object": "project.group",
194 "project_id": "project_id"204 "project_id": "project_id"
195}205}
281 291
282### Project Group292### Project Group
283 293
284294- `ProjectGroup object { created_at, group_id, group_name, 2 more }`- `ProjectGroup object { created_at, group_id, group_name, 3 more }`
285 295
286 Details about a group's membership in a project.296 Details about a group's membership in a project.
287 297
297 307
298 Display name of the group.308 Display name of the group.
299 309
310 - `group_type: string`
311
312 The type of the group.
313
300 - `object: "project.group"`314 - `object: "project.group"`
301 315
302 Always `project.group`.316 Always `project.group`.
44 44
45 Display name of the group.45 Display name of the group.
46 46
47 - `group_type: string`
48
49 The type of the group.
50
47 - `object: "project.group"`51 - `object: "project.group"`
48 52
49 Always `project.group`.53 Always `project.group`.
84 "created_at": 0,88 "created_at": 0,
85 "group_id": "group_id",89 "group_id": "group_id",
86 "group_name": "group_name",90 "group_name": "group_name",
91 "group_type": "group_type",
87 "object": "project.group",92 "object": "project.group",
88 "project_id": "project_id"93 "project_id": "project_id"
89 }94 }
resources/admin/subresources/organization/subresources/projects/subresources/rate_limits/index.md +7 −7
66 66
67 The maximum requests per day. Only present for relevant models.67 The maximum requests per day. Only present for relevant models.
68 68
69- `first_id: string`
70
71- `has_more: boolean`69- `has_more: boolean`
72 70
73- `last_id: string`
74
75- `object: "list"`71- `object: "list"`
76 72
77 - `"list"`73 - `"list"`
78 74
75- `first_id: optional string`
76
77- `last_id: optional string`
78
79### Example79### Example
80 80
81```http81```http
100 "max_requests_per_1_day": 0100 "max_requests_per_1_day": 0
101 }101 }
102 ],102 ],
103 "first_id": "first_id",
104 "has_more": true,103 "has_more": true,
105104 "last_id": "last_id", "object": "list",
106105 "object": "list" "first_id": "first_id",
106 "last_id": "last_id"
107}107}
108```108```
109 109
50 50
51 - `"member"`51 - `"member"`
52 52
53- `first_id: string`
54
55- `has_more: boolean`53- `has_more: boolean`
56 54
57- `last_id: string`
58
59- `object: "list"`55- `object: "list"`
60 56
61 - `"list"`57 - `"list"`
62 58
59- `first_id: optional string`
60
61- `last_id: optional string`
62
63### Example63### Example
64 64
65```http65```http
80 "role": "owner"80 "role": "owner"
81 }81 }
82 ],82 ],
83 "first_id": "first_id",
84 "has_more": true,83 "has_more": true,
8584 "last_id": "last_id", "object": "list",
8685 "object": "list" "first_id": "first_id",
86 "last_id": "last_id"
87}87}
88```88```
89 89
48 48
49 - `"member"`49 - `"member"`
50 50
51- `first_id: string`
52
53- `has_more: boolean`51- `has_more: boolean`
54 52
55- `last_id: string`
56
57- `object: "list"`53- `object: "list"`
58 54
59 - `"list"`55 - `"list"`
60 56
57- `first_id: optional string`
58
59- `last_id: optional string`
60
61### Example61### Example
62 62
63```http63```http
78 "role": "owner"78 "role": "owner"
79 }79 }
80 ],80 ],
81 "first_id": "first_id",
82 "has_more": true,81 "has_more": true,
8382 "last_id": "last_id", "object": "list",
8483 "object": "list" "first_id": "first_id",
84 "last_id": "last_id"
85}85}
86```86```
87 87
resources/admin/subresources/organization/subresources/projects/subresources/users/index.md +242 −109
32 32
33 The Unix timestamp (in seconds) of when the project was added.33 The Unix timestamp (in seconds) of when the project was added.
34 34
35 - `email: string`
36
37 The email address of the user
38
39 - `name: string`
40
41 The name of the user
42
43 - `object: "organization.project.user"`35 - `object: "organization.project.user"`
44 36
45 The object type, which is always `organization.project.user`37 The object type, which is always `organization.project.user`
46 38
47 - `"organization.project.user"`39 - `"organization.project.user"`
48 40
4941 - `role: "owner" or "member"` - `role: string`
50 42
51 `owner` or `member`43 `owner` or `member`
52 44
5345 - `"owner"` - `email: optional string`
54 46
5547 - `"member"` The email address of the user
56 48
5749- `first_id: string` - `name: optional string`
58 50
5951- `has_more: boolean` The name of the user
60 52
6153- `last_id: string`- `has_more: boolean`
62 54
63- `object: string`55- `object: string`
64 56
57- `first_id: optional string`
58
59- `last_id: optional string`
60
65### Example61### Example
66 62
67```http63```http
77 {73 {
78 "id": "id",74 "id": "id",
79 "added_at": 0,75 "added_at": 0,
80 "email": "email",
81 "name": "name",
82 "object": "organization.project.user",76 "object": "organization.project.user",
8377 "role": "owner" "role": "role",
78 "email": "email",
79 "name": "name"
84 }80 }
85 ],81 ],
86 "first_id": "first_id",
87 "has_more": true,82 "has_more": true,
8883 "last_id": "last_id", "object": "object",
8984 "object": "object" "first_id": "first_id",
85 "last_id": "last_id"
90}86}
91```87```
92 88
131 127
132### Body Parameters128### Body Parameters
133 129
134130- `role: "owner" or "member"`- `role: string`
135 131
136 `owner` or `member`132 `owner` or `member`
137 133
138134 - `"owner"`- `email: optional string`
139 135
140136 - `"member"` Email of the user to add.
141 137
142138- `user_id: string`- `user_id: optional string`
143 139
144 The ID of the user.140 The ID of the user.
145 141
146### Returns142### Returns
147 143
148144- `ProjectUser object { id, added_at, email, 3 more }`- `ProjectUser object { id, added_at, object, 3 more }`
149 145
150 Represents an individual user in a project.146 Represents an individual user in a project.
151 147
157 153
158 The Unix timestamp (in seconds) of when the project was added.154 The Unix timestamp (in seconds) of when the project was added.
159 155
160 - `email: string`
161
162 The email address of the user
163
164 - `name: string`
165
166 The name of the user
167
168 - `object: "organization.project.user"`156 - `object: "organization.project.user"`
169 157
170 The object type, which is always `organization.project.user`158 The object type, which is always `organization.project.user`
171 159
172 - `"organization.project.user"`160 - `"organization.project.user"`
173 161
174162 - `role: "owner" or "member"` - `role: string`
175 163
176 `owner` or `member`164 `owner` or `member`
177 165
178166 - `"owner"` - `email: optional string`
167
168 The email address of the user
169
170 - `name: optional string`
179 171
180172 - `"member"` The name of the user
181 173
182### Example174### Example
183 175
186 -H 'Content-Type: application/json' \178 -H 'Content-Type: application/json' \
187 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \179 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
188 -d '{180 -d '{
189181 "role": "owner", "role": "role"
190 "user_id": "user_id"
191 }'182 }'
192```183```
193 184
197{188{
198 "id": "id",189 "id": "id",
199 "added_at": 0,190 "added_at": 0,
200 "email": "email",
201 "name": "name",
202 "object": "organization.project.user",191 "object": "organization.project.user",
203192 "role": "owner" "role": "role",
193 "email": "email",
194 "name": "name"
204}195}
205```196```
206 197
242 233
243### Returns234### Returns
244 235
245236- `ProjectUser object { id, added_at, email, 3 more }`- `ProjectUser object { id, added_at, object, 3 more }`
246 237
247 Represents an individual user in a project.238 Represents an individual user in a project.
248 239
254 245
255 The Unix timestamp (in seconds) of when the project was added.246 The Unix timestamp (in seconds) of when the project was added.
256 247
257 - `email: string`
258
259 The email address of the user
260
261 - `name: string`
262
263 The name of the user
264
265 - `object: "organization.project.user"`248 - `object: "organization.project.user"`
266 249
267 The object type, which is always `organization.project.user`250 The object type, which is always `organization.project.user`
268 251
269 - `"organization.project.user"`252 - `"organization.project.user"`
270 253
271254 - `role: "owner" or "member"` - `role: string`
272 255
273 `owner` or `member`256 `owner` or `member`
274 257
275258 - `"owner"` - `email: optional string`
259
260 The email address of the user
261
262 - `name: optional string`
276 263
277264 - `"member"` The name of the user
278 265
279### Example266### Example
280 267
289{276{
290 "id": "id",277 "id": "id",
291 "added_at": 0,278 "added_at": 0,
292 "email": "email",
293 "name": "name",
294 "object": "organization.project.user",279 "object": "organization.project.user",
295280 "role": "owner" "role": "role",
281 "email": "email",
282 "name": "name"
296}283}
297```284```
298 285
331 318
332### Body Parameters319### Body Parameters
333 320
334321- `role: "owner" or "member"`- `role: optional string`
335 322
336 `owner` or `member`323 `owner` or `member`
337 324
338 - `"owner"`
339
340 - `"member"`
341
342### Returns325### Returns
343 326
344327- `ProjectUser object { id, added_at, email, 3 more }`- `ProjectUser object { id, added_at, object, 3 more }`
345 328
346 Represents an individual user in a project.329 Represents an individual user in a project.
347 330
353 336
354 The Unix timestamp (in seconds) of when the project was added.337 The Unix timestamp (in seconds) of when the project was added.
355 338
356 - `email: string`
357
358 The email address of the user
359
360 - `name: string`
361
362 The name of the user
363
364 - `object: "organization.project.user"`339 - `object: "organization.project.user"`
365 340
366 The object type, which is always `organization.project.user`341 The object type, which is always `organization.project.user`
367 342
368 - `"organization.project.user"`343 - `"organization.project.user"`
369 344
370345 - `role: "owner" or "member"` - `role: string`
371 346
372 `owner` or `member`347 `owner` or `member`
373 348
374349 - `"owner"` - `email: optional string`
375 350
376351 - `"member"` The email address of the user
352
353 - `name: optional string`
354
355 The name of the user
377 356
378### Example357### Example
379 358
381curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \360curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \
382 -H 'Content-Type: application/json' \361 -H 'Content-Type: application/json' \
383 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \362 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
384363 -d '{ -d '{}'
385 "role": "owner"
386 }'
387```364```
388 365
389#### Response366#### Response
392{369{
393 "id": "id",370 "id": "id",
394 "added_at": 0,371 "added_at": 0,
395 "email": "email",
396 "name": "name",
397 "object": "organization.project.user",372 "object": "organization.project.user",
398373 "role": "owner" "role": "role",
374 "email": "email",
375 "name": "name"
399}376}
400```377```
401 378
488 465
489### Project User466### Project User
490 467
491468- `ProjectUser object { id, added_at, email, 3 more }`- `ProjectUser object { id, added_at, object, 3 more }`
492 469
493 Represents an individual user in a project.470 Represents an individual user in a project.
494 471
500 477
501 The Unix timestamp (in seconds) of when the project was added.478 The Unix timestamp (in seconds) of when the project was added.
502 479
503 - `email: string`
504
505 The email address of the user
506
507 - `name: string`
508
509 The name of the user
510
511 - `object: "organization.project.user"`480 - `object: "organization.project.user"`
512 481
513 The object type, which is always `organization.project.user`482 The object type, which is always `organization.project.user`
514 483
515 - `"organization.project.user"`484 - `"organization.project.user"`
516 485
517486 - `role: "owner" or "member"` - `role: string`
518 487
519 `owner` or `member`488 `owner` or `member`
520 489
521490 - `"owner"` - `email: optional string`
491
492 The email address of the user
522 493
523494 - `"member"` - `name: optional string`
495
496 The name of the user
524 497
525### User Delete Response498### User Delete Response
526 499
780 753
781 The Unix timestamp (in seconds) of when the user was added.754 The Unix timestamp (in seconds) of when the user was added.
782 755
783756 - `email: string` - `object: "organization.user"`
757
758 The object type, which is always `organization.user`
759
760 - `"organization.user"`
761
762 - `api_key_last_used_at: optional number`
763
764 The Unix timestamp (in seconds) of the user's last API key usage.
765
766 - `created: optional number`
767
768 The Unix timestamp (in seconds) of when the user was created.
769
770 - `developer_persona: optional string`
771
772 The developer persona metadata for the user.
773
774 - `email: optional string`
784 775
785 The email address of the user776 The email address of the user
786 777
787778 - `name: string` - `is_default: optional boolean`
779
780 Whether this is the organization's default user.
781
782 - `is_scale_tier_authorized_purchaser: optional boolean`
783
784 Whether the user is an authorized purchaser for Scale Tier.
785
786 - `is_scim_managed: optional boolean`
787
788 Whether the user is managed through SCIM.
789
790 - `is_service_account: optional boolean`
791
792 Whether the user is a service account.
793
794 - `name: optional string`
788 795
789 The name of the user796 The name of the user
790 797
791798 - `object: "organization.user"` - `projects: optional object { data, object }`
792 799
793800 The object type, which is always `organization.user` Projects associated with the user, if included.
794 801
795802 - `"organization.user"` - `data: array of object { id, name, role }`
803
804 - `id: optional string`
805
806 - `name: optional string`
807
808 - `role: optional string`
796 809
797810 - `role: "owner" or "reader"` - `object: "list"`
811
812 - `"list"`
813
814 - `role: optional string`
798 815
799 `owner` or `reader`816 `owner` or `reader`
800 817
801818 - `"owner"` - `technical_level: optional string`
819
820 The technical level metadata for the user.
821
822 - `user: optional object { id, object, banned, 5 more }`
802 823
803824 - `"reader"` Nested user details.
825
826 - `id: string`
827
828 - `object: "user"`
829
830 - `"user"`
831
832 - `banned: optional boolean`
833
834 - `banned_at: optional number`
835
836 - `email: optional string`
837
838 - `enabled: optional boolean`
839
840 - `name: optional string`
841
842 - `picture: optional string`
804 843
805### Example844### Example
806 845
832 "user": {871 "user": {
833 "id": "id",872 "id": "id",
834 "added_at": 0,873 "added_at": 0,
874 "object": "organization.user",
875 "api_key_last_used_at": 0,
876 "created": 0,
877 "developer_persona": "developer_persona",
835 "email": "email",878 "email": "email",
879 "is_default": true,
880 "is_scale_tier_authorized_purchaser": true,
881 "is_scim_managed": true,
882 "is_service_account": true,
836 "name": "name",883 "name": "name",
837884 "object": "organization.user", "projects": {
838885 "role": "owner" "data": [
886 {
887 "id": "id",
888 "name": "name",
889 "role": "role"
890 }
891 ],
892 "object": "list"
893 },
894 "role": "role",
895 "technical_level": "technical_level",
896 "user": {
897 "id": "id",
898 "object": "user",
899 "banned": true,
900 "banned_at": 0,
901 "email": "email",
902 "enabled": true,
903 "name": "name",
904 "picture": "picture"
905 }
839 }906 }
840}907}
841```908```
1047 1114
1048 The Unix timestamp (in seconds) of when the user was added.1115 The Unix timestamp (in seconds) of when the user was added.
1049 1116
10501117 - `email: string` - `object: "organization.user"`
1118
1119 The object type, which is always `organization.user`
1120
1121 - `"organization.user"`
1122
1123 - `api_key_last_used_at: optional number`
1124
1125 The Unix timestamp (in seconds) of the user's last API key usage.
1126
1127 - `created: optional number`
1128
1129 The Unix timestamp (in seconds) of when the user was created.
1130
1131 - `developer_persona: optional string`
1132
1133 The developer persona metadata for the user.
1134
1135 - `email: optional string`
1051 1136
1052 The email address of the user1137 The email address of the user
1053 1138
10541139 - `name: string` - `is_default: optional boolean`
1140
1141 Whether this is the organization's default user.
1142
1143 - `is_scale_tier_authorized_purchaser: optional boolean`
1144
1145 Whether the user is an authorized purchaser for Scale Tier.
1146
1147 - `is_scim_managed: optional boolean`
1148
1149 Whether the user is managed through SCIM.
1150
1151 - `is_service_account: optional boolean`
1152
1153 Whether the user is a service account.
1154
1155 - `name: optional string`
1055 1156
1056 The name of the user1157 The name of the user
1057 1158
10581159 - `object: "organization.user"` - `projects: optional object { data, object }`
1059 1160
10601161 The object type, which is always `organization.user` Projects associated with the user, if included.
1061 1162
10621163 - `"organization.user"` - `data: array of object { id, name, role }`
1164
1165 - `id: optional string`
1166
1167 - `name: optional string`
1063 1168
10641169 - `role: "owner" or "reader"` - `role: optional string`
1170
1171 - `object: "list"`
1172
1173 - `"list"`
1174
1175 - `role: optional string`
1065 1176
1066 `owner` or `reader`1177 `owner` or `reader`
1067 1178
10681179 - `"owner"` - `technical_level: optional string`
1180
1181 The technical level metadata for the user.
1182
1183 - `user: optional object { id, object, banned, 5 more }`
1184
1185 Nested user details.
1186
1187 - `id: string`
1188
1189 - `object: "user"`
1190
1191 - `"user"`
1192
1193 - `banned: optional boolean`
1194
1195 - `banned_at: optional number`
1196
1197 - `email: optional string`
1198
1199 - `enabled: optional boolean`
1200
1201 - `name: optional string`
1069 1202
10701203 - `"reader"` - `picture: optional string`
1071 1204
1072### Role Delete Response1205### Role Delete Response
1073 1206
10 10
11### Body Parameters11### Body Parameters
12 12
1313- `role: "owner" or "member"`- `role: string`
14 14
15 `owner` or `member`15 `owner` or `member`
16 16
1717 - `"owner"`- `email: optional string`
18 18
1919 - `"member"` Email of the user to add.
20 20
2121- `user_id: string`- `user_id: optional string`
22 22
23 The ID of the user.23 The ID of the user.
24 24
25### Returns25### Returns
26 26
2727- `ProjectUser object { id, added_at, email, 3 more }`- `ProjectUser object { id, added_at, object, 3 more }`
28 28
29 Represents an individual user in a project.29 Represents an individual user in a project.
30 30
36 36
37 The Unix timestamp (in seconds) of when the project was added.37 The Unix timestamp (in seconds) of when the project was added.
38 38
39 - `email: string`
40
41 The email address of the user
42
43 - `name: string`
44
45 The name of the user
46
47 - `object: "organization.project.user"`39 - `object: "organization.project.user"`
48 40
49 The object type, which is always `organization.project.user`41 The object type, which is always `organization.project.user`
50 42
51 - `"organization.project.user"`43 - `"organization.project.user"`
52 44
5345 - `role: "owner" or "member"` - `role: string`
54 46
55 `owner` or `member`47 `owner` or `member`
56 48
5749 - `"owner"` - `email: optional string`
58 50
5951 - `"member"` The email address of the user
52
53 - `name: optional string`
54
55 The name of the user
60 56
61### Example57### Example
62 58
65 -H 'Content-Type: application/json' \61 -H 'Content-Type: application/json' \
66 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \62 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
67 -d '{63 -d '{
6864 "role": "owner", "role": "role"
69 "user_id": "user_id"
70 }'65 }'
71```66```
72 67
76{71{
77 "id": "id",72 "id": "id",
78 "added_at": 0,73 "added_at": 0,
79 "email": "email",
80 "name": "name",
81 "object": "organization.project.user",74 "object": "organization.project.user",
8275 "role": "owner" "role": "role",
76 "email": "email",
77 "name": "name"
83}78}
84```79```
85 80
30 30
31 The Unix timestamp (in seconds) of when the project was added.31 The Unix timestamp (in seconds) of when the project was added.
32 32
33 - `email: string`
34
35 The email address of the user
36
37 - `name: string`
38
39 The name of the user
40
41 - `object: "organization.project.user"`33 - `object: "organization.project.user"`
42 34
43 The object type, which is always `organization.project.user`35 The object type, which is always `organization.project.user`
44 36
45 - `"organization.project.user"`37 - `"organization.project.user"`
46 38
4739 - `role: "owner" or "member"` - `role: string`
48 40
49 `owner` or `member`41 `owner` or `member`
50 42
5143 - `"owner"` - `email: optional string`
52 44
5345 - `"member"` The email address of the user
54 46
5547- `first_id: string` - `name: optional string`
56 48
5749- `has_more: boolean` The name of the user
58 50
5951- `last_id: string`- `has_more: boolean`
60 52
61- `object: string`53- `object: string`
62 54
55- `first_id: optional string`
56
57- `last_id: optional string`
58
63### Example59### Example
64 60
65```http61```http
75 {71 {
76 "id": "id",72 "id": "id",
77 "added_at": 0,73 "added_at": 0,
78 "email": "email",
79 "name": "name",
80 "object": "organization.project.user",74 "object": "organization.project.user",
8175 "role": "owner" "role": "role",
76 "email": "email",
77 "name": "name"
82 }78 }
83 ],79 ],
84 "first_id": "first_id",
85 "has_more": true,80 "has_more": true,
8681 "last_id": "last_id", "object": "object",
8782 "object": "object" "first_id": "first_id",
83 "last_id": "last_id"
88}84}
89```85```
90 86
12 12
13### Returns13### Returns
14 14
1515- `ProjectUser object { id, added_at, email, 3 more }`- `ProjectUser object { id, added_at, object, 3 more }`
16 16
17 Represents an individual user in a project.17 Represents an individual user in a project.
18 18
24 24
25 The Unix timestamp (in seconds) of when the project was added.25 The Unix timestamp (in seconds) of when the project was added.
26 26
27 - `email: string`
28
29 The email address of the user
30
31 - `name: string`
32
33 The name of the user
34
35 - `object: "organization.project.user"`27 - `object: "organization.project.user"`
36 28
37 The object type, which is always `organization.project.user`29 The object type, which is always `organization.project.user`
38 30
39 - `"organization.project.user"`31 - `"organization.project.user"`
40 32
4133 - `role: "owner" or "member"` - `role: string`
42 34
43 `owner` or `member`35 `owner` or `member`
44 36
4537 - `"owner"` - `email: optional string`
46 38
4739 - `"member"` The email address of the user
40
41 - `name: optional string`
42
43 The name of the user
48 44
49### Example45### Example
50 46
59{55{
60 "id": "id",56 "id": "id",
61 "added_at": 0,57 "added_at": 0,
62 "email": "email",
63 "name": "name",
64 "object": "organization.project.user",58 "object": "organization.project.user",
6559 "role": "owner" "role": "role",
60 "email": "email",
61 "name": "name"
66}62}
67```63```
68 64
12 12
13### Body Parameters13### Body Parameters
14 14
1515- `role: "owner" or "member"`- `role: optional string`
16 16
17 `owner` or `member`17 `owner` or `member`
18 18
19 - `"owner"`
20
21 - `"member"`
22
23### Returns19### Returns
24 20
2521- `ProjectUser object { id, added_at, email, 3 more }`- `ProjectUser object { id, added_at, object, 3 more }`
26 22
27 Represents an individual user in a project.23 Represents an individual user in a project.
28 24
34 30
35 The Unix timestamp (in seconds) of when the project was added.31 The Unix timestamp (in seconds) of when the project was added.
36 32
37 - `email: string`
38
39 The email address of the user
40
41 - `name: string`
42
43 The name of the user
44
45 - `object: "organization.project.user"`33 - `object: "organization.project.user"`
46 34
47 The object type, which is always `organization.project.user`35 The object type, which is always `organization.project.user`
48 36
49 - `"organization.project.user"`37 - `"organization.project.user"`
50 38
5139 - `role: "owner" or "member"` - `role: string`
52 40
53 `owner` or `member`41 `owner` or `member`
54 42
5543 - `"owner"` - `email: optional string`
44
45 The email address of the user
46
47 - `name: optional string`
56 48
5749 - `"member"` The name of the user
58 50
59### Example51### Example
60 52
62curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \54curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \
63 -H 'Content-Type: application/json' \55 -H 'Content-Type: application/json' \
64 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \56 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
6557 -d '{ -d '{}'
66 "role": "owner"
67 }'
68```58```
69 59
70#### Response60#### Response
73{63{
74 "id": "id",64 "id": "id",
75 "added_at": 0,65 "added_at": 0,
76 "email": "email",
77 "name": "name",
78 "object": "organization.project.user",66 "object": "organization.project.user",
7967 "role": "owner" "role": "role",
68 "email": "email",
69 "name": "name"
80}70}
81```71```
82 72
70 70
71 The Unix timestamp (in seconds) of when the user was added.71 The Unix timestamp (in seconds) of when the user was added.
72 72
7373 - `email: string` - `object: "organization.user"`
74
75 The object type, which is always `organization.user`
76
77 - `"organization.user"`
78
79 - `api_key_last_used_at: optional number`
80
81 The Unix timestamp (in seconds) of the user's last API key usage.
82
83 - `created: optional number`
84
85 The Unix timestamp (in seconds) of when the user was created.
86
87 - `developer_persona: optional string`
88
89 The developer persona metadata for the user.
90
91 - `email: optional string`
74 92
75 The email address of the user93 The email address of the user
76 94
7795 - `name: string` - `is_default: optional boolean`
96
97 Whether this is the organization's default user.
98
99 - `is_scale_tier_authorized_purchaser: optional boolean`
100
101 Whether the user is an authorized purchaser for Scale Tier.
102
103 - `is_scim_managed: optional boolean`
104
105 Whether the user is managed through SCIM.
106
107 - `is_service_account: optional boolean`
108
109 Whether the user is a service account.
110
111 - `name: optional string`
78 112
79 The name of the user113 The name of the user
80 114
81115 - `object: "organization.user"` - `projects: optional object { data, object }`
82 116
83117 The object type, which is always `organization.user` Projects associated with the user, if included.
84 118
85119 - `"organization.user"` - `data: array of object { id, name, role }`
120
121 - `id: optional string`
122
123 - `name: optional string`
124
125 - `role: optional string`
86 126
87127 - `role: "owner" or "reader"` - `object: "list"`
128
129 - `"list"`
130
131 - `role: optional string`
88 132
89 `owner` or `reader`133 `owner` or `reader`
90 134
91135 - `"owner"` - `technical_level: optional string`
136
137 The technical level metadata for the user.
138
139 - `user: optional object { id, object, banned, 5 more }`
140
141 Nested user details.
142
143 - `id: string`
144
145 - `object: "user"`
146
147 - `"user"`
148
149 - `banned: optional boolean`
150
151 - `banned_at: optional number`
152
153 - `email: optional string`
154
155 - `enabled: optional boolean`
92 156
93157 - `"reader"` - `name: optional string`
158
159 - `picture: optional string`
94 160
95### Example161### Example
96 162
122 "user": {188 "user": {
123 "id": "id",189 "id": "id",
124 "added_at": 0,190 "added_at": 0,
191 "object": "organization.user",
192 "api_key_last_used_at": 0,
193 "created": 0,
194 "developer_persona": "developer_persona",
125 "email": "email",195 "email": "email",
196 "is_default": true,
197 "is_scale_tier_authorized_purchaser": true,
198 "is_scim_managed": true,
199 "is_service_account": true,
126 "name": "name",200 "name": "name",
127201 "object": "organization.user", "projects": {
128202 "role": "owner" "data": [
203 {
204 "id": "id",
205 "name": "name",
206 "role": "role"
207 }
208 ],
209 "object": "list"
210 },
211 "role": "role",
212 "technical_level": "technical_level",
213 "user": {
214 "id": "id",
215 "object": "user",
216 "banned": true,
217 "banned_at": 0,
218 "email": "email",
219 "enabled": true,
220 "name": "name",
221 "picture": "picture"
222 }
129 }223 }
130}224}
131```225```
68 68
69### Returns69### Returns
70 70
7171- `data: array of object { end_time, object, result, start_time }`- `data: array of object { end_time, object, results, start_time }`
72 72
73 - `end_time: number`73 - `end_time: number`
74 74
76 76
77 - `"bucket"`77 - `"bucket"`
78 78
7979 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
80 80
8181 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
82 82
83 The aggregated completions usage details of the specific time bucket.83 The aggregated completions usage details of the specific time bucket.
84 84
134 134
135 When `group_by=user_id`, this field provides the user ID of the grouped usage result.135 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
136 136
137137 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
138 138
139 The aggregated embeddings usage details of the specific time bucket.139 The aggregated embeddings usage details of the specific time bucket.
140 140
166 166
167 When `group_by=user_id`, this field provides the user ID of the grouped usage result.167 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
168 168
169169 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
170 170
171 The aggregated moderations usage details of the specific time bucket.171 The aggregated moderations usage details of the specific time bucket.
172 172
198 198
199 When `group_by=user_id`, this field provides the user ID of the grouped usage result.199 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
200 200
201201 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
202 202
203 The aggregated images usage details of the specific time bucket.203 The aggregated images usage details of the specific time bucket.
204 204
238 238
239 When `group_by=user_id`, this field provides the user ID of the grouped usage result.239 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
240 240
241241 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
242 242
243 The aggregated audio speeches usage details of the specific time bucket.243 The aggregated audio speeches usage details of the specific time bucket.
244 244
270 270
271 When `group_by=user_id`, this field provides the user ID of the grouped usage result.271 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
272 272
273273 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
274 274
275 The aggregated audio transcriptions usage details of the specific time bucket.275 The aggregated audio transcriptions usage details of the specific time bucket.
276 276
302 302
303 When `group_by=user_id`, this field provides the user ID of the grouped usage result.303 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
304 304
305305 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
306 306
307 The aggregated vector stores usage details of the specific time bucket.307 The aggregated vector stores usage details of the specific time bucket.
308 308
318 318
319 When `group_by=project_id`, this field provides the project ID of the grouped usage result.319 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
320 320
321321 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
322 322
323 The aggregated code interpreter sessions usage details of the specific time bucket.323 The aggregated code interpreter sessions usage details of the specific time bucket.
324 324
325325 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
326 326
327327 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
328 328
329329 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
330 330
331331 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
332 332
333 - `project_id: optional string`333 - `project_id: optional string`
334 334
335 When `group_by=project_id`, this field provides the project ID of the grouped usage result.335 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
336 336
337337 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
338 338
339 The aggregated costs details of the specific time bucket.339 The aggregated costs details of the specific time bucket.
340 340
391 {391 {
392 "end_time": 0,392 "end_time": 0,
393 "object": "bucket",393 "object": "bucket",
394394 "result": [ "results": [
395 {395 {
396 "input_tokens": 0,396 "input_tokens": 0,
397 "num_model_requests": 0,397 "num_model_requests": 0,
521 521
522### Returns522### Returns
523 523
524524- `data: array of object { end_time, object, result, start_time }`- `data: array of object { end_time, object, results, start_time }`
525 525
526 - `end_time: number`526 - `end_time: number`
527 527
529 529
530 - `"bucket"`530 - `"bucket"`
531 531
532532 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
533 533
534534 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
535 535
536 The aggregated completions usage details of the specific time bucket.536 The aggregated completions usage details of the specific time bucket.
537 537
587 587
588 When `group_by=user_id`, this field provides the user ID of the grouped usage result.588 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
589 589
590590 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
591 591
592 The aggregated embeddings usage details of the specific time bucket.592 The aggregated embeddings usage details of the specific time bucket.
593 593
619 619
620 When `group_by=user_id`, this field provides the user ID of the grouped usage result.620 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
621 621
622622 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
623 623
624 The aggregated moderations usage details of the specific time bucket.624 The aggregated moderations usage details of the specific time bucket.
625 625
651 651
652 When `group_by=user_id`, this field provides the user ID of the grouped usage result.652 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
653 653
654654 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
655 655
656 The aggregated images usage details of the specific time bucket.656 The aggregated images usage details of the specific time bucket.
657 657
691 691
692 When `group_by=user_id`, this field provides the user ID of the grouped usage result.692 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
693 693
694694 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
695 695
696 The aggregated audio speeches usage details of the specific time bucket.696 The aggregated audio speeches usage details of the specific time bucket.
697 697
723 723
724 When `group_by=user_id`, this field provides the user ID of the grouped usage result.724 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
725 725
726726 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
727 727
728 The aggregated audio transcriptions usage details of the specific time bucket.728 The aggregated audio transcriptions usage details of the specific time bucket.
729 729
755 755
756 When `group_by=user_id`, this field provides the user ID of the grouped usage result.756 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
757 757
758758 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
759 759
760 The aggregated vector stores usage details of the specific time bucket.760 The aggregated vector stores usage details of the specific time bucket.
761 761
771 771
772 When `group_by=project_id`, this field provides the project ID of the grouped usage result.772 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
773 773
774774 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
775 775
776 The aggregated code interpreter sessions usage details of the specific time bucket.776 The aggregated code interpreter sessions usage details of the specific time bucket.
777 777
778778 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
779 779
780780 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
781 781
782782 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
783 783
784784 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
785 785
786 - `project_id: optional string`786 - `project_id: optional string`
787 787
788 When `group_by=project_id`, this field provides the project ID of the grouped usage result.788 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
789 789
790790 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
791 791
792 The aggregated costs details of the specific time bucket.792 The aggregated costs details of the specific time bucket.
793 793
844 {844 {
845 "end_time": 0,845 "end_time": 0,
846 "object": "bucket",846 "object": "bucket",
847847 "result": [ "results": [
848 {848 {
849 "input_tokens": 0,849 "input_tokens": 0,
850 "num_model_requests": 0,850 "num_model_requests": 0,
956 956
957### Returns957### Returns
958 958
959959- `data: array of object { end_time, object, result, start_time }`- `data: array of object { end_time, object, results, start_time }`
960 960
961 - `end_time: number`961 - `end_time: number`
962 962
964 964
965 - `"bucket"`965 - `"bucket"`
966 966
967967 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
968 968
969969 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
970 970
971 The aggregated completions usage details of the specific time bucket.971 The aggregated completions usage details of the specific time bucket.
972 972
1022 1022
1023 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1023 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1024 1024
10251025 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
1026 1026
1027 The aggregated embeddings usage details of the specific time bucket.1027 The aggregated embeddings usage details of the specific time bucket.
1028 1028
1054 1054
1055 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1055 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1056 1056
10571057 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
1058 1058
1059 The aggregated moderations usage details of the specific time bucket.1059 The aggregated moderations usage details of the specific time bucket.
1060 1060
1086 1086
1087 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1087 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1088 1088
10891089 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
1090 1090
1091 The aggregated images usage details of the specific time bucket.1091 The aggregated images usage details of the specific time bucket.
1092 1092
1126 1126
1127 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1127 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1128 1128
11291129 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
1130 1130
1131 The aggregated audio speeches usage details of the specific time bucket.1131 The aggregated audio speeches usage details of the specific time bucket.
1132 1132
1158 1158
1159 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1159 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1160 1160
11611161 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
1162 1162
1163 The aggregated audio transcriptions usage details of the specific time bucket.1163 The aggregated audio transcriptions usage details of the specific time bucket.
1164 1164
1190 1190
1191 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1191 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1192 1192
11931193 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
1194 1194
1195 The aggregated vector stores usage details of the specific time bucket.1195 The aggregated vector stores usage details of the specific time bucket.
1196 1196
1206 1206
1207 When `group_by=project_id`, this field provides the project ID of the grouped usage result.1207 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
1208 1208
12091209 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
1210 1210
1211 The aggregated code interpreter sessions usage details of the specific time bucket.1211 The aggregated code interpreter sessions usage details of the specific time bucket.
1212 1212
12131213 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
1214 1214
12151215 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
1216 1216
12171217 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
1218 1218
12191219 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
1220 1220
1221 - `project_id: optional string`1221 - `project_id: optional string`
1222 1222
1223 When `group_by=project_id`, this field provides the project ID of the grouped usage result.1223 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
1224 1224
12251225 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
1226 1226
1227 The aggregated costs details of the specific time bucket.1227 The aggregated costs details of the specific time bucket.
1228 1228
1279 {1279 {
1280 "end_time": 0,1280 "end_time": 0,
1281 "object": "bucket",1281 "object": "bucket",
12821282 "result": [ "results": [
1283 {1283 {
1284 "input_tokens": 0,1284 "input_tokens": 0,
1285 "num_model_requests": 0,1285 "num_model_requests": 0,
1413 1413
1414### Returns1414### Returns
1415 1415
14161416- `data: array of object { end_time, object, result, start_time }`- `data: array of object { end_time, object, results, start_time }`
1417 1417
1418 - `end_time: number`1418 - `end_time: number`
1419 1419
1421 1421
1422 - `"bucket"`1422 - `"bucket"`
1423 1423
14241424 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
1425 1425
14261426 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
1427 1427
1428 The aggregated completions usage details of the specific time bucket.1428 The aggregated completions usage details of the specific time bucket.
1429 1429
1479 1479
1480 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1480 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1481 1481
14821482 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
1483 1483
1484 The aggregated embeddings usage details of the specific time bucket.1484 The aggregated embeddings usage details of the specific time bucket.
1485 1485
1511 1511
1512 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1512 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1513 1513
15141514 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
1515 1515
1516 The aggregated moderations usage details of the specific time bucket.1516 The aggregated moderations usage details of the specific time bucket.
1517 1517
1543 1543
1544 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1544 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1545 1545
15461546 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
1547 1547
1548 The aggregated images usage details of the specific time bucket.1548 The aggregated images usage details of the specific time bucket.
1549 1549
1583 1583
1584 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1584 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1585 1585
15861586 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
1587 1587
1588 The aggregated audio speeches usage details of the specific time bucket.1588 The aggregated audio speeches usage details of the specific time bucket.
1589 1589
1615 1615
1616 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1616 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1617 1617
16181618 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
1619 1619
1620 The aggregated audio transcriptions usage details of the specific time bucket.1620 The aggregated audio transcriptions usage details of the specific time bucket.
1621 1621
1647 1647
1648 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1648 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1649 1649
16501650 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
1651 1651
1652 The aggregated vector stores usage details of the specific time bucket.1652 The aggregated vector stores usage details of the specific time bucket.
1653 1653
1663 1663
1664 When `group_by=project_id`, this field provides the project ID of the grouped usage result.1664 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
1665 1665
16661666 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
1667 1667
1668 The aggregated code interpreter sessions usage details of the specific time bucket.1668 The aggregated code interpreter sessions usage details of the specific time bucket.
1669 1669
16701670 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
1671 1671
16721672 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
1673 1673
16741674 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
1675 1675
16761676 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
1677 1677
1678 - `project_id: optional string`1678 - `project_id: optional string`
1679 1679
1680 When `group_by=project_id`, this field provides the project ID of the grouped usage result.1680 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
1681 1681
16821682 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
1683 1683
1684 The aggregated costs details of the specific time bucket.1684 The aggregated costs details of the specific time bucket.
1685 1685
1736 {1736 {
1737 "end_time": 0,1737 "end_time": 0,
1738 "object": "bucket",1738 "object": "bucket",
17391739 "result": [ "results": [
1740 {1740 {
1741 "input_tokens": 0,1741 "input_tokens": 0,
1742 "num_model_requests": 0,1742 "num_model_requests": 0,
1872 1872
1873### Returns1873### Returns
1874 1874
18751875- `data: array of object { end_time, object, result, start_time }`- `data: array of object { end_time, object, results, start_time }`
1876 1876
1877 - `end_time: number`1877 - `end_time: number`
1878 1878
1880 1880
1881 - `"bucket"`1881 - `"bucket"`
1882 1882
18831883 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
1884 1884
18851885 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
1886 1886
1887 The aggregated completions usage details of the specific time bucket.1887 The aggregated completions usage details of the specific time bucket.
1888 1888
1938 1938
1939 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1939 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1940 1940
19411941 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
1942 1942
1943 The aggregated embeddings usage details of the specific time bucket.1943 The aggregated embeddings usage details of the specific time bucket.
1944 1944
1970 1970
1971 When `group_by=user_id`, this field provides the user ID of the grouped usage result.1971 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1972 1972
19731973 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
1974 1974
1975 The aggregated moderations usage details of the specific time bucket.1975 The aggregated moderations usage details of the specific time bucket.
1976 1976
2002 2002
2003 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2003 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2004 2004
20052005 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
2006 2006
2007 The aggregated images usage details of the specific time bucket.2007 The aggregated images usage details of the specific time bucket.
2008 2008
2042 2042
2043 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2043 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2044 2044
20452045 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
2046 2046
2047 The aggregated audio speeches usage details of the specific time bucket.2047 The aggregated audio speeches usage details of the specific time bucket.
2048 2048
2074 2074
2075 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2075 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2076 2076
20772077 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
2078 2078
2079 The aggregated audio transcriptions usage details of the specific time bucket.2079 The aggregated audio transcriptions usage details of the specific time bucket.
2080 2080
2106 2106
2107 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2107 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2108 2108
21092109 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
2110 2110
2111 The aggregated vector stores usage details of the specific time bucket.2111 The aggregated vector stores usage details of the specific time bucket.
2112 2112
2122 2122
2123 When `group_by=project_id`, this field provides the project ID of the grouped usage result.2123 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
2124 2124
21252125 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
2126 2126
2127 The aggregated code interpreter sessions usage details of the specific time bucket.2127 The aggregated code interpreter sessions usage details of the specific time bucket.
2128 2128
21292129 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
2130 2130
21312131 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
2132 2132
21332133 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
2134 2134
21352135 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
2136 2136
2137 - `project_id: optional string`2137 - `project_id: optional string`
2138 2138
2139 When `group_by=project_id`, this field provides the project ID of the grouped usage result.2139 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
2140 2140
21412141 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
2142 2142
2143 The aggregated costs details of the specific time bucket.2143 The aggregated costs details of the specific time bucket.
2144 2144
2195 {2195 {
2196 "end_time": 0,2196 "end_time": 0,
2197 "object": "bucket",2197 "object": "bucket",
21982198 "result": [ "results": [
2199 {2199 {
2200 "input_tokens": 0,2200 "input_tokens": 0,
2201 "num_model_requests": 0,2201 "num_model_requests": 0,
2353 2353
2354### Returns2354### Returns
2355 2355
23562356- `data: array of object { end_time, object, result, start_time }`- `data: array of object { end_time, object, results, start_time }`
2357 2357
2358 - `end_time: number`2358 - `end_time: number`
2359 2359
2361 2361
2362 - `"bucket"`2362 - `"bucket"`
2363 2363
23642364 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
2365 2365
23662366 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
2367 2367
2368 The aggregated completions usage details of the specific time bucket.2368 The aggregated completions usage details of the specific time bucket.
2369 2369
2419 2419
2420 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2420 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2421 2421
24222422 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
2423 2423
2424 The aggregated embeddings usage details of the specific time bucket.2424 The aggregated embeddings usage details of the specific time bucket.
2425 2425
2451 2451
2452 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2452 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2453 2453
24542454 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
2455 2455
2456 The aggregated moderations usage details of the specific time bucket.2456 The aggregated moderations usage details of the specific time bucket.
2457 2457
2483 2483
2484 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2484 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2485 2485
24862486 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
2487 2487
2488 The aggregated images usage details of the specific time bucket.2488 The aggregated images usage details of the specific time bucket.
2489 2489
2523 2523
2524 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2524 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2525 2525
25262526 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
2527 2527
2528 The aggregated audio speeches usage details of the specific time bucket.2528 The aggregated audio speeches usage details of the specific time bucket.
2529 2529
2555 2555
2556 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2556 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2557 2557
25582558 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
2559 2559
2560 The aggregated audio transcriptions usage details of the specific time bucket.2560 The aggregated audio transcriptions usage details of the specific time bucket.
2561 2561
2587 2587
2588 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2588 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2589 2589
25902590 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
2591 2591
2592 The aggregated vector stores usage details of the specific time bucket.2592 The aggregated vector stores usage details of the specific time bucket.
2593 2593
2603 2603
2604 When `group_by=project_id`, this field provides the project ID of the grouped usage result.2604 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
2605 2605
26062606 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
2607 2607
2608 The aggregated code interpreter sessions usage details of the specific time bucket.2608 The aggregated code interpreter sessions usage details of the specific time bucket.
2609 2609
26102610 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
2611 2611
26122612 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
2613 2613
26142614 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
2615 2615
26162616 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
2617 2617
2618 - `project_id: optional string`2618 - `project_id: optional string`
2619 2619
2620 When `group_by=project_id`, this field provides the project ID of the grouped usage result.2620 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
2621 2621
26222622 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
2623 2623
2624 The aggregated costs details of the specific time bucket.2624 The aggregated costs details of the specific time bucket.
2625 2625
2676 {2676 {
2677 "end_time": 0,2677 "end_time": 0,
2678 "object": "bucket",2678 "object": "bucket",
26792679 "result": [ "results": [
2680 {2680 {
2681 "input_tokens": 0,2681 "input_tokens": 0,
2682 "num_model_requests": 0,2682 "num_model_requests": 0,
2808 2808
2809### Returns2809### Returns
2810 2810
28112811- `data: array of object { end_time, object, result, start_time }`- `data: array of object { end_time, object, results, start_time }`
2812 2812
2813 - `end_time: number`2813 - `end_time: number`
2814 2814
2816 2816
2817 - `"bucket"`2817 - `"bucket"`
2818 2818
28192819 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
2820 2820
28212821 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
2822 2822
2823 The aggregated completions usage details of the specific time bucket.2823 The aggregated completions usage details of the specific time bucket.
2824 2824
2874 2874
2875 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2875 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2876 2876
28772877 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
2878 2878
2879 The aggregated embeddings usage details of the specific time bucket.2879 The aggregated embeddings usage details of the specific time bucket.
2880 2880
2906 2906
2907 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2907 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2908 2908
29092909 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
2910 2910
2911 The aggregated moderations usage details of the specific time bucket.2911 The aggregated moderations usage details of the specific time bucket.
2912 2912
2938 2938
2939 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2939 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2940 2940
29412941 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
2942 2942
2943 The aggregated images usage details of the specific time bucket.2943 The aggregated images usage details of the specific time bucket.
2944 2944
2978 2978
2979 When `group_by=user_id`, this field provides the user ID of the grouped usage result.2979 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2980 2980
29812981 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
2982 2982
2983 The aggregated audio speeches usage details of the specific time bucket.2983 The aggregated audio speeches usage details of the specific time bucket.
2984 2984
3010 3010
3011 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3011 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3012 3012
30133013 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
3014 3014
3015 The aggregated audio transcriptions usage details of the specific time bucket.3015 The aggregated audio transcriptions usage details of the specific time bucket.
3016 3016
3042 3042
3043 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3043 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3044 3044
30453045 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
3046 3046
3047 The aggregated vector stores usage details of the specific time bucket.3047 The aggregated vector stores usage details of the specific time bucket.
3048 3048
3058 3058
3059 When `group_by=project_id`, this field provides the project ID of the grouped usage result.3059 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
3060 3060
30613061 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
3062 3062
3063 The aggregated code interpreter sessions usage details of the specific time bucket.3063 The aggregated code interpreter sessions usage details of the specific time bucket.
3064 3064
30653065 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
3066 3066
30673067 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
3068 3068
30693069 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
3070 3070
30713071 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
3072 3072
3073 - `project_id: optional string`3073 - `project_id: optional string`
3074 3074
3075 When `group_by=project_id`, this field provides the project ID of the grouped usage result.3075 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
3076 3076
30773077 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
3078 3078
3079 The aggregated costs details of the specific time bucket.3079 The aggregated costs details of the specific time bucket.
3080 3080
3131 {3131 {
3132 "end_time": 0,3132 "end_time": 0,
3133 "object": "bucket",3133 "object": "bucket",
31343134 "result": [ "results": [
3135 {3135 {
3136 "input_tokens": 0,3136 "input_tokens": 0,
3137 "num_model_requests": 0,3137 "num_model_requests": 0,
3243 3243
3244### Returns3244### Returns
3245 3245
32463246- `data: array of object { end_time, object, result, start_time }`- `data: array of object { end_time, object, results, start_time }`
3247 3247
3248 - `end_time: number`3248 - `end_time: number`
3249 3249
3251 3251
3252 - `"bucket"`3252 - `"bucket"`
3253 3253
32543254 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
3255 3255
32563256 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
3257 3257
3258 The aggregated completions usage details of the specific time bucket.3258 The aggregated completions usage details of the specific time bucket.
3259 3259
3309 3309
3310 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3310 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3311 3311
33123312 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
3313 3313
3314 The aggregated embeddings usage details of the specific time bucket.3314 The aggregated embeddings usage details of the specific time bucket.
3315 3315
3341 3341
3342 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3342 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3343 3343
33443344 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
3345 3345
3346 The aggregated moderations usage details of the specific time bucket.3346 The aggregated moderations usage details of the specific time bucket.
3347 3347
3373 3373
3374 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3374 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3375 3375
33763376 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
3377 3377
3378 The aggregated images usage details of the specific time bucket.3378 The aggregated images usage details of the specific time bucket.
3379 3379
3413 3413
3414 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3414 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3415 3415
34163416 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
3417 3417
3418 The aggregated audio speeches usage details of the specific time bucket.3418 The aggregated audio speeches usage details of the specific time bucket.
3419 3419
3445 3445
3446 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3446 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3447 3447
34483448 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
3449 3449
3450 The aggregated audio transcriptions usage details of the specific time bucket.3450 The aggregated audio transcriptions usage details of the specific time bucket.
3451 3451
3477 3477
3478 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3478 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3479 3479
34803480 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
3481 3481
3482 The aggregated vector stores usage details of the specific time bucket.3482 The aggregated vector stores usage details of the specific time bucket.
3483 3483
3493 3493
3494 When `group_by=project_id`, this field provides the project ID of the grouped usage result.3494 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
3495 3495
34963496 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
3497 3497
3498 The aggregated code interpreter sessions usage details of the specific time bucket.3498 The aggregated code interpreter sessions usage details of the specific time bucket.
3499 3499
35003500 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
3501 3501
35023502 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
3503 3503
35043504 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
3505 3505
35063506 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
3507 3507
3508 - `project_id: optional string`3508 - `project_id: optional string`
3509 3509
3510 When `group_by=project_id`, this field provides the project ID of the grouped usage result.3510 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
3511 3511
35123512 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
3513 3513
3514 The aggregated costs details of the specific time bucket.3514 The aggregated costs details of the specific time bucket.
3515 3515
3566 {3566 {
3567 "end_time": 0,3567 "end_time": 0,
3568 "object": "bucket",3568 "object": "bucket",
35693569 "result": [ "results": [
3570 {3570 {
3571 "input_tokens": 0,3571 "input_tokens": 0,
3572 "num_model_requests": 0,3572 "num_model_requests": 0,
3674 3674
3675### Returns3675### Returns
3676 3676
36773677- `data: array of object { end_time, object, result, start_time }`- `data: array of object { end_time, object, results, start_time }`
3678 3678
3679 - `end_time: number`3679 - `end_time: number`
3680 3680
3682 3682
3683 - `"bucket"`3683 - `"bucket"`
3684 3684
36853685 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
3686 3686
36873687 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
3688 3688
3689 The aggregated completions usage details of the specific time bucket.3689 The aggregated completions usage details of the specific time bucket.
3690 3690
3740 3740
3741 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3741 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3742 3742
37433743 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
3744 3744
3745 The aggregated embeddings usage details of the specific time bucket.3745 The aggregated embeddings usage details of the specific time bucket.
3746 3746
3772 3772
3773 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3773 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3774 3774
37753775 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
3776 3776
3777 The aggregated moderations usage details of the specific time bucket.3777 The aggregated moderations usage details of the specific time bucket.
3778 3778
3804 3804
3805 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3805 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3806 3806
38073807 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
3808 3808
3809 The aggregated images usage details of the specific time bucket.3809 The aggregated images usage details of the specific time bucket.
3810 3810
3844 3844
3845 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3845 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3846 3846
38473847 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
3848 3848
3849 The aggregated audio speeches usage details of the specific time bucket.3849 The aggregated audio speeches usage details of the specific time bucket.
3850 3850
3876 3876
3877 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3877 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3878 3878
38793879 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
3880 3880
3881 The aggregated audio transcriptions usage details of the specific time bucket.3881 The aggregated audio transcriptions usage details of the specific time bucket.
3882 3882
3908 3908
3909 When `group_by=user_id`, this field provides the user ID of the grouped usage result.3909 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3910 3910
39113911 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
3912 3912
3913 The aggregated vector stores usage details of the specific time bucket.3913 The aggregated vector stores usage details of the specific time bucket.
3914 3914
3924 3924
3925 When `group_by=project_id`, this field provides the project ID of the grouped usage result.3925 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
3926 3926
39273927 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
3928 3928
3929 The aggregated code interpreter sessions usage details of the specific time bucket.3929 The aggregated code interpreter sessions usage details of the specific time bucket.
3930 3930
39313931 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
3932 3932
39333933 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
3934 3934
39353935 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
3936 3936
39373937 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
3938 3938
3939 - `project_id: optional string`3939 - `project_id: optional string`
3940 3940
3941 When `group_by=project_id`, this field provides the project ID of the grouped usage result.3941 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
3942 3942
39433943 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
3944 3944
3945 The aggregated costs details of the specific time bucket.3945 The aggregated costs details of the specific time bucket.
3946 3946
3997 {3997 {
3998 "end_time": 0,3998 "end_time": 0,
3999 "object": "bucket",3999 "object": "bucket",
40004000 "result": [ "results": [
4001 {4001 {
4002 "input_tokens": 0,4002 "input_tokens": 0,
4003 "num_model_requests": 0,4003 "num_model_requests": 0,
4066 4066
4067- `UsageAudioSpeechesResponse object { data, has_more, next_page, object }`4067- `UsageAudioSpeechesResponse object { data, has_more, next_page, object }`
4068 4068
40694069 - `data: array of object { end_time, object, result, start_time }` - `data: array of object { end_time, object, results, start_time }`
4070 4070
4071 - `end_time: number`4071 - `end_time: number`
4072 4072
4074 4074
4075 - `"bucket"`4075 - `"bucket"`
4076 4076
40774077 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
4078 4078
40794079 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
4080 4080
4081 The aggregated completions usage details of the specific time bucket.4081 The aggregated completions usage details of the specific time bucket.
4082 4082
4132 4132
4133 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4133 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4134 4134
41354135 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
4136 4136
4137 The aggregated embeddings usage details of the specific time bucket.4137 The aggregated embeddings usage details of the specific time bucket.
4138 4138
4164 4164
4165 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4165 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4166 4166
41674167 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
4168 4168
4169 The aggregated moderations usage details of the specific time bucket.4169 The aggregated moderations usage details of the specific time bucket.
4170 4170
4196 4196
4197 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4197 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4198 4198
41994199 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
4200 4200
4201 The aggregated images usage details of the specific time bucket.4201 The aggregated images usage details of the specific time bucket.
4202 4202
4236 4236
4237 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4237 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4238 4238
42394239 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
4240 4240
4241 The aggregated audio speeches usage details of the specific time bucket.4241 The aggregated audio speeches usage details of the specific time bucket.
4242 4242
4268 4268
4269 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4269 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4270 4270
42714271 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
4272 4272
4273 The aggregated audio transcriptions usage details of the specific time bucket.4273 The aggregated audio transcriptions usage details of the specific time bucket.
4274 4274
4300 4300
4301 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4301 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4302 4302
43034303 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
4304 4304
4305 The aggregated vector stores usage details of the specific time bucket.4305 The aggregated vector stores usage details of the specific time bucket.
4306 4306
4316 4316
4317 When `group_by=project_id`, this field provides the project ID of the grouped usage result.4317 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
4318 4318
43194319 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
4320 4320
4321 The aggregated code interpreter sessions usage details of the specific time bucket.4321 The aggregated code interpreter sessions usage details of the specific time bucket.
4322 4322
43234323 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
4324 4324
43254325 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
4326 4326
43274327 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
4328 4328
43294329 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
4330 4330
4331 - `project_id: optional string`4331 - `project_id: optional string`
4332 4332
4333 When `group_by=project_id`, this field provides the project ID of the grouped usage result.4333 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
4334 4334
43354335 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
4336 4336
4337 The aggregated costs details of the specific time bucket.4337 The aggregated costs details of the specific time bucket.
4338 4338
4378 4378
4379- `UsageAudioTranscriptionsResponse object { data, has_more, next_page, object }`4379- `UsageAudioTranscriptionsResponse object { data, has_more, next_page, object }`
4380 4380
43814381 - `data: array of object { end_time, object, result, start_time }` - `data: array of object { end_time, object, results, start_time }`
4382 4382
4383 - `end_time: number`4383 - `end_time: number`
4384 4384
4386 4386
4387 - `"bucket"`4387 - `"bucket"`
4388 4388
43894389 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
4390 4390
43914391 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
4392 4392
4393 The aggregated completions usage details of the specific time bucket.4393 The aggregated completions usage details of the specific time bucket.
4394 4394
4444 4444
4445 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4445 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4446 4446
44474447 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
4448 4448
4449 The aggregated embeddings usage details of the specific time bucket.4449 The aggregated embeddings usage details of the specific time bucket.
4450 4450
4476 4476
4477 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4477 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4478 4478
44794479 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
4480 4480
4481 The aggregated moderations usage details of the specific time bucket.4481 The aggregated moderations usage details of the specific time bucket.
4482 4482
4508 4508
4509 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4509 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4510 4510
45114511 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
4512 4512
4513 The aggregated images usage details of the specific time bucket.4513 The aggregated images usage details of the specific time bucket.
4514 4514
4548 4548
4549 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4549 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4550 4550
45514551 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
4552 4552
4553 The aggregated audio speeches usage details of the specific time bucket.4553 The aggregated audio speeches usage details of the specific time bucket.
4554 4554
4580 4580
4581 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4581 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4582 4582
45834583 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
4584 4584
4585 The aggregated audio transcriptions usage details of the specific time bucket.4585 The aggregated audio transcriptions usage details of the specific time bucket.
4586 4586
4612 4612
4613 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4613 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4614 4614
46154615 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
4616 4616
4617 The aggregated vector stores usage details of the specific time bucket.4617 The aggregated vector stores usage details of the specific time bucket.
4618 4618
4628 4628
4629 When `group_by=project_id`, this field provides the project ID of the grouped usage result.4629 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
4630 4630
46314631 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
4632 4632
4633 The aggregated code interpreter sessions usage details of the specific time bucket.4633 The aggregated code interpreter sessions usage details of the specific time bucket.
4634 4634
46354635 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
4636 4636
46374637 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
4638 4638
46394639 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
4640 4640
46414641 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
4642 4642
4643 - `project_id: optional string`4643 - `project_id: optional string`
4644 4644
4645 When `group_by=project_id`, this field provides the project ID of the grouped usage result.4645 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
4646 4646
46474647 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
4648 4648
4649 The aggregated costs details of the specific time bucket.4649 The aggregated costs details of the specific time bucket.
4650 4650
4690 4690
4691- `UsageCodeInterpreterSessionsResponse object { data, has_more, next_page, object }`4691- `UsageCodeInterpreterSessionsResponse object { data, has_more, next_page, object }`
4692 4692
46934693 - `data: array of object { end_time, object, result, start_time }` - `data: array of object { end_time, object, results, start_time }`
4694 4694
4695 - `end_time: number`4695 - `end_time: number`
4696 4696
4698 4698
4699 - `"bucket"`4699 - `"bucket"`
4700 4700
47014701 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
4702 4702
47034703 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
4704 4704
4705 The aggregated completions usage details of the specific time bucket.4705 The aggregated completions usage details of the specific time bucket.
4706 4706
4756 4756
4757 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4757 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4758 4758
47594759 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
4760 4760
4761 The aggregated embeddings usage details of the specific time bucket.4761 The aggregated embeddings usage details of the specific time bucket.
4762 4762
4788 4788
4789 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4789 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4790 4790
47914791 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
4792 4792
4793 The aggregated moderations usage details of the specific time bucket.4793 The aggregated moderations usage details of the specific time bucket.
4794 4794
4820 4820
4821 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4821 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4822 4822
48234823 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
4824 4824
4825 The aggregated images usage details of the specific time bucket.4825 The aggregated images usage details of the specific time bucket.
4826 4826
4860 4860
4861 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4861 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4862 4862
48634863 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
4864 4864
4865 The aggregated audio speeches usage details of the specific time bucket.4865 The aggregated audio speeches usage details of the specific time bucket.
4866 4866
4892 4892
4893 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4893 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4894 4894
48954895 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
4896 4896
4897 The aggregated audio transcriptions usage details of the specific time bucket.4897 The aggregated audio transcriptions usage details of the specific time bucket.
4898 4898
4924 4924
4925 When `group_by=user_id`, this field provides the user ID of the grouped usage result.4925 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
4926 4926
49274927 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
4928 4928
4929 The aggregated vector stores usage details of the specific time bucket.4929 The aggregated vector stores usage details of the specific time bucket.
4930 4930
4940 4940
4941 When `group_by=project_id`, this field provides the project ID of the grouped usage result.4941 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
4942 4942
49434943 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
4944 4944
4945 The aggregated code interpreter sessions usage details of the specific time bucket.4945 The aggregated code interpreter sessions usage details of the specific time bucket.
4946 4946
49474947 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
4948 4948
49494949 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
4950 4950
49514951 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
4952 4952
49534953 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
4954 4954
4955 - `project_id: optional string`4955 - `project_id: optional string`
4956 4956
4957 When `group_by=project_id`, this field provides the project ID of the grouped usage result.4957 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
4958 4958
49594959 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
4960 4960
4961 The aggregated costs details of the specific time bucket.4961 The aggregated costs details of the specific time bucket.
4962 4962
5002 5002
5003- `UsageCompletionsResponse object { data, has_more, next_page, object }`5003- `UsageCompletionsResponse object { data, has_more, next_page, object }`
5004 5004
50055005 - `data: array of object { end_time, object, result, start_time }` - `data: array of object { end_time, object, results, start_time }`
5006 5006
5007 - `end_time: number`5007 - `end_time: number`
5008 5008
5010 5010
5011 - `"bucket"`5011 - `"bucket"`
5012 5012
50135013 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
5014 5014
50155015 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
5016 5016
5017 The aggregated completions usage details of the specific time bucket.5017 The aggregated completions usage details of the specific time bucket.
5018 5018
5068 5068
5069 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5069 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5070 5070
50715071 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
5072 5072
5073 The aggregated embeddings usage details of the specific time bucket.5073 The aggregated embeddings usage details of the specific time bucket.
5074 5074
5100 5100
5101 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5101 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5102 5102
51035103 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
5104 5104
5105 The aggregated moderations usage details of the specific time bucket.5105 The aggregated moderations usage details of the specific time bucket.
5106 5106
5132 5132
5133 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5133 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5134 5134
51355135 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
5136 5136
5137 The aggregated images usage details of the specific time bucket.5137 The aggregated images usage details of the specific time bucket.
5138 5138
5172 5172
5173 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5173 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5174 5174
51755175 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
5176 5176
5177 The aggregated audio speeches usage details of the specific time bucket.5177 The aggregated audio speeches usage details of the specific time bucket.
5178 5178
5204 5204
5205 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5205 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5206 5206
52075207 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
5208 5208
5209 The aggregated audio transcriptions usage details of the specific time bucket.5209 The aggregated audio transcriptions usage details of the specific time bucket.
5210 5210
5236 5236
5237 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5237 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5238 5238
52395239 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
5240 5240
5241 The aggregated vector stores usage details of the specific time bucket.5241 The aggregated vector stores usage details of the specific time bucket.
5242 5242
5252 5252
5253 When `group_by=project_id`, this field provides the project ID of the grouped usage result.5253 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
5254 5254
52555255 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
5256 5256
5257 The aggregated code interpreter sessions usage details of the specific time bucket.5257 The aggregated code interpreter sessions usage details of the specific time bucket.
5258 5258
52595259 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
5260 5260
52615261 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
5262 5262
52635263 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
5264 5264
52655265 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
5266 5266
5267 - `project_id: optional string`5267 - `project_id: optional string`
5268 5268
5269 When `group_by=project_id`, this field provides the project ID of the grouped usage result.5269 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
5270 5270
52715271 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
5272 5272
5273 The aggregated costs details of the specific time bucket.5273 The aggregated costs details of the specific time bucket.
5274 5274
5314 5314
5315- `UsageEmbeddingsResponse object { data, has_more, next_page, object }`5315- `UsageEmbeddingsResponse object { data, has_more, next_page, object }`
5316 5316
53175317 - `data: array of object { end_time, object, result, start_time }` - `data: array of object { end_time, object, results, start_time }`
5318 5318
5319 - `end_time: number`5319 - `end_time: number`
5320 5320
5322 5322
5323 - `"bucket"`5323 - `"bucket"`
5324 5324
53255325 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
5326 5326
53275327 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
5328 5328
5329 The aggregated completions usage details of the specific time bucket.5329 The aggregated completions usage details of the specific time bucket.
5330 5330
5380 5380
5381 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5381 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5382 5382
53835383 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
5384 5384
5385 The aggregated embeddings usage details of the specific time bucket.5385 The aggregated embeddings usage details of the specific time bucket.
5386 5386
5412 5412
5413 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5413 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5414 5414
54155415 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
5416 5416
5417 The aggregated moderations usage details of the specific time bucket.5417 The aggregated moderations usage details of the specific time bucket.
5418 5418
5444 5444
5445 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5445 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5446 5446
54475447 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
5448 5448
5449 The aggregated images usage details of the specific time bucket.5449 The aggregated images usage details of the specific time bucket.
5450 5450
5484 5484
5485 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5485 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5486 5486
54875487 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
5488 5488
5489 The aggregated audio speeches usage details of the specific time bucket.5489 The aggregated audio speeches usage details of the specific time bucket.
5490 5490
5516 5516
5517 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5517 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5518 5518
55195519 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
5520 5520
5521 The aggregated audio transcriptions usage details of the specific time bucket.5521 The aggregated audio transcriptions usage details of the specific time bucket.
5522 5522
5548 5548
5549 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5549 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5550 5550
55515551 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
5552 5552
5553 The aggregated vector stores usage details of the specific time bucket.5553 The aggregated vector stores usage details of the specific time bucket.
5554 5554
5564 5564
5565 When `group_by=project_id`, this field provides the project ID of the grouped usage result.5565 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
5566 5566
55675567 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
5568 5568
5569 The aggregated code interpreter sessions usage details of the specific time bucket.5569 The aggregated code interpreter sessions usage details of the specific time bucket.
5570 5570
55715571 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
5572 5572
55735573 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
5574 5574
55755575 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
5576 5576
55775577 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
5578 5578
5579 - `project_id: optional string`5579 - `project_id: optional string`
5580 5580
5581 When `group_by=project_id`, this field provides the project ID of the grouped usage result.5581 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
5582 5582
55835583 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
5584 5584
5585 The aggregated costs details of the specific time bucket.5585 The aggregated costs details of the specific time bucket.
5586 5586
5626 5626
5627- `UsageImagesResponse object { data, has_more, next_page, object }`5627- `UsageImagesResponse object { data, has_more, next_page, object }`
5628 5628
56295629 - `data: array of object { end_time, object, result, start_time }` - `data: array of object { end_time, object, results, start_time }`
5630 5630
5631 - `end_time: number`5631 - `end_time: number`
5632 5632
5634 5634
5635 - `"bucket"`5635 - `"bucket"`
5636 5636
56375637 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
5638 5638
56395639 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
5640 5640
5641 The aggregated completions usage details of the specific time bucket.5641 The aggregated completions usage details of the specific time bucket.
5642 5642
5692 5692
5693 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5693 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5694 5694
56955695 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
5696 5696
5697 The aggregated embeddings usage details of the specific time bucket.5697 The aggregated embeddings usage details of the specific time bucket.
5698 5698
5724 5724
5725 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5725 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5726 5726
57275727 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
5728 5728
5729 The aggregated moderations usage details of the specific time bucket.5729 The aggregated moderations usage details of the specific time bucket.
5730 5730
5756 5756
5757 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5757 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5758 5758
57595759 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
5760 5760
5761 The aggregated images usage details of the specific time bucket.5761 The aggregated images usage details of the specific time bucket.
5762 5762
5796 5796
5797 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5797 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5798 5798
57995799 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
5800 5800
5801 The aggregated audio speeches usage details of the specific time bucket.5801 The aggregated audio speeches usage details of the specific time bucket.
5802 5802
5828 5828
5829 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5829 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5830 5830
58315831 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
5832 5832
5833 The aggregated audio transcriptions usage details of the specific time bucket.5833 The aggregated audio transcriptions usage details of the specific time bucket.
5834 5834
5860 5860
5861 When `group_by=user_id`, this field provides the user ID of the grouped usage result.5861 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
5862 5862
58635863 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
5864 5864
5865 The aggregated vector stores usage details of the specific time bucket.5865 The aggregated vector stores usage details of the specific time bucket.
5866 5866
5876 5876
5877 When `group_by=project_id`, this field provides the project ID of the grouped usage result.5877 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
5878 5878
58795879 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
5880 5880
5881 The aggregated code interpreter sessions usage details of the specific time bucket.5881 The aggregated code interpreter sessions usage details of the specific time bucket.
5882 5882
58835883 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
5884 5884
58855885 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
5886 5886
58875887 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
5888 5888
58895889 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
5890 5890
5891 - `project_id: optional string`5891 - `project_id: optional string`
5892 5892
5893 When `group_by=project_id`, this field provides the project ID of the grouped usage result.5893 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
5894 5894
58955895 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
5896 5896
5897 The aggregated costs details of the specific time bucket.5897 The aggregated costs details of the specific time bucket.
5898 5898
5938 5938
5939- `UsageModerationsResponse object { data, has_more, next_page, object }`5939- `UsageModerationsResponse object { data, has_more, next_page, object }`
5940 5940
59415941 - `data: array of object { end_time, object, result, start_time }` - `data: array of object { end_time, object, results, start_time }`
5942 5942
5943 - `end_time: number`5943 - `end_time: number`
5944 5944
5946 5946
5947 - `"bucket"`5947 - `"bucket"`
5948 5948
59495949 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
5950 5950
59515951 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
5952 5952
5953 The aggregated completions usage details of the specific time bucket.5953 The aggregated completions usage details of the specific time bucket.
5954 5954
6004 6004
6005 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6005 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6006 6006
60076007 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
6008 6008
6009 The aggregated embeddings usage details of the specific time bucket.6009 The aggregated embeddings usage details of the specific time bucket.
6010 6010
6036 6036
6037 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6037 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6038 6038
60396039 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
6040 6040
6041 The aggregated moderations usage details of the specific time bucket.6041 The aggregated moderations usage details of the specific time bucket.
6042 6042
6068 6068
6069 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6069 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6070 6070
60716071 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
6072 6072
6073 The aggregated images usage details of the specific time bucket.6073 The aggregated images usage details of the specific time bucket.
6074 6074
6108 6108
6109 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6109 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6110 6110
61116111 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
6112 6112
6113 The aggregated audio speeches usage details of the specific time bucket.6113 The aggregated audio speeches usage details of the specific time bucket.
6114 6114
6140 6140
6141 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6141 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6142 6142
61436143 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
6144 6144
6145 The aggregated audio transcriptions usage details of the specific time bucket.6145 The aggregated audio transcriptions usage details of the specific time bucket.
6146 6146
6172 6172
6173 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6173 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6174 6174
61756175 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
6176 6176
6177 The aggregated vector stores usage details of the specific time bucket.6177 The aggregated vector stores usage details of the specific time bucket.
6178 6178
6188 6188
6189 When `group_by=project_id`, this field provides the project ID of the grouped usage result.6189 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6190 6190
61916191 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
6192 6192
6193 The aggregated code interpreter sessions usage details of the specific time bucket.6193 The aggregated code interpreter sessions usage details of the specific time bucket.
6194 6194
61956195 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
6196 6196
61976197 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
6198 6198
61996199 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
6200 6200
62016201 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
6202 6202
6203 - `project_id: optional string`6203 - `project_id: optional string`
6204 6204
6205 When `group_by=project_id`, this field provides the project ID of the grouped usage result.6205 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6206 6206
62076207 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
6208 6208
6209 The aggregated costs details of the specific time bucket.6209 The aggregated costs details of the specific time bucket.
6210 6210
6250 6250
6251- `UsageVectorStoresResponse object { data, has_more, next_page, object }`6251- `UsageVectorStoresResponse object { data, has_more, next_page, object }`
6252 6252
62536253 - `data: array of object { end_time, object, result, start_time }` - `data: array of object { end_time, object, results, start_time }`
6254 6254
6255 - `end_time: number`6255 - `end_time: number`
6256 6256
6258 6258
6259 - `"bucket"`6259 - `"bucket"`
6260 6260
62616261 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
6262 6262
62636263 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
6264 6264
6265 The aggregated completions usage details of the specific time bucket.6265 The aggregated completions usage details of the specific time bucket.
6266 6266
6316 6316
6317 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6317 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6318 6318
63196319 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
6320 6320
6321 The aggregated embeddings usage details of the specific time bucket.6321 The aggregated embeddings usage details of the specific time bucket.
6322 6322
6348 6348
6349 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6349 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6350 6350
63516351 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
6352 6352
6353 The aggregated moderations usage details of the specific time bucket.6353 The aggregated moderations usage details of the specific time bucket.
6354 6354
6380 6380
6381 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6381 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6382 6382
63836383 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
6384 6384
6385 The aggregated images usage details of the specific time bucket.6385 The aggregated images usage details of the specific time bucket.
6386 6386
6420 6420
6421 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6421 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6422 6422
64236423 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
6424 6424
6425 The aggregated audio speeches usage details of the specific time bucket.6425 The aggregated audio speeches usage details of the specific time bucket.
6426 6426
6452 6452
6453 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6453 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6454 6454
64556455 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
6456 6456
6457 The aggregated audio transcriptions usage details of the specific time bucket.6457 The aggregated audio transcriptions usage details of the specific time bucket.
6458 6458
6484 6484
6485 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6485 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6486 6486
64876487 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
6488 6488
6489 The aggregated vector stores usage details of the specific time bucket.6489 The aggregated vector stores usage details of the specific time bucket.
6490 6490
6500 6500
6501 When `group_by=project_id`, this field provides the project ID of the grouped usage result.6501 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6502 6502
65036503 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
6504 6504
6505 The aggregated code interpreter sessions usage details of the specific time bucket.6505 The aggregated code interpreter sessions usage details of the specific time bucket.
6506 6506
65076507 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
6508 6508
65096509 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
6510 6510
65116511 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
6512 6512
65136513 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
6514 6514
6515 - `project_id: optional string`6515 - `project_id: optional string`
6516 6516
6517 When `group_by=project_id`, this field provides the project ID of the grouped usage result.6517 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6518 6518
65196519 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
6520 6520
6521 The aggregated costs details of the specific time bucket.6521 The aggregated costs details of the specific time bucket.
6522 6522
6562 6562
6563- `UsageCostsResponse object { data, has_more, next_page, object }`6563- `UsageCostsResponse object { data, has_more, next_page, object }`
6564 6564
65656565 - `data: array of object { end_time, object, result, start_time }` - `data: array of object { end_time, object, results, start_time }`
6566 6566
6567 - `end_time: number`6567 - `end_time: number`
6568 6568
6570 6570
6571 - `"bucket"`6571 - `"bucket"`
6572 6572
65736573 - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more`
6574 6574
65756575 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
6576 6576
6577 The aggregated completions usage details of the specific time bucket.6577 The aggregated completions usage details of the specific time bucket.
6578 6578
6628 6628
6629 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6629 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6630 6630
66316631 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
6632 6632
6633 The aggregated embeddings usage details of the specific time bucket.6633 The aggregated embeddings usage details of the specific time bucket.
6634 6634
6660 6660
6661 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6661 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6662 6662
66636663 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
6664 6664
6665 The aggregated moderations usage details of the specific time bucket.6665 The aggregated moderations usage details of the specific time bucket.
6666 6666
6692 6692
6693 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6693 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6694 6694
66956695 - `UsageImagesResult object { images, num_model_requests, object, 6 more }` - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }`
6696 6696
6697 The aggregated images usage details of the specific time bucket.6697 The aggregated images usage details of the specific time bucket.
6698 6698
6732 6732
6733 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6733 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6734 6734
67356735 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
6736 6736
6737 The aggregated audio speeches usage details of the specific time bucket.6737 The aggregated audio speeches usage details of the specific time bucket.
6738 6738
6764 6764
6765 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6765 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6766 6766
67676767 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
6768 6768
6769 The aggregated audio transcriptions usage details of the specific time bucket.6769 The aggregated audio transcriptions usage details of the specific time bucket.
6770 6770
6796 6796
6797 When `group_by=user_id`, this field provides the user ID of the grouped usage result.6797 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6798 6798
67996799 - `UsageVectorStoresResult object { object, usage_bytes, project_id }` - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }`
6800 6800
6801 The aggregated vector stores usage details of the specific time bucket.6801 The aggregated vector stores usage details of the specific time bucket.
6802 6802
6812 6812
6813 When `group_by=project_id`, this field provides the project ID of the grouped usage result.6813 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6814 6814
68156815 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }`
6816 6816
6817 The aggregated code interpreter sessions usage details of the specific time bucket.6817 The aggregated code interpreter sessions usage details of the specific time bucket.
6818 6818
68196819 - `object: "organization.usage.code_interpreter_sessions.result"` - `num_sessions: number`
6820 6820
68216821 - `"organization.usage.code_interpreter_sessions.result"` The number of code interpreter sessions.
6822 6822
68236823 - `num_sessions: optional number` - `object: "organization.usage.code_interpreter_sessions.result"`
6824 6824
68256825 The number of code interpreter sessions. - `"organization.usage.code_interpreter_sessions.result"`
6826 6826
6827 - `project_id: optional string`6827 - `project_id: optional string`
6828 6828
6829 When `group_by=project_id`, this field provides the project ID of the grouped usage result.6829 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6830 6830
68316831 - `CostsResult object { object, amount, api_key_id, 2 more }` - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }`
6832 6832
6833 The aggregated costs details of the specific time bucket.6833 The aggregated costs details of the specific time bucket.
6834 6834
32 32
33 The Unix timestamp (in seconds) of when the user was added.33 The Unix timestamp (in seconds) of when the user was added.
34 34
3535 - `email: string` - `object: "organization.user"`
36
37 The object type, which is always `organization.user`
38
39 - `"organization.user"`
40
41 - `api_key_last_used_at: optional number`
42
43 The Unix timestamp (in seconds) of the user's last API key usage.
44
45 - `created: optional number`
46
47 The Unix timestamp (in seconds) of when the user was created.
48
49 - `developer_persona: optional string`
50
51 The developer persona metadata for the user.
52
53 - `email: optional string`
36 54
37 The email address of the user55 The email address of the user
38 56
3957 - `name: string` - `is_default: optional boolean`
58
59 Whether this is the organization's default user.
60
61 - `is_scale_tier_authorized_purchaser: optional boolean`
62
63 Whether the user is an authorized purchaser for Scale Tier.
64
65 - `is_scim_managed: optional boolean`
66
67 Whether the user is managed through SCIM.
68
69 - `is_service_account: optional boolean`
70
71 Whether the user is a service account.
72
73 - `name: optional string`
40 74
41 The name of the user75 The name of the user
42 76
4377 - `object: "organization.user"` - `projects: optional object { data, object }`
44 78
4579 The object type, which is always `organization.user` Projects associated with the user, if included.
46 80
4781 - `"organization.user"` - `data: array of object { id, name, role }`
82
83 - `id: optional string`
84
85 - `name: optional string`
86
87 - `role: optional string`
48 88
4989 - `role: "owner" or "reader"` - `object: "list"`
90
91 - `"list"`
92
93 - `role: optional string`
50 94
51 `owner` or `reader`95 `owner` or `reader`
52 96
5397 - `"owner"` - `technical_level: optional string`
54 98
5599 - `"reader"` The technical level metadata for the user.
56 100
57101- `first_id: string` - `user: optional object { id, object, banned, 5 more }`
58 102
59103- `has_more: boolean` Nested user details.
60 104
61105- `last_id: string` - `id: string`
106
107 - `object: "user"`
108
109 - `"user"`
110
111 - `banned: optional boolean`
112
113 - `banned_at: optional number`
114
115 - `email: optional string`
116
117 - `enabled: optional boolean`
118
119 - `name: optional string`
120
121 - `picture: optional string`
122
123- `has_more: boolean`
62 124
63- `object: "list"`125- `object: "list"`
64 126
65 - `"list"`127 - `"list"`
66 128
129- `first_id: optional string`
130
131- `last_id: optional string`
132
67### Example133### Example
68 134
69```http135```http
79 {145 {
80 "id": "id",146 "id": "id",
81 "added_at": 0,147 "added_at": 0,
148 "object": "organization.user",
149 "api_key_last_used_at": 0,
150 "created": 0,
151 "developer_persona": "developer_persona",
82 "email": "email",152 "email": "email",
153 "is_default": true,
154 "is_scale_tier_authorized_purchaser": true,
155 "is_scim_managed": true,
156 "is_service_account": true,
83 "name": "name",157 "name": "name",
84158 "object": "organization.user", "projects": {
85159 "role": "owner" "data": [
160 {
161 "id": "id",
162 "name": "name",
163 "role": "role"
86 }164 }
87 ],165 ],
88 "first_id": "first_id",
89 "has_more": true,
90 "last_id": "last_id",
91 "object": "list"166 "object": "list"
167 },
168 "role": "role",
169 "technical_level": "technical_level",
170 "user": {
171 "id": "id",
172 "object": "user",
173 "banned": true,
174 "banned_at": 0,
175 "email": "email",
176 "enabled": true,
177 "name": "name",
178 "picture": "picture"
179 }
180 }
181 ],
182 "has_more": true,
183 "object": "list",
184 "first_id": "first_id",
185 "last_id": "last_id"
92}186}
93```187```
94 188
133 227
134### Returns228### Returns
135 229
136230- `OrganizationUser object { id, added_at, email, 3 more }`- `OrganizationUser object { id, added_at, object, 13 more }`
137 231
138 Represents an individual `user` within an organization.232 Represents an individual `user` within an organization.
139 233
145 239
146 The Unix timestamp (in seconds) of when the user was added.240 The Unix timestamp (in seconds) of when the user was added.
147 241
148242 - `email: string` - `object: "organization.user"`
243
244 The object type, which is always `organization.user`
245
246 - `"organization.user"`
247
248 - `api_key_last_used_at: optional number`
249
250 The Unix timestamp (in seconds) of the user's last API key usage.
251
252 - `created: optional number`
253
254 The Unix timestamp (in seconds) of when the user was created.
255
256 - `developer_persona: optional string`
257
258 The developer persona metadata for the user.
259
260 - `email: optional string`
149 261
150 The email address of the user262 The email address of the user
151 263
152264 - `name: string` - `is_default: optional boolean`
265
266 Whether this is the organization's default user.
267
268 - `is_scale_tier_authorized_purchaser: optional boolean`
269
270 Whether the user is an authorized purchaser for Scale Tier.
271
272 - `is_scim_managed: optional boolean`
273
274 Whether the user is managed through SCIM.
275
276 - `is_service_account: optional boolean`
277
278 Whether the user is a service account.
279
280 - `name: optional string`
153 281
154 The name of the user282 The name of the user
155 283
156284 - `object: "organization.user"` - `projects: optional object { data, object }`
157 285
158286 The object type, which is always `organization.user` Projects associated with the user, if included.
159 287
160288 - `"organization.user"` - `data: array of object { id, name, role }`
289
290 - `id: optional string`
291
292 - `name: optional string`
293
294 - `role: optional string`
295
296 - `object: "list"`
297
298 - `"list"`
161 299
162300 - `role: "owner" or "reader"` - `role: optional string`
163 301
164 `owner` or `reader`302 `owner` or `reader`
165 303
166304 - `"owner"` - `technical_level: optional string`
305
306 The technical level metadata for the user.
307
308 - `user: optional object { id, object, banned, 5 more }`
309
310 Nested user details.
311
312 - `id: string`
313
314 - `object: "user"`
315
316 - `"user"`
317
318 - `banned: optional boolean`
319
320 - `banned_at: optional number`
321
322 - `email: optional string`
167 323
168324 - `"reader"` - `enabled: optional boolean`
325
326 - `name: optional string`
327
328 - `picture: optional string`
169 329
170### Example330### Example
171 331
180{340{
181 "id": "id",341 "id": "id",
182 "added_at": 0,342 "added_at": 0,
343 "object": "organization.user",
344 "api_key_last_used_at": 0,
345 "created": 0,
346 "developer_persona": "developer_persona",
183 "email": "email",347 "email": "email",
348 "is_default": true,
349 "is_scale_tier_authorized_purchaser": true,
350 "is_scim_managed": true,
351 "is_service_account": true,
184 "name": "name",352 "name": "name",
185353 "object": "organization.user", "projects": {
186354 "role": "owner" "data": [
355 {
356 "id": "id",
357 "name": "name",
358 "role": "role"
359 }
360 ],
361 "object": "list"
362 },
363 "role": "role",
364 "technical_level": "technical_level",
365 "user": {
366 "id": "id",
367 "object": "user",
368 "banned": true,
369 "banned_at": 0,
370 "email": "email",
371 "enabled": true,
372 "name": "name",
373 "picture": "picture"
374 }
187}375}
188```376```
189 377
220 408
221### Body Parameters409### Body Parameters
222 410
223411- `role: "owner" or "reader"`- `developer_persona: optional string`
412
413 Developer persona metadata.
414
415- `role: optional string`
224 416
225 `owner` or `reader`417 `owner` or `reader`
226 418
227419 - `"owner"`- `role_id: optional string`
228 420
229421 - `"reader"` Role ID to assign to the user.
422
423- `technical_level: optional string`
424
425 Technical level metadata.
230 426
231### Returns427### Returns
232 428
233429- `OrganizationUser object { id, added_at, email, 3 more }`- `OrganizationUser object { id, added_at, object, 13 more }`
234 430
235 Represents an individual `user` within an organization.431 Represents an individual `user` within an organization.
236 432
242 438
243 The Unix timestamp (in seconds) of when the user was added.439 The Unix timestamp (in seconds) of when the user was added.
244 440
245441 - `email: string` - `object: "organization.user"`
442
443 The object type, which is always `organization.user`
444
445 - `"organization.user"`
446
447 - `api_key_last_used_at: optional number`
448
449 The Unix timestamp (in seconds) of the user's last API key usage.
450
451 - `created: optional number`
452
453 The Unix timestamp (in seconds) of when the user was created.
454
455 - `developer_persona: optional string`
456
457 The developer persona metadata for the user.
458
459 - `email: optional string`
246 460
247 The email address of the user461 The email address of the user
248 462
249463 - `name: string` - `is_default: optional boolean`
464
465 Whether this is the organization's default user.
466
467 - `is_scale_tier_authorized_purchaser: optional boolean`
468
469 Whether the user is an authorized purchaser for Scale Tier.
470
471 - `is_scim_managed: optional boolean`
472
473 Whether the user is managed through SCIM.
474
475 - `is_service_account: optional boolean`
476
477 Whether the user is a service account.
478
479 - `name: optional string`
250 480
251 The name of the user481 The name of the user
252 482
253483 - `object: "organization.user"` - `projects: optional object { data, object }`
254 484
255485 The object type, which is always `organization.user` Projects associated with the user, if included.
256 486
257487 - `"organization.user"` - `data: array of object { id, name, role }`
488
489 - `id: optional string`
490
491 - `name: optional string`
492
493 - `role: optional string`
494
495 - `object: "list"`
496
497 - `"list"`
258 498
259499 - `role: "owner" or "reader"` - `role: optional string`
260 500
261 `owner` or `reader`501 `owner` or `reader`
262 502
263503 - `"owner"` - `technical_level: optional string`
504
505 The technical level metadata for the user.
506
507 - `user: optional object { id, object, banned, 5 more }`
508
509 Nested user details.
510
511 - `id: string`
512
513 - `object: "user"`
514
515 - `"user"`
516
517 - `banned: optional boolean`
518
519 - `banned_at: optional number`
264 520
265521 - `"reader"` - `email: optional string`
522
523 - `enabled: optional boolean`
524
525 - `name: optional string`
526
527 - `picture: optional string`
266 528
267### Example529### Example
268 530
270curl https://api.openai.com/v1/organization/users/$USER_ID \532curl https://api.openai.com/v1/organization/users/$USER_ID \
271 -H 'Content-Type: application/json' \533 -H 'Content-Type: application/json' \
272 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \534 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
273535 -d '{ -d '{}'
274 "role": "owner"
275 }'
276```536```
277 537
278#### Response538#### Response
281{541{
282 "id": "id",542 "id": "id",
283 "added_at": 0,543 "added_at": 0,
544 "object": "organization.user",
545 "api_key_last_used_at": 0,
546 "created": 0,
547 "developer_persona": "developer_persona",
284 "email": "email",548 "email": "email",
549 "is_default": true,
550 "is_scale_tier_authorized_purchaser": true,
551 "is_scim_managed": true,
552 "is_service_account": true,
285 "name": "name",553 "name": "name",
286554 "object": "organization.user", "projects": {
287555 "role": "owner" "data": [
556 {
557 "id": "id",
558 "name": "name",
559 "role": "role"
560 }
561 ],
562 "object": "list"
563 },
564 "role": "role",
565 "technical_level": "technical_level",
566 "user": {
567 "id": "id",
568 "object": "user",
569 "banned": true,
570 "banned_at": 0,
571 "email": "email",
572 "enabled": true,
573 "name": "name",
574 "picture": "picture"
575 }
288}576}
289```577```
290 578
372 660
373### Organization User661### Organization User
374 662
375663- `OrganizationUser object { id, added_at, email, 3 more }`- `OrganizationUser object { id, added_at, object, 13 more }`
376 664
377 Represents an individual `user` within an organization.665 Represents an individual `user` within an organization.
378 666
384 672
385 The Unix timestamp (in seconds) of when the user was added.673 The Unix timestamp (in seconds) of when the user was added.
386 674
387675 - `email: string` - `object: "organization.user"`
676
677 The object type, which is always `organization.user`
678
679 - `"organization.user"`
680
681 - `api_key_last_used_at: optional number`
682
683 The Unix timestamp (in seconds) of the user's last API key usage.
684
685 - `created: optional number`
686
687 The Unix timestamp (in seconds) of when the user was created.
688
689 - `developer_persona: optional string`
690
691 The developer persona metadata for the user.
692
693 - `email: optional string`
388 694
389 The email address of the user695 The email address of the user
390 696
391697 - `name: string` - `is_default: optional boolean`
698
699 Whether this is the organization's default user.
700
701 - `is_scale_tier_authorized_purchaser: optional boolean`
702
703 Whether the user is an authorized purchaser for Scale Tier.
704
705 - `is_scim_managed: optional boolean`
706
707 Whether the user is managed through SCIM.
708
709 - `is_service_account: optional boolean`
710
711 Whether the user is a service account.
712
713 - `name: optional string`
392 714
393 The name of the user715 The name of the user
394 716
395717 - `object: "organization.user"` - `projects: optional object { data, object }`
396 718
397719 The object type, which is always `organization.user` Projects associated with the user, if included.
398 720
399721 - `"organization.user"` - `data: array of object { id, name, role }`
722
723 - `id: optional string`
724
725 - `name: optional string`
726
727 - `role: optional string`
728
729 - `object: "list"`
730
731 - `"list"`
400 732
401733 - `role: "owner" or "reader"` - `role: optional string`
402 734
403 `owner` or `reader`735 `owner` or `reader`
404 736
405737 - `"owner"` - `technical_level: optional string`
738
739 The technical level metadata for the user.
740
741 - `user: optional object { id, object, banned, 5 more }`
742
743 Nested user details.
744
745 - `id: string`
746
747 - `object: "user"`
748
749 - `"user"`
750
751 - `banned: optional boolean`
752
753 - `banned_at: optional number`
754
755 - `email: optional string`
406 756
407757 - `"reader"` - `enabled: optional boolean`
758
759 - `name: optional string`
760
761 - `picture: optional string`
408 762
409### User Delete Response763### User Delete Response
410 764
660 1014
661 The Unix timestamp (in seconds) of when the user was added.1015 The Unix timestamp (in seconds) of when the user was added.
662 1016
6631017 - `email: string` - `object: "organization.user"`
1018
1019 The object type, which is always `organization.user`
1020
1021 - `"organization.user"`
1022
1023 - `api_key_last_used_at: optional number`
1024
1025 The Unix timestamp (in seconds) of the user's last API key usage.
1026
1027 - `created: optional number`
1028
1029 The Unix timestamp (in seconds) of when the user was created.
1030
1031 - `developer_persona: optional string`
1032
1033 The developer persona metadata for the user.
1034
1035 - `email: optional string`
664 1036
665 The email address of the user1037 The email address of the user
666 1038
6671039 - `name: string` - `is_default: optional boolean`
1040
1041 Whether this is the organization's default user.
1042
1043 - `is_scale_tier_authorized_purchaser: optional boolean`
1044
1045 Whether the user is an authorized purchaser for Scale Tier.
1046
1047 - `is_scim_managed: optional boolean`
1048
1049 Whether the user is managed through SCIM.
1050
1051 - `is_service_account: optional boolean`
1052
1053 Whether the user is a service account.
1054
1055 - `name: optional string`
668 1056
669 The name of the user1057 The name of the user
670 1058
6711059 - `object: "organization.user"` - `projects: optional object { data, object }`
672 1060
6731061 The object type, which is always `organization.user` Projects associated with the user, if included.
674 1062
6751063 - `"organization.user"` - `data: array of object { id, name, role }`
676 1064
6771065 - `role: "owner" or "reader"` - `id: optional string`
1066
1067 - `name: optional string`
1068
1069 - `role: optional string`
1070
1071 - `object: "list"`
1072
1073 - `"list"`
1074
1075 - `role: optional string`
678 1076
679 `owner` or `reader`1077 `owner` or `reader`
680 1078
6811079 - `"owner"` - `technical_level: optional string`
1080
1081 The technical level metadata for the user.
1082
1083 - `user: optional object { id, object, banned, 5 more }`
1084
1085 Nested user details.
1086
1087 - `id: string`
1088
1089 - `object: "user"`
1090
1091 - `"user"`
1092
1093 - `banned: optional boolean`
1094
1095 - `banned_at: optional number`
682 1096
6831097 - `"reader"` - `email: optional string`
1098
1099 - `enabled: optional boolean`
1100
1101 - `name: optional string`
1102
1103 - `picture: optional string`
684 1104
685### Example1105### Example
686 1106
712 "user": {1132 "user": {
713 "id": "id",1133 "id": "id",
714 "added_at": 0,1134 "added_at": 0,
1135 "object": "organization.user",
1136 "api_key_last_used_at": 0,
1137 "created": 0,
1138 "developer_persona": "developer_persona",
715 "email": "email",1139 "email": "email",
1140 "is_default": true,
1141 "is_scale_tier_authorized_purchaser": true,
1142 "is_scim_managed": true,
1143 "is_service_account": true,
716 "name": "name",1144 "name": "name",
7171145 "object": "organization.user", "projects": {
7181146 "role": "owner" "data": [
1147 {
1148 "id": "id",
1149 "name": "name",
1150 "role": "role"
1151 }
1152 ],
1153 "object": "list"
1154 },
1155 "role": "role",
1156 "technical_level": "technical_level",
1157 "user": {
1158 "id": "id",
1159 "object": "user",
1160 "banned": true,
1161 "banned_at": 0,
1162 "email": "email",
1163 "enabled": true,
1164 "name": "name",
1165 "picture": "picture"
1166 }
719 }1167 }
720}1168}
721```1169```
925 1373
926 The Unix timestamp (in seconds) of when the user was added.1374 The Unix timestamp (in seconds) of when the user was added.
927 1375
9281376 - `email: string` - `object: "organization.user"`
1377
1378 The object type, which is always `organization.user`
1379
1380 - `"organization.user"`
1381
1382 - `api_key_last_used_at: optional number`
1383
1384 The Unix timestamp (in seconds) of the user's last API key usage.
1385
1386 - `created: optional number`
1387
1388 The Unix timestamp (in seconds) of when the user was created.
1389
1390 - `developer_persona: optional string`
1391
1392 The developer persona metadata for the user.
1393
1394 - `email: optional string`
929 1395
930 The email address of the user1396 The email address of the user
931 1397
9321398 - `name: string` - `is_default: optional boolean`
1399
1400 Whether this is the organization's default user.
1401
1402 - `is_scale_tier_authorized_purchaser: optional boolean`
1403
1404 Whether the user is an authorized purchaser for Scale Tier.
1405
1406 - `is_scim_managed: optional boolean`
1407
1408 Whether the user is managed through SCIM.
1409
1410 - `is_service_account: optional boolean`
1411
1412 Whether the user is a service account.
1413
1414 - `name: optional string`
933 1415
934 The name of the user1416 The name of the user
935 1417
9361418 - `object: "organization.user"` - `projects: optional object { data, object }`
937 1419
9381420 The object type, which is always `organization.user` Projects associated with the user, if included.
939 1421
9401422 - `"organization.user"` - `data: array of object { id, name, role }`
1423
1424 - `id: optional string`
1425
1426 - `name: optional string`
1427
1428 - `role: optional string`
941 1429
9421430 - `role: "owner" or "reader"` - `object: "list"`
1431
1432 - `"list"`
1433
1434 - `role: optional string`
943 1435
944 `owner` or `reader`1436 `owner` or `reader`
945 1437
9461438 - `"owner"` - `technical_level: optional string`
1439
1440 The technical level metadata for the user.
1441
1442 - `user: optional object { id, object, banned, 5 more }`
1443
1444 Nested user details.
1445
1446 - `id: string`
1447
1448 - `object: "user"`
1449
1450 - `"user"`
1451
1452 - `banned: optional boolean`
1453
1454 - `banned_at: optional number`
1455
1456 - `email: optional string`
1457
1458 - `enabled: optional boolean`
1459
1460 - `name: optional string`
947 1461
9481462 - `"reader"` - `picture: optional string`
949 1463
950### Role Delete Response1464### Role Delete Response
951 1465
30 30
31 The Unix timestamp (in seconds) of when the user was added.31 The Unix timestamp (in seconds) of when the user was added.
32 32
3333 - `email: string` - `object: "organization.user"`
34
35 The object type, which is always `organization.user`
36
37 - `"organization.user"`
38
39 - `api_key_last_used_at: optional number`
40
41 The Unix timestamp (in seconds) of the user's last API key usage.
42
43 - `created: optional number`
44
45 The Unix timestamp (in seconds) of when the user was created.
46
47 - `developer_persona: optional string`
48
49 The developer persona metadata for the user.
50
51 - `email: optional string`
34 52
35 The email address of the user53 The email address of the user
36 54
3755 - `name: string` - `is_default: optional boolean`
56
57 Whether this is the organization's default user.
58
59 - `is_scale_tier_authorized_purchaser: optional boolean`
60
61 Whether the user is an authorized purchaser for Scale Tier.
62
63 - `is_scim_managed: optional boolean`
64
65 Whether the user is managed through SCIM.
66
67 - `is_service_account: optional boolean`
68
69 Whether the user is a service account.
70
71 - `name: optional string`
38 72
39 The name of the user73 The name of the user
40 74
4175 - `object: "organization.user"` - `projects: optional object { data, object }`
42 76
4377 The object type, which is always `organization.user` Projects associated with the user, if included.
44 78
4579 - `"organization.user"` - `data: array of object { id, name, role }`
46 80
4781 - `role: "owner" or "reader"` - `id: optional string`
82
83 - `name: optional string`
84
85 - `role: optional string`
86
87 - `object: "list"`
88
89 - `"list"`
90
91 - `role: optional string`
48 92
49 `owner` or `reader`93 `owner` or `reader`
50 94
5195 - `"owner"` - `technical_level: optional string`
52 96
5397 - `"reader"` The technical level metadata for the user.
54 98
5599- `first_id: string` - `user: optional object { id, object, banned, 5 more }`
56 100
57101- `has_more: boolean` Nested user details.
58 102
59103- `last_id: string` - `id: string`
104
105 - `object: "user"`
106
107 - `"user"`
108
109 - `banned: optional boolean`
110
111 - `banned_at: optional number`
112
113 - `email: optional string`
114
115 - `enabled: optional boolean`
116
117 - `name: optional string`
118
119 - `picture: optional string`
120
121- `has_more: boolean`
60 122
61- `object: "list"`123- `object: "list"`
62 124
63 - `"list"`125 - `"list"`
64 126
127- `first_id: optional string`
128
129- `last_id: optional string`
130
65### Example131### Example
66 132
67```http133```http
77 {143 {
78 "id": "id",144 "id": "id",
79 "added_at": 0,145 "added_at": 0,
146 "object": "organization.user",
147 "api_key_last_used_at": 0,
148 "created": 0,
149 "developer_persona": "developer_persona",
80 "email": "email",150 "email": "email",
151 "is_default": true,
152 "is_scale_tier_authorized_purchaser": true,
153 "is_scim_managed": true,
154 "is_service_account": true,
81 "name": "name",155 "name": "name",
82156 "object": "organization.user", "projects": {
83157 "role": "owner" "data": [
158 {
159 "id": "id",
160 "name": "name",
161 "role": "role"
84 }162 }
85 ],163 ],
86 "first_id": "first_id",
87 "has_more": true,
88 "last_id": "last_id",
89 "object": "list"164 "object": "list"
165 },
166 "role": "role",
167 "technical_level": "technical_level",
168 "user": {
169 "id": "id",
170 "object": "user",
171 "banned": true,
172 "banned_at": 0,
173 "email": "email",
174 "enabled": true,
175 "name": "name",
176 "picture": "picture"
177 }
178 }
179 ],
180 "has_more": true,
181 "object": "list",
182 "first_id": "first_id",
183 "last_id": "last_id"
90}184}
91```185```
92 186
10 10
11### Returns11### Returns
12 12
1313- `OrganizationUser object { id, added_at, email, 3 more }`- `OrganizationUser object { id, added_at, object, 13 more }`
14 14
15 Represents an individual `user` within an organization.15 Represents an individual `user` within an organization.
16 16
22 22
23 The Unix timestamp (in seconds) of when the user was added.23 The Unix timestamp (in seconds) of when the user was added.
24 24
2525 - `email: string` - `object: "organization.user"`
26
27 The object type, which is always `organization.user`
28
29 - `"organization.user"`
30
31 - `api_key_last_used_at: optional number`
32
33 The Unix timestamp (in seconds) of the user's last API key usage.
34
35 - `created: optional number`
36
37 The Unix timestamp (in seconds) of when the user was created.
38
39 - `developer_persona: optional string`
40
41 The developer persona metadata for the user.
42
43 - `email: optional string`
26 44
27 The email address of the user45 The email address of the user
28 46
2947 - `name: string` - `is_default: optional boolean`
48
49 Whether this is the organization's default user.
50
51 - `is_scale_tier_authorized_purchaser: optional boolean`
52
53 Whether the user is an authorized purchaser for Scale Tier.
54
55 - `is_scim_managed: optional boolean`
56
57 Whether the user is managed through SCIM.
58
59 - `is_service_account: optional boolean`
60
61 Whether the user is a service account.
62
63 - `name: optional string`
30 64
31 The name of the user65 The name of the user
32 66
3367 - `object: "organization.user"` - `projects: optional object { data, object }`
34 68
3569 The object type, which is always `organization.user` Projects associated with the user, if included.
36 70
3771 - `"organization.user"` - `data: array of object { id, name, role }`
72
73 - `id: optional string`
38 74
3975 - `role: "owner" or "reader"` - `name: optional string`
76
77 - `role: optional string`
78
79 - `object: "list"`
80
81 - `"list"`
82
83 - `role: optional string`
40 84
41 `owner` or `reader`85 `owner` or `reader`
42 86
4387 - `"owner"` - `technical_level: optional string`
88
89 The technical level metadata for the user.
90
91 - `user: optional object { id, object, banned, 5 more }`
92
93 Nested user details.
94
95 - `id: string`
96
97 - `object: "user"`
98
99 - `"user"`
100
101 - `banned: optional boolean`
44 102
45103 - `"reader"` - `banned_at: optional number`
104
105 - `email: optional string`
106
107 - `enabled: optional boolean`
108
109 - `name: optional string`
110
111 - `picture: optional string`
46 112
47### Example113### Example
48 114
57{123{
58 "id": "id",124 "id": "id",
59 "added_at": 0,125 "added_at": 0,
126 "object": "organization.user",
127 "api_key_last_used_at": 0,
128 "created": 0,
129 "developer_persona": "developer_persona",
60 "email": "email",130 "email": "email",
131 "is_default": true,
132 "is_scale_tier_authorized_purchaser": true,
133 "is_scim_managed": true,
134 "is_service_account": true,
61 "name": "name",135 "name": "name",
62136 "object": "organization.user", "projects": {
63137 "role": "owner" "data": [
138 {
139 "id": "id",
140 "name": "name",
141 "role": "role"
142 }
143 ],
144 "object": "list"
145 },
146 "role": "role",
147 "technical_level": "technical_level",
148 "user": {
149 "id": "id",
150 "object": "user",
151 "banned": true,
152 "banned_at": 0,
153 "email": "email",
154 "enabled": true,
155 "name": "name",
156 "picture": "picture"
157 }
64}158}
65```159```
66 160
10 10
11### Body Parameters11### Body Parameters
12 12
1313- `role: "owner" or "reader"`- `developer_persona: optional string`
14
15 Developer persona metadata.
16
17- `role: optional string`
14 18
15 `owner` or `reader`19 `owner` or `reader`
16 20
1721 - `"owner"`- `role_id: optional string`
22
23 Role ID to assign to the user.
24
25- `technical_level: optional string`
18 26
1927 - `"reader"` Technical level metadata.
20 28
21### Returns29### Returns
22 30
2331- `OrganizationUser object { id, added_at, email, 3 more }`- `OrganizationUser object { id, added_at, object, 13 more }`
24 32
25 Represents an individual `user` within an organization.33 Represents an individual `user` within an organization.
26 34
32 40
33 The Unix timestamp (in seconds) of when the user was added.41 The Unix timestamp (in seconds) of when the user was added.
34 42
3543 - `email: string` - `object: "organization.user"`
44
45 The object type, which is always `organization.user`
46
47 - `"organization.user"`
48
49 - `api_key_last_used_at: optional number`
50
51 The Unix timestamp (in seconds) of the user's last API key usage.
52
53 - `created: optional number`
54
55 The Unix timestamp (in seconds) of when the user was created.
56
57 - `developer_persona: optional string`
58
59 The developer persona metadata for the user.
60
61 - `email: optional string`
36 62
37 The email address of the user63 The email address of the user
38 64
3965 - `name: string` - `is_default: optional boolean`
66
67 Whether this is the organization's default user.
68
69 - `is_scale_tier_authorized_purchaser: optional boolean`
70
71 Whether the user is an authorized purchaser for Scale Tier.
72
73 - `is_scim_managed: optional boolean`
74
75 Whether the user is managed through SCIM.
76
77 - `is_service_account: optional boolean`
78
79 Whether the user is a service account.
80
81 - `name: optional string`
40 82
41 The name of the user83 The name of the user
42 84
4385 - `object: "organization.user"` - `projects: optional object { data, object }`
44 86
4587 The object type, which is always `organization.user` Projects associated with the user, if included.
46 88
4789 - `"organization.user"` - `data: array of object { id, name, role }`
90
91 - `id: optional string`
48 92
4993 - `role: "owner" or "reader"` - `name: optional string`
94
95 - `role: optional string`
96
97 - `object: "list"`
98
99 - `"list"`
100
101 - `role: optional string`
50 102
51 `owner` or `reader`103 `owner` or `reader`
52 104
53105 - `"owner"` - `technical_level: optional string`
106
107 The technical level metadata for the user.
108
109 - `user: optional object { id, object, banned, 5 more }`
110
111 Nested user details.
112
113 - `id: string`
114
115 - `object: "user"`
116
117 - `"user"`
118
119 - `banned: optional boolean`
120
121 - `banned_at: optional number`
122
123 - `email: optional string`
54 124
55125 - `"reader"` - `enabled: optional boolean`
126
127 - `name: optional string`
128
129 - `picture: optional string`
56 130
57### Example131### Example
58 132
60curl https://api.openai.com/v1/organization/users/$USER_ID \134curl https://api.openai.com/v1/organization/users/$USER_ID \
61 -H 'Content-Type: application/json' \135 -H 'Content-Type: application/json' \
62 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \136 -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
63137 -d '{ -d '{}'
64 "role": "owner"
65 }'
66```138```
67 139
68#### Response140#### Response
71{143{
72 "id": "id",144 "id": "id",
73 "added_at": 0,145 "added_at": 0,
146 "object": "organization.user",
147 "api_key_last_used_at": 0,
148 "created": 0,
149 "developer_persona": "developer_persona",
74 "email": "email",150 "email": "email",
151 "is_default": true,
152 "is_scale_tier_authorized_purchaser": true,
153 "is_scim_managed": true,
154 "is_service_account": true,
75 "name": "name",155 "name": "name",
76156 "object": "organization.user", "projects": {
77157 "role": "owner" "data": [
158 {
159 "id": "id",
160 "name": "name",
161 "role": "role"
162 }
163 ],
164 "object": "list"
165 },
166 "role": "role",
167 "technical_level": "technical_level",
168 "user": {
169 "id": "id",
170 "object": "user",
171 "banned": true,
172 "banned_at": 0,
173 "email": "email",
174 "enabled": true,
175 "name": "name",
176 "picture": "picture"
177 }
78}178}
79```179```
80 180
68 68
69 The Unix timestamp (in seconds) of when the user was added.69 The Unix timestamp (in seconds) of when the user was added.
70 70
7171 - `email: string` - `object: "organization.user"`
72
73 The object type, which is always `organization.user`
74
75 - `"organization.user"`
76
77 - `api_key_last_used_at: optional number`
78
79 The Unix timestamp (in seconds) of the user's last API key usage.
80
81 - `created: optional number`
82
83 The Unix timestamp (in seconds) of when the user was created.
84
85 - `developer_persona: optional string`
86
87 The developer persona metadata for the user.
88
89 - `email: optional string`
72 90
73 The email address of the user91 The email address of the user
74 92
7593 - `name: string` - `is_default: optional boolean`
94
95 Whether this is the organization's default user.
96
97 - `is_scale_tier_authorized_purchaser: optional boolean`
98
99 Whether the user is an authorized purchaser for Scale Tier.
100
101 - `is_scim_managed: optional boolean`
102
103 Whether the user is managed through SCIM.
104
105 - `is_service_account: optional boolean`
106
107 Whether the user is a service account.
108
109 - `name: optional string`
76 110
77 The name of the user111 The name of the user
78 112
79113 - `object: "organization.user"` - `projects: optional object { data, object }`
80 114
81115 The object type, which is always `organization.user` Projects associated with the user, if included.
82 116
83117 - `"organization.user"` - `data: array of object { id, name, role }`
118
119 - `id: optional string`
120
121 - `name: optional string`
122
123 - `role: optional string`
84 124
85125 - `role: "owner" or "reader"` - `object: "list"`
126
127 - `"list"`
128
129 - `role: optional string`
86 130
87 `owner` or `reader`131 `owner` or `reader`
88 132
89133 - `"owner"` - `technical_level: optional string`
134
135 The technical level metadata for the user.
136
137 - `user: optional object { id, object, banned, 5 more }`
138
139 Nested user details.
140
141 - `id: string`
142
143 - `object: "user"`
144
145 - `"user"`
146
147 - `banned: optional boolean`
148
149 - `banned_at: optional number`
150
151 - `email: optional string`
152
153 - `enabled: optional boolean`
90 154
91155 - `"reader"` - `name: optional string`
156
157 - `picture: optional string`
92 158
93### Example159### Example
94 160
120 "user": {186 "user": {
121 "id": "id",187 "id": "id",
122 "added_at": 0,188 "added_at": 0,
189 "object": "organization.user",
190 "api_key_last_used_at": 0,
191 "created": 0,
192 "developer_persona": "developer_persona",
123 "email": "email",193 "email": "email",
194 "is_default": true,
195 "is_scale_tier_authorized_purchaser": true,
196 "is_scim_managed": true,
197 "is_service_account": true,
124 "name": "name",198 "name": "name",
125199 "object": "organization.user", "projects": {
126200 "role": "owner" "data": [
201 {
202 "id": "id",
203 "name": "name",
204 "role": "role"
205 }
206 ],
207 "object": "list"
208 },
209 "role": "role",
210 "technical_level": "technical_level",
211 "user": {
212 "id": "id",
213 "object": "user",
214 "banned": true,
215 "banned_at": 0,
216 "email": "email",
217 "enabled": true,
218 "name": "name",
219 "picture": "picture"
220 }
127 }221 }
128}222}
129```223```
1023 "id": "id",1023 "id": "id",
1024 "mime_type": "mime_type",1024 "mime_type": "mime_type",
1025 "name": "name",1025 "name": "name",
10261026 "preview_url": "preview_url", "preview_url": "https://example.com",
1027 "type": "image"1027 "type": "image"
1028 }1028 }
1029 ],1029 ],
452 "id": "id",452 "id": "id",
453 "mime_type": "mime_type",453 "mime_type": "mime_type",
454 "name": "name",454 "name": "name",
455455 "preview_url": "preview_url", "preview_url": "https://example.com",
456 "type": "image"456 "type": "image"
457 }457 }
458 ],458 ],
450 "id": "id",450 "id": "id",
451 "mime_type": "mime_type",451 "mime_type": "mime_type",
452 "name": "name",452 "name": "name",
453453 "preview_url": "preview_url", "preview_url": "https://example.com",
454 "type": "image"454 "type": "image"
455 }455 }
456 ],456 ],