resources/admin/subresources/organization/index.md +1837 −2506 renamed
Previously: resources/organization/index.md
Previously: resources/organization/index.md
Previously: resources/organization/subresources/admin_api_keys/index.md
26 26
27### Returns27### Returns
28 28
2929- `data: optional array of object { id, created_at, last_used_at, 5 more }`- `data: optional array of AdminAPIKey`
30 30
31 - `id: string`31 - `id: string`
32 32
94 94
95```http95```http
96curl https://api.openai.com/v1/organization/admin_api_keys \96curl https://api.openai.com/v1/organization/admin_api_keys \
9797 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
98```98```
99 99
100#### Response100#### Response
176 176
177### Returns177### Returns
178 178
179179- `id: string`- `AdminAPIKey object { id, created_at, last_used_at, 5 more }`
180
181 Represents an individual Admin API key in an org.
182
183 - `id: string`
180 184
181 The identifier, which can be referenced in API endpoints185 The identifier, which can be referenced in API endpoints
182 186
183187- `created_at: number` - `created_at: number`
184 188
185 The Unix timestamp (in seconds) of when the API key was created189 The Unix timestamp (in seconds) of when the API key was created
186 190
187191- `last_used_at: number` - `last_used_at: number`
188 192
189 The Unix timestamp (in seconds) of when the API key was last used193 The Unix timestamp (in seconds) of when the API key was last used
190 194
191195- `name: string` - `name: string`
192 196
193 The name of the API key197 The name of the API key
194 198
195199- `object: string` - `object: string`
196 200
197 The object type, which is always `organization.admin_api_key`201 The object type, which is always `organization.admin_api_key`
198 202
199203- `owner: object { id, created_at, name, 3 more }` - `owner: object { id, created_at, name, 3 more }`
200 204
201 - `id: optional string`205 - `id: optional string`
202 206
222 226
223 Always `user`227 Always `user`
224 228
225229- `redacted_value: string` - `redacted_value: string`
226 230
227 The redacted value of the API key231 The redacted value of the API key
228 232
229233- `value: optional string` - `value: optional string`
230 234
231 The value of the API key. Only shown on create.235 The value of the API key. Only shown on create.
232 236
235```http239```http
236curl https://api.openai.com/v1/organization/admin_api_keys \240curl https://api.openai.com/v1/organization/admin_api_keys \
237 -H 'Content-Type: application/json' \241 -H 'Content-Type: application/json' \
238242 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
239 -d '{243 -d '{
240 "name": "New Admin Key"244 "name": "New Admin Key"
241 }'245 }'
310 314
311### Returns315### Returns
312 316
313317- `id: string`- `AdminAPIKey object { id, created_at, last_used_at, 5 more }`
318
319 Represents an individual Admin API key in an org.
320
321 - `id: string`
314 322
315 The identifier, which can be referenced in API endpoints323 The identifier, which can be referenced in API endpoints
316 324
317325- `created_at: number` - `created_at: number`
318 326
319 The Unix timestamp (in seconds) of when the API key was created327 The Unix timestamp (in seconds) of when the API key was created
320 328
321329- `last_used_at: number` - `last_used_at: number`
322 330
323 The Unix timestamp (in seconds) of when the API key was last used331 The Unix timestamp (in seconds) of when the API key was last used
324 332
325333- `name: string` - `name: string`
326 334
327 The name of the API key335 The name of the API key
328 336
329337- `object: string` - `object: string`
330 338
331 The object type, which is always `organization.admin_api_key`339 The object type, which is always `organization.admin_api_key`
332 340
333341- `owner: object { id, created_at, name, 3 more }` - `owner: object { id, created_at, name, 3 more }`
334 342
335 - `id: optional string`343 - `id: optional string`
336 344
356 364
357 Always `user`365 Always `user`
358 366
359367- `redacted_value: string` - `redacted_value: string`
360 368
361 The redacted value of the API key369 The redacted value of the API key
362 370
363371- `value: optional string` - `value: optional string`
364 372
365 The value of the API key. Only shown on create.373 The value of the API key. Only shown on create.
366 374
368 376
369```http377```http
370curl https://api.openai.com/v1/organization/admin_api_keys/$KEY_ID \378curl https://api.openai.com/v1/organization/admin_api_keys/$KEY_ID \
371379 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
372```380```
373 381
374#### Response382#### Response
447```http455```http
448curl https://api.openai.com/v1/organization/admin_api_keys/$KEY_ID \456curl https://api.openai.com/v1/organization/admin_api_keys/$KEY_ID \
449 -X DELETE \457 -X DELETE \
450458 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
451```459```
452 460
453#### Response461#### Response
480 488
481## Domain Types489## Domain Types
482 490
483491### Admin API Key List Response### Admin API Key
484
485- `AdminAPIKeyListResponse object { id, created_at, last_used_at, 5 more }`
486
487 Represents an individual Admin API key in an org.
488
489 - `id: string`
490
491 The identifier, which can be referenced in API endpoints
492
493 - `created_at: number`
494
495 The Unix timestamp (in seconds) of when the API key was created
496
497 - `last_used_at: number`
498
499 The Unix timestamp (in seconds) of when the API key was last used
500
501 - `name: string`
502
503 The name of the API key
504
505 - `object: string`
506
507 The object type, which is always `organization.admin_api_key`
508
509 - `owner: object { id, created_at, name, 3 more }`
510
511 - `id: optional string`
512
513 The identifier, which can be referenced in API endpoints
514
515 - `created_at: optional number`
516
517 The Unix timestamp (in seconds) of when the user was created
518
519 - `name: optional string`
520
521 The name of the user
522
523 - `object: optional string`
524
525 The object type, which is always organization.user
526
527 - `role: optional string`
528
529 Always `owner`
530
531 - `type: optional string`
532
533 Always `user`
534
535 - `redacted_value: string`
536
537 The redacted value of the API key
538
539 - `value: optional string`
540
541 The value of the API key. Only shown on create.
542
543### Admin API Key Create Response
544
545- `AdminAPIKeyCreateResponse object { id, created_at, last_used_at, 5 more }`
546
547 Represents an individual Admin API key in an org.
548
549 - `id: string`
550
551 The identifier, which can be referenced in API endpoints
552
553 - `created_at: number`
554
555 The Unix timestamp (in seconds) of when the API key was created
556
557 - `last_used_at: number`
558
559 The Unix timestamp (in seconds) of when the API key was last used
560
561 - `name: string`
562
563 The name of the API key
564
565 - `object: string`
566
567 The object type, which is always `organization.admin_api_key`
568
569 - `owner: object { id, created_at, name, 3 more }`
570
571 - `id: optional string`
572
573 The identifier, which can be referenced in API endpoints
574
575 - `created_at: optional number`
576
577 The Unix timestamp (in seconds) of when the user was created
578
579 - `name: optional string`
580
581 The name of the user
582
583 - `object: optional string`
584
585 The object type, which is always organization.user
586
587 - `role: optional string`
588
589 Always `owner`
590
591 - `type: optional string`
592
593 Always `user`
594
595 - `redacted_value: string`
596
597 The redacted value of the API key
598
599 - `value: optional string`
600
601 The value of the API key. Only shown on create.
602
603### Admin API Key Retrieve Response
604 492
605493- `AdminAPIKeyRetrieveResponse object { id, created_at, last_used_at, 5 more }`- `AdminAPIKey object { id, created_at, last_used_at, 5 more }`
606 494
607 Represents an individual Admin API key in an org.495 Represents an individual Admin API key in an org.
608 496
Previously: resources/organization/subresources/admin_api_keys/methods/create/index.md
10 10
11### Returns11### Returns
12 12
1313- `id: string`- `AdminAPIKey object { id, created_at, last_used_at, 5 more }`
14
15 Represents an individual Admin API key in an org.
16
17 - `id: string`
14 18
15 The identifier, which can be referenced in API endpoints19 The identifier, which can be referenced in API endpoints
16 20
1721- `created_at: number` - `created_at: number`
18 22
19 The Unix timestamp (in seconds) of when the API key was created23 The Unix timestamp (in seconds) of when the API key was created
20 24
2125- `last_used_at: number` - `last_used_at: number`
22 26
23 The Unix timestamp (in seconds) of when the API key was last used27 The Unix timestamp (in seconds) of when the API key was last used
24 28
2529- `name: string` - `name: string`
26 30
27 The name of the API key31 The name of the API key
28 32
2933- `object: string` - `object: string`
30 34
31 The object type, which is always `organization.admin_api_key`35 The object type, which is always `organization.admin_api_key`
32 36
3337- `owner: object { id, created_at, name, 3 more }` - `owner: object { id, created_at, name, 3 more }`
34 38
35 - `id: optional string`39 - `id: optional string`
36 40
56 60
57 Always `user`61 Always `user`
58 62
5963- `redacted_value: string` - `redacted_value: string`
60 64
61 The redacted value of the API key65 The redacted value of the API key
62 66
6367- `value: optional string` - `value: optional string`
64 68
65 The value of the API key. Only shown on create.69 The value of the API key. Only shown on create.
66 70
69```http73```http
70curl https://api.openai.com/v1/organization/admin_api_keys \74curl https://api.openai.com/v1/organization/admin_api_keys \
71 -H 'Content-Type: application/json' \75 -H 'Content-Type: application/json' \
7276 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
73 -d '{77 -d '{
74 "name": "New Admin Key"78 "name": "New Admin Key"
75 }'79 }'
Previously: resources/organization/subresources/admin_api_keys/methods/delete/index.md
23```http23```http
24curl https://api.openai.com/v1/organization/admin_api_keys/$KEY_ID \24curl https://api.openai.com/v1/organization/admin_api_keys/$KEY_ID \
25 -X DELETE \25 -X DELETE \
2626 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
27```27```
28 28
29#### Response29#### Response
Previously: resources/organization/subresources/admin_api_keys/methods/list/index.md
24 24
25### Returns25### Returns
26 26
2727- `data: optional array of object { id, created_at, last_used_at, 5 more }`- `data: optional array of AdminAPIKey`
28 28
29 - `id: string`29 - `id: string`
30 30
92 92
93```http93```http
94curl https://api.openai.com/v1/organization/admin_api_keys \94curl https://api.openai.com/v1/organization/admin_api_keys \
9595 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
96```96```
97 97
98#### Response98#### Response
Previously: resources/organization/subresources/admin_api_keys/methods/retrieve/index.md
12 12
13### Returns13### Returns
14 14
1515- `id: string`- `AdminAPIKey object { id, created_at, last_used_at, 5 more }`
16
17 Represents an individual Admin API key in an org.
18
19 - `id: string`
16 20
17 The identifier, which can be referenced in API endpoints21 The identifier, which can be referenced in API endpoints
18 22
1923- `created_at: number` - `created_at: number`
20 24
21 The Unix timestamp (in seconds) of when the API key was created25 The Unix timestamp (in seconds) of when the API key was created
22 26
2327- `last_used_at: number` - `last_used_at: number`
24 28
25 The Unix timestamp (in seconds) of when the API key was last used29 The Unix timestamp (in seconds) of when the API key was last used
26 30
2731- `name: string` - `name: string`
28 32
29 The name of the API key33 The name of the API key
30 34
3135- `object: string` - `object: string`
32 36
33 The object type, which is always `organization.admin_api_key`37 The object type, which is always `organization.admin_api_key`
34 38
3539- `owner: object { id, created_at, name, 3 more }` - `owner: object { id, created_at, name, 3 more }`
36 40
37 - `id: optional string`41 - `id: optional string`
38 42
58 62
59 Always `user`63 Always `user`
60 64
6165- `redacted_value: string` - `redacted_value: string`
62 66
63 The redacted value of the API key67 The redacted value of the API key
64 68
6569- `value: optional string` - `value: optional string`
66 70
67 The value of the API key. Only shown on create.71 The value of the API key. Only shown on create.
68 72
70 74
71```http75```http
72curl https://api.openai.com/v1/organization/admin_api_keys/$KEY_ID \76curl https://api.openai.com/v1/organization/admin_api_keys/$KEY_ID \
7377 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
74```78```
75 79
76#### Response80#### Response
Previously: resources/organization/subresources/audit_logs/index.md
1066 1066
1067```http1067```http
1068curl https://api.openai.com/v1/organization/audit_logs \1068curl https://api.openai.com/v1/organization/audit_logs \
10691069 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
1070```1070```
1071 1071
1072#### Response1072#### Response
1446}1446}
1447```1447```
1448 1448
1449## Costs
1450
1451**get** `/organization/costs`
1452
1453Get costs details for the organization.
1454
1455### Query Parameters
1456
1457- `start_time: number`
1458
1459 Start time (Unix seconds) of the query time range, inclusive.
1460
1461- `bucket_width: optional "1d"`
1462
1463 Width of each time bucket in response. Currently only `1d` is supported, default to `1d`.
1464
1465 - `"1d"`
1466
1467- `end_time: optional number`
1468
1469 End time (Unix seconds) of the query time range, exclusive.
1470
1471- `group_by: optional array of "project_id" or "line_item"`
1472
1473 Group the costs by the specified fields. Support fields include `project_id`, `line_item` and any combination of them.
1474
1475 - `"project_id"`
1476
1477 - `"line_item"`
1478
1479- `limit: optional number`
1480
1481 A limit on the number of buckets to be returned. Limit can range between 1 and 180, and the default is 7.
1482
1483- `page: optional string`
1484
1485 A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.
1486
1487- `project_ids: optional array of string`
1488
1489 Return only costs for these projects.
1490
1491### Returns
1492
1493- `data: array of object { end_time, object, result, start_time }`
1494
1495 - `end_time: number`
1496
1497 - `object: "bucket"`
1498
1499 - `"bucket"`
1500
1501 - `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`
1502
1503 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
1504
1505 The aggregated completions usage details of the specific time bucket.
1506
1507 - `input_tokens: number`
1508
1509 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.
1510
1511 - `num_model_requests: number`
1512
1513 The count of requests made to the model.
1514
1515 - `object: "organization.usage.completions.result"`
1516
1517 - `"organization.usage.completions.result"`
1518
1519 - `output_tokens: number`
1520
1521 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.
1522
1523 - `api_key_id: optional string`
1524
1525 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
1526
1527 - `batch: optional boolean`
1528
1529 When `group_by=batch`, this field tells whether the grouped usage result is batch or not.
1530
1531 - `input_audio_tokens: optional number`
1532
1533 The aggregated number of audio input tokens used, including cached tokens.
1534
1535 - `input_cached_tokens: optional number`
1536
1537 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.
1538
1539 - `model: optional string`
1540
1541 When `group_by=model`, this field provides the model name of the grouped usage result.
1542
1543 - `output_audio_tokens: optional number`
1544
1545 The aggregated number of audio output tokens used.
1546
1547 - `project_id: optional string`
1548
1549 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
1550
1551 - `service_tier: optional string`
1552
1553 When `group_by=service_tier`, this field provides the service tier of the grouped usage result.
1554
1555 - `user_id: optional string`
1556
1557 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1558
1559 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
1560
1561 The aggregated embeddings usage details of the specific time bucket.
1562
1563 - `input_tokens: number`
1564
1565 The aggregated number of input tokens used.
1566
1567 - `num_model_requests: number`
1568
1569 The count of requests made to the model.
1570
1571 - `object: "organization.usage.embeddings.result"`
1572
1573 - `"organization.usage.embeddings.result"`
1574
1575 - `api_key_id: optional string`
1576
1577 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
1578
1579 - `model: optional string`
1580
1581 When `group_by=model`, this field provides the model name of the grouped usage result.
1582
1583 - `project_id: optional string`
1584
1585 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
1586
1587 - `user_id: optional string`
1588
1589 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1590
1591 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
1592
1593 The aggregated moderations usage details of the specific time bucket.
1594
1595 - `input_tokens: number`
1596
1597 The aggregated number of input tokens used.
1598
1599 - `num_model_requests: number`
1600
1601 The count of requests made to the model.
1602
1603 - `object: "organization.usage.moderations.result"`
1604
1605 - `"organization.usage.moderations.result"`
1606
1607 - `api_key_id: optional string`
1608
1609 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
1610
1611 - `model: optional string`
1612
1613 When `group_by=model`, this field provides the model name of the grouped usage result.
1614
1615 - `project_id: optional string`
1616
1617 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
1618
1619 - `user_id: optional string`
1620
1621 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1622
1623 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`
1624
1625 The aggregated images usage details of the specific time bucket.
1626
1627 - `images: number`
1628
1629 The number of images processed.
1630
1631 - `num_model_requests: number`
1632
1633 The count of requests made to the model.
1634
1635 - `object: "organization.usage.images.result"`
1636
1637 - `"organization.usage.images.result"`
1638
1639 - `api_key_id: optional string`
1640
1641 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
1642
1643 - `model: optional string`
1644
1645 When `group_by=model`, this field provides the model name of the grouped usage result.
1646
1647 - `project_id: optional string`
1648
1649 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
1650
1651 - `size: optional string`
1652
1653 When `group_by=size`, this field provides the image size of the grouped usage result.
1654
1655 - `source: optional string`
1656
1657 When `group_by=source`, this field provides the source of the grouped usage result, possible values are `image.generation`, `image.edit`, `image.variation`.
1658
1659 - `user_id: optional string`
1660
1661 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1662
1663 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
1664
1665 The aggregated audio speeches usage details of the specific time bucket.
1666
1667 - `characters: number`
1668
1669 The number of characters processed.
1670
1671 - `num_model_requests: number`
1672
1673 The count of requests made to the model.
1674
1675 - `object: "organization.usage.audio_speeches.result"`
1676
1677 - `"organization.usage.audio_speeches.result"`
1678
1679 - `api_key_id: optional string`
1680
1681 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
1682
1683 - `model: optional string`
1684
1685 When `group_by=model`, this field provides the model name of the grouped usage result.
1686
1687 - `project_id: optional string`
1688
1689 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
1690
1691 - `user_id: optional string`
1692
1693 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1694
1695 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
1696
1697 The aggregated audio transcriptions usage details of the specific time bucket.
1698
1699 - `num_model_requests: number`
1700
1701 The count of requests made to the model.
1702
1703 - `object: "organization.usage.audio_transcriptions.result"`
1704
1705 - `"organization.usage.audio_transcriptions.result"`
1706
1707 - `seconds: number`
1708
1709 The number of seconds processed.
1710
1711 - `api_key_id: optional string`
1712
1713 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
1714
1715 - `model: optional string`
1716
1717 When `group_by=model`, this field provides the model name of the grouped usage result.
1718
1719 - `project_id: optional string`
1720
1721 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
1722
1723 - `user_id: optional string`
1724
1725 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
1726
1727 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`
1728
1729 The aggregated vector stores usage details of the specific time bucket.
1730
1731 - `object: "organization.usage.vector_stores.result"`
1732
1733 - `"organization.usage.vector_stores.result"`
1734
1735 - `usage_bytes: number`
1736
1737 The vector stores usage in bytes.
1738
1739 - `project_id: optional string`
1740
1741 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
1742
1743 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`
1744
1745 The aggregated code interpreter sessions usage details of the specific time bucket.
1746
1747 - `object: "organization.usage.code_interpreter_sessions.result"`
1748
1749 - `"organization.usage.code_interpreter_sessions.result"`
1750
1751 - `num_sessions: optional number`
1752
1753 The number of code interpreter sessions.
1754
1755 - `project_id: optional string`
1756
1757 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
1758
1759 - `CostsResult object { object, amount, line_item, project_id }`
1760
1761 The aggregated costs details of the specific time bucket.
1762
1763 - `object: "organization.costs.result"`
1764
1765 - `"organization.costs.result"`
1766
1767 - `amount: optional object { currency, value }`
1768
1769 The monetary value in its associated currency.
1770
1771 - `currency: optional string`
1772
1773 Lowercase ISO-4217 currency e.g. "usd"
1774
1775 - `value: optional number`
1776
1777 The numeric value of the cost.
1778
1779 - `line_item: optional string`
1780
1781 When `group_by=line_item`, this field provides the line item of the grouped costs result.
1782
1783 - `project_id: optional string`
1784
1785 When `group_by=project_id`, this field provides the project ID of the grouped costs result.
1786
1787 - `start_time: number`
1788
1789- `has_more: boolean`
1790
1791- `next_page: string`
1792
1793- `object: "page"`
1794
1795 - `"page"`
1796
1797### Example
1798
1799```http
1800curl https://api.openai.com/v1/organization/costs \
1801 -H "Authorization: Bearer $OPENAI_API_KEY"
1802```
1803
1804#### Response
1805
1806```json
1807{
1808 "data": [
1809 {
1810 "end_time": 0,
1811 "object": "bucket",
1812 "result": [
1813 {
1814 "input_tokens": 0,
1815 "num_model_requests": 0,
1816 "object": "organization.usage.completions.result",
1817 "output_tokens": 0,
1818 "api_key_id": "api_key_id",
1819 "batch": true,
1820 "input_audio_tokens": 0,
1821 "input_cached_tokens": 0,
1822 "model": "model",
1823 "output_audio_tokens": 0,
1824 "project_id": "project_id",
1825 "service_tier": "service_tier",
1826 "user_id": "user_id"
1827 }
1828 ],
1829 "start_time": 0
1830 }
1831 ],
1832 "has_more": true,
1833 "next_page": "next_page",
1834 "object": "page"
1835}
1836```
1837
1838### Example
1839
1840```http
1841curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1" \
1842-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
1843-H "Content-Type: application/json"
1844```
1845
1846#### Response
1847
1848```json
1849{
1850 "object": "page",
1851 "data": [
1852 {
1853 "object": "bucket",
1854 "start_time": 1730419200,
1855 "end_time": 1730505600,
1856 "results": [
1857 {
1858 "object": "organization.costs.result",
1859 "amount": {
1860 "value": 0.06,
1861 "currency": "usd"
1862 },
1863 "line_item": null,
1864 "project_id": null
1865 }
1866 ]
1867 }
1868 ],
1869 "has_more": false,
1870 "next_page": null
1871}
1872```
1873
1874## Domain Types1449## Domain Types
1875 1450
1876### Audit Log List Response1451### Audit Log List Response
2764 - `role: optional string`2339 - `role: optional string`
2765 2340
2766 The role of the user. Is either `owner` or `member`.2341 The role of the user. Is either `owner` or `member`.
2767
2768### Audit Log Get Costs Response
2769
2770- `AuditLogGetCostsResponse object { data, has_more, next_page, object }`
2771
2772 - `data: array of object { end_time, object, result, start_time }`
2773
2774 - `end_time: number`
2775
2776 - `object: "bucket"`
2777
2778 - `"bucket"`
2779
2780 - `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`
2781
2782 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
2783
2784 The aggregated completions usage details of the specific time bucket.
2785
2786 - `input_tokens: number`
2787
2788 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.
2789
2790 - `num_model_requests: number`
2791
2792 The count of requests made to the model.
2793
2794 - `object: "organization.usage.completions.result"`
2795
2796 - `"organization.usage.completions.result"`
2797
2798 - `output_tokens: number`
2799
2800 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.
2801
2802 - `api_key_id: optional string`
2803
2804 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
2805
2806 - `batch: optional boolean`
2807
2808 When `group_by=batch`, this field tells whether the grouped usage result is batch or not.
2809
2810 - `input_audio_tokens: optional number`
2811
2812 The aggregated number of audio input tokens used, including cached tokens.
2813
2814 - `input_cached_tokens: optional number`
2815
2816 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.
2817
2818 - `model: optional string`
2819
2820 When `group_by=model`, this field provides the model name of the grouped usage result.
2821
2822 - `output_audio_tokens: optional number`
2823
2824 The aggregated number of audio output tokens used.
2825
2826 - `project_id: optional string`
2827
2828 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
2829
2830 - `service_tier: optional string`
2831
2832 When `group_by=service_tier`, this field provides the service tier of the grouped usage result.
2833
2834 - `user_id: optional string`
2835
2836 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2837
2838 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
2839
2840 The aggregated embeddings usage details of the specific time bucket.
2841
2842 - `input_tokens: number`
2843
2844 The aggregated number of input tokens used.
2845
2846 - `num_model_requests: number`
2847
2848 The count of requests made to the model.
2849
2850 - `object: "organization.usage.embeddings.result"`
2851
2852 - `"organization.usage.embeddings.result"`
2853
2854 - `api_key_id: optional string`
2855
2856 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
2857
2858 - `model: optional string`
2859
2860 When `group_by=model`, this field provides the model name of the grouped usage result.
2861
2862 - `project_id: optional string`
2863
2864 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
2865
2866 - `user_id: optional string`
2867
2868 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2869
2870 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
2871
2872 The aggregated moderations usage details of the specific time bucket.
2873
2874 - `input_tokens: number`
2875
2876 The aggregated number of input tokens used.
2877
2878 - `num_model_requests: number`
2879
2880 The count of requests made to the model.
2881
2882 - `object: "organization.usage.moderations.result"`
2883
2884 - `"organization.usage.moderations.result"`
2885
2886 - `api_key_id: optional string`
2887
2888 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
2889
2890 - `model: optional string`
2891
2892 When `group_by=model`, this field provides the model name of the grouped usage result.
2893
2894 - `project_id: optional string`
2895
2896 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
2897
2898 - `user_id: optional string`
2899
2900 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2901
2902 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`
2903
2904 The aggregated images usage details of the specific time bucket.
2905
2906 - `images: number`
2907
2908 The number of images processed.
2909
2910 - `num_model_requests: number`
2911
2912 The count of requests made to the model.
2913
2914 - `object: "organization.usage.images.result"`
2915
2916 - `"organization.usage.images.result"`
2917
2918 - `api_key_id: optional string`
2919
2920 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
2921
2922 - `model: optional string`
2923
2924 When `group_by=model`, this field provides the model name of the grouped usage result.
2925
2926 - `project_id: optional string`
2927
2928 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
2929
2930 - `size: optional string`
2931
2932 When `group_by=size`, this field provides the image size of the grouped usage result.
2933
2934 - `source: optional string`
2935
2936 When `group_by=source`, this field provides the source of the grouped usage result, possible values are `image.generation`, `image.edit`, `image.variation`.
2937
2938 - `user_id: optional string`
2939
2940 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2941
2942 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
2943
2944 The aggregated audio speeches usage details of the specific time bucket.
2945
2946 - `characters: number`
2947
2948 The number of characters processed.
2949
2950 - `num_model_requests: number`
2951
2952 The count of requests made to the model.
2953
2954 - `object: "organization.usage.audio_speeches.result"`
2955
2956 - `"organization.usage.audio_speeches.result"`
2957
2958 - `api_key_id: optional string`
2959
2960 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
2961
2962 - `model: optional string`
2963
2964 When `group_by=model`, this field provides the model name of the grouped usage result.
2965
2966 - `project_id: optional string`
2967
2968 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
2969
2970 - `user_id: optional string`
2971
2972 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
2973
2974 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
2975
2976 The aggregated audio transcriptions usage details of the specific time bucket.
2977
2978 - `num_model_requests: number`
2979
2980 The count of requests made to the model.
2981
2982 - `object: "organization.usage.audio_transcriptions.result"`
2983
2984 - `"organization.usage.audio_transcriptions.result"`
2985
2986 - `seconds: number`
2987
2988 The number of seconds processed.
2989
2990 - `api_key_id: optional string`
2991
2992 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
2993
2994 - `model: optional string`
2995
2996 When `group_by=model`, this field provides the model name of the grouped usage result.
2997
2998 - `project_id: optional string`
2999
3000 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
3001
3002 - `user_id: optional string`
3003
3004 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
3005
3006 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`
3007
3008 The aggregated vector stores usage details of the specific time bucket.
3009
3010 - `object: "organization.usage.vector_stores.result"`
3011
3012 - `"organization.usage.vector_stores.result"`
3013
3014 - `usage_bytes: number`
3015
3016 The vector stores usage in bytes.
3017
3018 - `project_id: optional string`
3019
3020 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
3021
3022 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`
3023
3024 The aggregated code interpreter sessions usage details of the specific time bucket.
3025
3026 - `object: "organization.usage.code_interpreter_sessions.result"`
3027
3028 - `"organization.usage.code_interpreter_sessions.result"`
3029
3030 - `num_sessions: optional number`
3031
3032 The number of code interpreter sessions.
3033
3034 - `project_id: optional string`
3035
3036 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
3037
3038 - `CostsResult object { object, amount, line_item, project_id }`
3039
3040 The aggregated costs details of the specific time bucket.
3041
3042 - `object: "organization.costs.result"`
3043
3044 - `"organization.costs.result"`
3045
3046 - `amount: optional object { currency, value }`
3047
3048 The monetary value in its associated currency.
3049
3050 - `currency: optional string`
3051
3052 Lowercase ISO-4217 currency e.g. "usd"
3053
3054 - `value: optional number`
3055
3056 The numeric value of the cost.
3057
3058 - `line_item: optional string`
3059
3060 When `group_by=line_item`, this field provides the line item of the grouped costs result.
3061
3062 - `project_id: optional string`
3063
3064 When `group_by=project_id`, this field provides the project ID of the grouped costs result.
3065
3066 - `start_time: number`
3067
3068 - `has_more: boolean`
3069
3070 - `next_page: string`
3071
3072 - `object: "page"`
3073
3074 - `"page"`
Previously: resources/organization/subresources/audit_logs/methods/list/index.md
1064 1064
1065```http1065```http
1066curl https://api.openai.com/v1/organization/audit_logs \1066curl https://api.openai.com/v1/organization/audit_logs \
10671067 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
1068```1068```
1069 1069
1070#### Response1070#### Response
Previously: resources/organization/subresources/groups/index.md
26 26
27### Returns27### Returns
28 28
2929- `data: array of object { id, created_at, is_scim_managed, name }`- `data: array of Group`
30 30
31 Groups returned in the current page.31 Groups returned in the current page.
32 32
64 64
65```http65```http
66curl https://api.openai.com/v1/organization/groups \66curl https://api.openai.com/v1/organization/groups \
6767 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
68```68```
69 69
70#### Response70#### Response
126 126
127### Returns127### Returns
128 128
129129- `id: string`- `Group object { id, created_at, is_scim_managed, name }`
130
131 Details about an organization group.
132
133 - `id: string`
130 134
131 Identifier for the group.135 Identifier for the group.
132 136
133137- `created_at: number` - `created_at: number`
134 138
135 Unix timestamp (in seconds) when the group was created.139 Unix timestamp (in seconds) when the group was created.
136 140
137141- `is_scim_managed: boolean` - `is_scim_managed: boolean`
138 142
139 Whether the group is managed through SCIM and controlled by your identity provider.143 Whether the group is managed through SCIM and controlled by your identity provider.
140 144
141145- `name: string` - `name: string`
142 146
143 Display name of the group.147 Display name of the group.
144 148
147```http151```http
148curl https://api.openai.com/v1/organization/groups \152curl https://api.openai.com/v1/organization/groups \
149 -H 'Content-Type: application/json' \153 -H 'Content-Type: application/json' \
150154 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
151 -d '{155 -d '{
152 "name": "x"156 "name": "x"
153 }'157 }'
226```http230```http
227curl https://api.openai.com/v1/organization/groups/$GROUP_ID \231curl https://api.openai.com/v1/organization/groups/$GROUP_ID \
228 -H 'Content-Type: application/json' \232 -H 'Content-Type: application/json' \
229233 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
230 -d '{234 -d '{
231 "name": "x"235 "name": "x"
232 }'236 }'
296```http300```http
297curl https://api.openai.com/v1/organization/groups/$GROUP_ID \301curl https://api.openai.com/v1/organization/groups/$GROUP_ID \
298 -X DELETE \302 -X DELETE \
299303 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
300```304```
301 305
302#### Response306#### Response
329 333
330## Domain Types334## Domain Types
331 335
332336### Group List Response### Group
333 337
334338- `GroupListResponse object { id, created_at, is_scim_managed, name }`- `Group object { id, created_at, is_scim_managed, name }`
335
336 Details about an organization group.
337
338 - `id: string`
339
340 Identifier for the group.
341
342 - `created_at: number`
343
344 Unix timestamp (in seconds) when the group was created.
345
346 - `is_scim_managed: boolean`
347
348 Whether the group is managed through SCIM and controlled by your identity provider.
349
350 - `name: string`
351
352 Display name of the group.
353
354### Group Create Response
355
356- `GroupCreateResponse object { id, created_at, is_scim_managed, name }`
357 339
358 Details about an organization group.340 Details about an organization group.
359 341
447 429
448### Returns430### Returns
449 431
450432- `data: array of User`- `data: array of OrganizationUser`
451 433
452 Users in the current page.434 Users in the current page.
453 435
499 481
500```http482```http
501curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users \483curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users \
502484 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
503```485```
504 486
505#### Response487#### Response
587```http569```http
588curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users \570curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users \
589 -H 'Content-Type: application/json' \571 -H 'Content-Type: application/json' \
590572 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
591 -d '{573 -d '{
592 "user_id": "user_id"574 "user_id": "user_id"
593 }'575 }'
653```http635```http
654curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users/$USER_ID \636curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users/$USER_ID \
655 -X DELETE \637 -X DELETE \
656638 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
657```639```
658 640
659#### Response641#### Response
818 800
819```http801```http
820curl https://api.openai.com/v1/organization/groups/$GROUP_ID/roles \802curl https://api.openai.com/v1/organization/groups/$GROUP_ID/roles \
821803 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
822```804```
823 805
824#### Response806#### Response
942 924
943 - `"group.role"`925 - `"group.role"`
944 926
945927- `role: object { id, description, name, 4 more }`- `role: Role`
946 928
947 Details about a role that can be assigned through the public Roles API.929 Details about a role that can be assigned through the public Roles API.
948 930
981```http963```http
982curl https://api.openai.com/v1/organization/groups/$GROUP_ID/roles \964curl https://api.openai.com/v1/organization/groups/$GROUP_ID/roles \
983 -H 'Content-Type: application/json' \965 -H 'Content-Type: application/json' \
984966 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
985 -d '{967 -d '{
986 "role_id": "role_id"968 "role_id": "role_id"
987 }'969 }'
1078```http1060```http
1079curl https://api.openai.com/v1/organization/groups/$GROUP_ID/roles/$ROLE_ID \1061curl https://api.openai.com/v1/organization/groups/$GROUP_ID/roles/$ROLE_ID \
1080 -X DELETE \1062 -X DELETE \
10811063 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
1082```1064```
1083 1065
1084#### Response1066#### Response
1197 1179
1198 - `"group.role"`1180 - `"group.role"`
1199 1181
12001182 - `role: object { id, description, name, 4 more }` - `role: Role`
1201 1183
1202 Details about a role that can be assigned through the public Roles API.1184 Details about a role that can be assigned through the public Roles API.
1203 1185
Previously: resources/organization/subresources/groups/methods/create/index.md
12 12
13### Returns13### Returns
14 14
1515- `id: string`- `Group object { id, created_at, is_scim_managed, name }`
16
17 Details about an organization group.
18
19 - `id: string`
16 20
17 Identifier for the group.21 Identifier for the group.
18 22
1923- `created_at: number` - `created_at: number`
20 24
21 Unix timestamp (in seconds) when the group was created.25 Unix timestamp (in seconds) when the group was created.
22 26
2327- `is_scim_managed: boolean` - `is_scim_managed: boolean`
24 28
25 Whether the group is managed through SCIM and controlled by your identity provider.29 Whether the group is managed through SCIM and controlled by your identity provider.
26 30
2731- `name: string` - `name: string`
28 32
29 Display name of the group.33 Display name of the group.
30 34
33```http37```http
34curl https://api.openai.com/v1/organization/groups \38curl https://api.openai.com/v1/organization/groups \
35 -H 'Content-Type: application/json' \39 -H 'Content-Type: application/json' \
3640 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
37 -d '{41 -d '{
38 "name": "x"42 "name": "x"
39 }'43 }'
Previously: resources/organization/subresources/groups/methods/delete/index.md
29```http29```http
30curl https://api.openai.com/v1/organization/groups/$GROUP_ID \30curl https://api.openai.com/v1/organization/groups/$GROUP_ID \
31 -X DELETE \31 -X DELETE \
3232 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
33```33```
34 34
35#### Response35#### Response
Previously: resources/organization/subresources/groups/methods/list/index.md
24 24
25### Returns25### Returns
26 26
2727- `data: array of object { id, created_at, is_scim_managed, name }`- `data: array of Group`
28 28
29 Groups returned in the current page.29 Groups returned in the current page.
30 30
62 62
63```http63```http
64curl https://api.openai.com/v1/organization/groups \64curl https://api.openai.com/v1/organization/groups \
6565 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
66```66```
67 67
68#### Response68#### Response
Previously: resources/organization/subresources/groups/methods/update/index.md
37```http37```http
38curl https://api.openai.com/v1/organization/groups/$GROUP_ID \38curl https://api.openai.com/v1/organization/groups/$GROUP_ID \
39 -H 'Content-Type: application/json' \39 -H 'Content-Type: application/json' \
4040 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
41 -d '{41 -d '{
42 "name": "x"42 "name": "x"
43 }'43 }'
Previously: resources/organization/subresources/groups/subresources/users/index.md
30 30
31### Returns31### Returns
32 32
3333- `data: array of User`- `data: array of OrganizationUser`
34 34
35 Users in the current page.35 Users in the current page.
36 36
82 82
83```http83```http
84curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users \84curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users \
8585 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
86```86```
87 87
88#### Response88#### Response
170```http170```http
171curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users \171curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users \
172 -H 'Content-Type: application/json' \172 -H 'Content-Type: application/json' \
173173 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
174 -d '{174 -d '{
175 "user_id": "user_id"175 "user_id": "user_id"
176 }'176 }'
236```http236```http
237curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users/$USER_ID \237curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users/$USER_ID \
238 -X DELETE \238 -X DELETE \
239239 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
240```240```
241 241
242#### Response242#### Response
Previously: resources/organization/subresources/groups/subresources/users/methods/create/index.md
35```http35```http
36curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users \36curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users \
37 -H 'Content-Type: application/json' \37 -H 'Content-Type: application/json' \
3838 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
39 -d '{39 -d '{
40 "user_id": "user_id"40 "user_id": "user_id"
41 }'41 }'
Previously: resources/organization/subresources/groups/subresources/users/methods/delete/index.md
27```http27```http
28curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users/$USER_ID \28curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users/$USER_ID \
29 -X DELETE \29 -X DELETE \
3030 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
31```31```
32 32
33#### Response33#### Response
Previously: resources/organization/subresources/groups/subresources/users/methods/list/index.md
28 28
29### Returns29### Returns
30 30
3131- `data: array of User`- `data: array of OrganizationUser`
32 32
33 Users in the current page.33 Users in the current page.
34 34
80 80
81```http81```http
82curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users \82curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users \
8383 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
84```84```
85 85
86#### Response86#### Response
Previously: resources/organization/subresources/invites/index.md
102 102
103```http103```http
104curl https://api.openai.com/v1/organization/invites \104curl https://api.openai.com/v1/organization/invites \
105105 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
106```106```
107 107
108#### Response108#### Response
272```http272```http
273curl https://api.openai.com/v1/organization/invites \273curl https://api.openai.com/v1/organization/invites \
274 -H 'Content-Type: application/json' \274 -H 'Content-Type: application/json' \
275275 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
276 -d '{276 -d '{
277 "email": "email",277 "email": "email",
278 "role": "reader"278 "role": "reader"
427 427
428```http428```http
429curl https://api.openai.com/v1/organization/invites/$INVITE_ID \429curl https://api.openai.com/v1/organization/invites/$INVITE_ID \
430430 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
431```431```
432 432
433#### Response433#### Response
501```http501```http
502curl https://api.openai.com/v1/organization/invites/$INVITE_ID \502curl https://api.openai.com/v1/organization/invites/$INVITE_ID \
503 -X DELETE \503 -X DELETE \
504504 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
505```505```
506 506
507#### Response507#### Response
Previously: resources/organization/subresources/invites/methods/create/index.md
105```http105```http
106curl https://api.openai.com/v1/organization/invites \106curl https://api.openai.com/v1/organization/invites \
107 -H 'Content-Type: application/json' \107 -H 'Content-Type: application/json' \
108108 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
109 -d '{109 -d '{
110 "email": "email",110 "email": "email",
111 "role": "reader"111 "role": "reader"
Previously: resources/organization/subresources/invites/methods/delete/index.md
25```http25```http
26curl https://api.openai.com/v1/organization/invites/$INVITE_ID \26curl https://api.openai.com/v1/organization/invites/$INVITE_ID \
27 -X DELETE \27 -X DELETE \
2828 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
29```29```
30 30
31#### Response31#### Response
Previously: resources/organization/subresources/invites/methods/list/index.md
100 100
101```http101```http
102curl https://api.openai.com/v1/organization/invites \102curl https://api.openai.com/v1/organization/invites \
103103 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
104```104```
105 105
106#### Response106#### Response
Previously: resources/organization/subresources/invites/methods/retrieve/index.md
78 78
79```http79```http
80curl https://api.openai.com/v1/organization/invites/$INVITE_ID \80curl https://api.openai.com/v1/organization/invites/$INVITE_ID \
8181 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
82```82```
83 83
84#### Response84#### Response
Previously: resources/organization/subresources/projects/index.md
68 68
69```http69```http
70curl https://api.openai.com/v1/organization/projects \70curl https://api.openai.com/v1/organization/projects \
7171 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
72```72```
73 73
74#### Response74#### Response
194```http194```http
195curl https://api.openai.com/v1/organization/projects \195curl https://api.openai.com/v1/organization/projects \
196 -H 'Content-Type: application/json' \196 -H 'Content-Type: application/json' \
197197 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
198 -d '{198 -d '{
199 "name": "name"199 "name": "name"
200 }'200 }'
287 287
288```http288```http
289curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \289curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \
290290 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
291```291```
292 292
293#### Response293#### Response
381```http381```http
382curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \382curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \
383 -H 'Content-Type: application/json' \383 -H 'Content-Type: application/json' \
384384 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
385 -d '{385 -d '{
386 "name": "name"386 "name": "name"
387 }'387 }'
462```http462```http
463curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/archive \463curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/archive \
464 -X POST \464 -X POST \
465465 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
466```466```
467 467
468#### Response468#### Response
605 605
606```http606```http
607curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \607curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \
608608 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
609```609```
610 610
611#### Response611#### Response
723```http723```http
724curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \724curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \
725 -H 'Content-Type: application/json' \725 -H 'Content-Type: application/json' \
726726 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
727 -d '{727 -d '{
728 "role": "owner",728 "role": "owner",
729 "user_id": "user_id"729 "user_id": "user_id"
819 819
820```http820```http
821curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \821curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \
822822 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
823```823```
824 824
825#### Response825#### Response
919```http919```http
920curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \920curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \
921 -H 'Content-Type: application/json' \921 -H 'Content-Type: application/json' \
922922 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
923 -d '{923 -d '{
924 "role": "owner"924 "role": "owner"
925 }'925 }'
992```http992```http
993curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \993curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \
994 -X DELETE \994 -X DELETE \
995995 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
996```996```
997 997
998#### Response998#### Response
1173 1173
1174```http1174```http
1175curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles \1175curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles \
11761176 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
1177```1177```
1178 1178
1179#### Response1179#### Response
1273 1273
1274 - `"user.role"`1274 - `"user.role"`
1275 1275
12761276- `role: object { id, description, name, 4 more }`- `role: Role`
1277 1277
1278 Details about a role that can be assigned through the public Roles API.1278 Details about a role that can be assigned through the public Roles API.
1279 1279
1307 1307
1308 Resource type the role is bound to (for example `api.organization` or `api.project`).1308 Resource type the role is bound to (for example `api.organization` or `api.project`).
1309 1309
13101310- `user: User`- `user: OrganizationUser`
1311 1311
1312 Represents an individual `user` within an organization.1312 Represents an individual `user` within an organization.
1313 1313
1346```http1346```http
1347curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles \1347curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles \
1348 -H 'Content-Type: application/json' \1348 -H 'Content-Type: application/json' \
13491349 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
1350 -d '{1350 -d '{
1351 "role_id": "role_id"1351 "role_id": "role_id"
1352 }'1352 }'
1447```http1447```http
1448curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles/$ROLE_ID \1448curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles/$ROLE_ID \
1449 -X DELETE \1449 -X DELETE \
14501450 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
1451```1451```
1452 1452
1453#### Response1453#### Response
1540 1540
1541 - `"user.role"`1541 - `"user.role"`
1542 1542
15431543 - `role: object { id, description, name, 4 more }` - `role: Role`
1544 1544
1545 Details about a role that can be assigned through the public Roles API.1545 Details about a role that can be assigned through the public Roles API.
1546 1546
1574 1574
1575 Resource type the role is bound to (for example `api.organization` or `api.project`).1575 Resource type the role is bound to (for example `api.organization` or `api.project`).
1576 1576
15771577 - `user: User` - `user: OrganizationUser`
1578 1578
1579 Represents an individual `user` within an organization.1579 Represents an individual `user` within an organization.
1580 1580
1688 1688
1689```http1689```http
1690curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts \1690curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts \
16911691 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
1692```1692```
1693 1693
1694#### Response1694#### Response
1794```http1794```http
1795curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts \1795curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts \
1796 -H 'Content-Type: application/json' \1796 -H 'Content-Type: application/json' \
17971797 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
1798 -d '{1798 -d '{
1799 "name": "name"1799 "name": "name"
1800 }'1800 }'
1897 1897
1898```http1898```http
1899curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \1899curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \
19001900 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
1901```1901```
1902 1902
1903#### Response1903#### Response
1962```http1962```http
1963curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \1963curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \
1964 -X DELETE \1964 -X DELETE \
19651965 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
1966```1966```
1967 1967
1968#### Response1968#### Response
2099 2099
2100### Returns2100### Returns
2101 2101
21022102- `data: array of ProjectAPIEy`- `data: array of ProjectAPIKey`
2103 2103
2104 - `id: string`2104 - `id: string`
2105 2105
2215 2215
2216```http2216```http
2217curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys \2217curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys \
22182218 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
2219```2219```
2220 2220
2221#### Response2221#### Response
2311 2311
2312### Returns2312### Returns
2313 2313
23142314- `ProjectAPIEy object { id, created_at, last_used_at, 4 more }`- `ProjectAPIKey object { id, created_at, last_used_at, 4 more }`
2315 2315
2316 Represents an individual API key in a project.2316 Represents an individual API key in a project.
2317 2317
2419 2419
2420```http2420```http
2421curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \2421curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \
24222422 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
2423```2423```
2424 2424
2425#### Response2425#### Response
2515```http2515```http
2516curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \2516curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \
2517 -X DELETE \2517 -X DELETE \
25182518 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
2519```2519```
2520 2520
2521#### Response2521#### Response
2548 2548
2549## Domain Types2549## Domain Types
2550 2550
25512551### Project API Ey### Project API Key
2552 2552
25532553- `ProjectAPIEy object { id, created_at, last_used_at, 4 more }`- `ProjectAPIKey object { id, created_at, last_used_at, 4 more }`
2554 2554
2555 Represents an individual API key in a project.2555 Represents an individual API key in a project.
2556 2556
2694 2694
2695### Returns2695### Returns
2696 2696
26972697- `data: array of object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more }`- `data: array of ProjectRateLimit`
2698 2698
2699 - `id: string`2699 - `id: string`
2700 2700
2748 2748
2749```http2749```http
2750curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/rate_limits \2750curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/rate_limits \
27512751 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
2752```2752```
2753 2753
2754#### Response2754#### Response
2844 2844
2845### Returns2845### Returns
2846 2846
28472847- `id: string`- `ProjectRateLimit object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more }`
2848
2849 Represents a project rate limit config.
2850
2851 - `id: string`
2848 2852
2849 The identifier, which can be referenced in API endpoints.2853 The identifier, which can be referenced in API endpoints.
2850 2854
28512855- `max_requests_per_1_minute: number` - `max_requests_per_1_minute: number`
2852 2856
2853 The maximum requests per minute.2857 The maximum requests per minute.
2854 2858
28552859- `max_tokens_per_1_minute: number` - `max_tokens_per_1_minute: number`
2856 2860
2857 The maximum tokens per minute.2861 The maximum tokens per minute.
2858 2862
28592863- `model: string` - `model: string`
2860 2864
2861 The model this rate limit applies to.2865 The model this rate limit applies to.
2862 2866
28632867- `object: "project.rate_limit"` - `object: "project.rate_limit"`
2864 2868
2865 The object type, which is always `project.rate_limit`2869 The object type, which is always `project.rate_limit`
2866 2870
2867 - `"project.rate_limit"`2871 - `"project.rate_limit"`
2868 2872
28692873- `batch_1_day_max_input_tokens: optional number` - `batch_1_day_max_input_tokens: optional number`
2870 2874
2871 The maximum batch input tokens per day. Only present for relevant models.2875 The maximum batch input tokens per day. Only present for relevant models.
2872 2876
28732877- `max_audio_megabytes_per_1_minute: optional number` - `max_audio_megabytes_per_1_minute: optional number`
2874 2878
2875 The maximum audio megabytes per minute. Only present for relevant models.2879 The maximum audio megabytes per minute. Only present for relevant models.
2876 2880
28772881- `max_images_per_1_minute: optional number` - `max_images_per_1_minute: optional number`
2878 2882
2879 The maximum images per minute. Only present for relevant models.2883 The maximum images per minute. Only present for relevant models.
2880 2884
28812885- `max_requests_per_1_day: optional number` - `max_requests_per_1_day: optional number`
2882 2886
2883 The maximum requests per day. Only present for relevant models.2887 The maximum requests per day. Only present for relevant models.
2884 2888
2887```http2891```http
2888curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/rate_limits/$RATE_LIMIT_ID \2892curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/rate_limits/$RATE_LIMIT_ID \
2889 -H 'Content-Type: application/json' \2893 -H 'Content-Type: application/json' \
28902894 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
2891 -d '{}'2895 -d '{}'
2892```2896```
2893 2897
2933 2937
2934## Domain Types2938## Domain Types
2935 2939
29362940### Rate Limit List Rate Limits Response### Project Rate Limit
2937
2938- `RateLimitListRateLimitsResponse object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more }`
2939
2940 Represents a project rate limit config.
2941
2942 - `id: string`
2943
2944 The identifier, which can be referenced in API endpoints.
2945
2946 - `max_requests_per_1_minute: number`
2947
2948 The maximum requests per minute.
2949
2950 - `max_tokens_per_1_minute: number`
2951
2952 The maximum tokens per minute.
2953
2954 - `model: string`
2955
2956 The model this rate limit applies to.
2957
2958 - `object: "project.rate_limit"`
2959
2960 The object type, which is always `project.rate_limit`
2961
2962 - `"project.rate_limit"`
2963
2964 - `batch_1_day_max_input_tokens: optional number`
2965
2966 The maximum batch input tokens per day. Only present for relevant models.
2967
2968 - `max_audio_megabytes_per_1_minute: optional number`
2969
2970 The maximum audio megabytes per minute. Only present for relevant models.
2971
2972 - `max_images_per_1_minute: optional number`
2973
2974 The maximum images per minute. Only present for relevant models.
2975
2976 - `max_requests_per_1_day: optional number`
2977
2978 The maximum requests per day. Only present for relevant models.
2979
2980### Rate Limit Update Rate Limit Response
2981 2941
29822942- `RateLimitUpdateRateLimitResponse object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more }`- `ProjectRateLimit object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more }`
2983 2943
2984 Represents a project rate limit config.2944 Represents a project rate limit config.
2985 2945
3053 3013
3054### Returns3014### Returns
3055 3015
30563016- `data: array of object { created_at, group_id, group_name, 2 more }`- `data: array of ProjectGroup`
3057 3017
3058 Project group memberships returned in the current page.3018 Project group memberships returned in the current page.
3059 3019
3097 3057
3098```http3058```http
3099curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups \3059curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups \
31003060 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
3101```3061```
3102 3062
3103#### Response3063#### Response
3168 3128
3169### Returns3129### Returns
3170 3130
31713131- `created_at: number`- `ProjectGroup object { created_at, group_id, group_name, 2 more }`
3132
3133 Details about a group's membership in a project.
3134
3135 - `created_at: number`
3172 3136
3173 Unix timestamp (in seconds) when the group was granted project access.3137 Unix timestamp (in seconds) when the group was granted project access.
3174 3138
31753139- `group_id: string` - `group_id: string`
3176 3140
3177 Identifier of the group that has access to the project.3141 Identifier of the group that has access to the project.
3178 3142
31793143- `group_name: string` - `group_name: string`
3180 3144
3181 Display name of the group.3145 Display name of the group.
3182 3146
31833147- `object: "project.group"` - `object: "project.group"`
3184 3148
3185 Always `project.group`.3149 Always `project.group`.
3186 3150
3187 - `"project.group"`3151 - `"project.group"`
3188 3152
31893153- `project_id: string` - `project_id: string`
3190 3154
3191 Identifier of the project.3155 Identifier of the project.
3192 3156
3195```http3159```http
3196curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups \3160curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups \
3197 -H 'Content-Type: application/json' \3161 -H 'Content-Type: application/json' \
31983162 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
3199 -d '{3163 -d '{
3200 "group_id": "group_id",3164 "group_id": "group_id",
3201 "role": "role"3165 "role": "role"
3267```http3231```http
3268curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups/$GROUP_ID \3232curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups/$GROUP_ID \
3269 -X DELETE \3233 -X DELETE \
32703234 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
3271```3235```
3272 3236
3273#### Response3237#### Response
3298 3262
3299## Domain Types3263## Domain Types
3300 3264
33013265### Group List Response### Project Group
3302 3266
33033267- `GroupListResponse object { created_at, group_id, group_name, 2 more }`- `ProjectGroup object { created_at, group_id, group_name, 2 more }`
3304
3305 Details about a group's membership in a project.
3306
3307 - `created_at: number`
3308
3309 Unix timestamp (in seconds) when the group was granted project access.
3310
3311 - `group_id: string`
3312
3313 Identifier of the group that has access to the project.
3314
3315 - `group_name: string`
3316
3317 Display name of the group.
3318
3319 - `object: "project.group"`
3320
3321 Always `project.group`.
3322
3323 - `"project.group"`
3324
3325 - `project_id: string`
3326
3327 Identifier of the project.
3328
3329### Group Create Response
3330
3331- `GroupCreateResponse object { created_at, group_id, group_name, 2 more }`
3332 3268
3333 Details about a group's membership in a project.3269 Details about a group's membership in a project.
3334 3270
3470 3406
3471```http3407```http
3472curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles \3408curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles \
34733409 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
3474```3410```
3475 3411
3476#### Response3412#### Response
3596 3532
3597 - `"group.role"`3533 - `"group.role"`
3598 3534
35993535- `role: object { id, description, name, 4 more }`- `role: Role`
3600 3536
3601 Details about a role that can be assigned through the public Roles API.3537 Details about a role that can be assigned through the public Roles API.
3602 3538
3635```http3571```http
3636curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles \3572curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles \
3637 -H 'Content-Type: application/json' \3573 -H 'Content-Type: application/json' \
36383574 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
3639 -d '{3575 -d '{
3640 "role_id": "role_id"3576 "role_id": "role_id"
3641 }'3577 }'
3734```http3670```http
3735curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles/$ROLE_ID \3671curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles/$ROLE_ID \
3736 -X DELETE \3672 -X DELETE \
37373673 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
3738```3674```
3739 3675
3740#### Response3676#### Response
3853 3789
3854 - `"group.role"`3790 - `"group.role"`
3855 3791
38563792 - `role: object { id, description, name, 4 more }` - `role: Role`
3857 3793
3858 Details about a role that can be assigned through the public Roles API.3794 Details about a role that can be assigned through the public Roles API.
3859 3795
3933 3869
3934### Returns3870### Returns
3935 3871
39363872- `data: array of object { id, description, name, 4 more }`- `data: array of Role`
3937 3873
3938 Roles returned in the current page.3874 Roles returned in the current page.
3939 3875
3985 3921
3986```http3922```http
3987curl https://api.openai.com/v1/projects/$PROJECT_ID/roles \3923curl https://api.openai.com/v1/projects/$PROJECT_ID/roles \
39883924 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
3989```3925```
3990 3926
3991#### Response3927#### Response
4069 4005
4070### Returns4006### Returns
4071 4007
40724008- `id: string`- `Role object { id, description, name, 4 more }`
4009
4010 Details about a role that can be assigned through the public Roles API.
4011
4012 - `id: string`
4073 4013
4074 Identifier for the role.4014 Identifier for the role.
4075 4015
40764016- `description: string` - `description: string`
4077 4017
4078 Optional description of the role.4018 Optional description of the role.
4079 4019
40804020- `name: string` - `name: string`
4081 4021
4082 Unique name for the role.4022 Unique name for the role.
4083 4023
40844024- `object: "role"` - `object: "role"`
4085 4025
4086 Always `role`.4026 Always `role`.
4087 4027
4088 - `"role"`4028 - `"role"`
4089 4029
40904030- `permissions: array of string` - `permissions: array of string`
4091 4031
4092 Permissions granted by the role.4032 Permissions granted by the role.
4093 4033
40944034- `predefined_role: boolean` - `predefined_role: boolean`
4095 4035
4096 Whether the role is predefined and managed by OpenAI.4036 Whether the role is predefined and managed by OpenAI.
4097 4037
40984038- `resource_type: string` - `resource_type: string`
4099 4039
4100 Resource type the role is bound to (for example `api.organization` or `api.project`).4040 Resource type the role is bound to (for example `api.organization` or `api.project`).
4101 4041
4104```http4044```http
4105curl https://api.openai.com/v1/projects/$PROJECT_ID/roles \4045curl https://api.openai.com/v1/projects/$PROJECT_ID/roles \
4106 -H 'Content-Type: application/json' \4046 -H 'Content-Type: application/json' \
41074047 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
4108 -d '{4048 -d '{
4109 "permissions": [4049 "permissions": [
4110 "string"4050 "string"
4190 4130
4191### Returns4131### Returns
4192 4132
41934133- `id: string`- `Role object { id, description, name, 4 more }`
4134
4135 Details about a role that can be assigned through the public Roles API.
4136
4137 - `id: string`
4194 4138
4195 Identifier for the role.4139 Identifier for the role.
4196 4140
41974141- `description: string` - `description: string`
4198 4142
4199 Optional description of the role.4143 Optional description of the role.
4200 4144
42014145- `name: string` - `name: string`
4202 4146
4203 Unique name for the role.4147 Unique name for the role.
4204 4148
42054149- `object: "role"` - `object: "role"`
4206 4150
4207 Always `role`.4151 Always `role`.
4208 4152
4209 - `"role"`4153 - `"role"`
4210 4154
42114155- `permissions: array of string` - `permissions: array of string`
4212 4156
4213 Permissions granted by the role.4157 Permissions granted by the role.
4214 4158
42154159- `predefined_role: boolean` - `predefined_role: boolean`
4216 4160
4217 Whether the role is predefined and managed by OpenAI.4161 Whether the role is predefined and managed by OpenAI.
4218 4162
42194163- `resource_type: string` - `resource_type: string`
4220 4164
4221 Resource type the role is bound to (for example `api.organization` or `api.project`).4165 Resource type the role is bound to (for example `api.organization` or `api.project`).
4222 4166
4225```http4169```http
4226curl https://api.openai.com/v1/projects/$PROJECT_ID/roles/$ROLE_ID \4170curl https://api.openai.com/v1/projects/$PROJECT_ID/roles/$ROLE_ID \
4227 -H 'Content-Type: application/json' \4171 -H 'Content-Type: application/json' \
42284172 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
4229 -d '{}'4173 -d '{}'
4230```4174```
4231 4175
4311```http4255```http
4312curl https://api.openai.com/v1/projects/$PROJECT_ID/roles/$ROLE_ID \4256curl https://api.openai.com/v1/projects/$PROJECT_ID/roles/$ROLE_ID \
4313 -X DELETE \4257 -X DELETE \
43144258 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
4315```4259```
4316 4260
4317#### Response4261#### Response
4344 4288
4345## Domain Types4289## Domain Types
4346 4290
4347### Role List Response
4348
4349- `RoleListResponse object { id, description, name, 4 more }`
4350
4351 Details about a role that can be assigned through the public Roles API.
4352
4353 - `id: string`
4354
4355 Identifier for the role.
4356
4357 - `description: string`
4358
4359 Optional description of the role.
4360
4361 - `name: string`
4362
4363 Unique name for the role.
4364
4365 - `object: "role"`
4366
4367 Always `role`.
4368
4369 - `"role"`
4370
4371 - `permissions: array of string`
4372
4373 Permissions granted by the role.
4374
4375 - `predefined_role: boolean`
4376
4377 Whether the role is predefined and managed by OpenAI.
4378
4379 - `resource_type: string`
4380
4381 Resource type the role is bound to (for example `api.organization` or `api.project`).
4382
4383### Role Create Response
4384
4385- `RoleCreateResponse object { id, description, name, 4 more }`
4386
4387 Details about a role that can be assigned through the public Roles API.
4388
4389 - `id: string`
4390
4391 Identifier for the role.
4392
4393 - `description: string`
4394
4395 Optional description of the role.
4396
4397 - `name: string`
4398
4399 Unique name for the role.
4400
4401 - `object: "role"`
4402
4403 Always `role`.
4404
4405 - `"role"`
4406
4407 - `permissions: array of string`
4408
4409 Permissions granted by the role.
4410
4411 - `predefined_role: boolean`
4412
4413 Whether the role is predefined and managed by OpenAI.
4414
4415 - `resource_type: string`
4416
4417 Resource type the role is bound to (for example `api.organization` or `api.project`).
4418
4419### Role Update Response
4420
4421- `RoleUpdateResponse object { id, description, name, 4 more }`
4422
4423 Details about a role that can be assigned through the public Roles API.
4424
4425 - `id: string`
4426
4427 Identifier for the role.
4428
4429 - `description: string`
4430
4431 Optional description of the role.
4432
4433 - `name: string`
4434
4435 Unique name for the role.
4436
4437 - `object: "role"`
4438
4439 Always `role`.
4440
4441 - `"role"`
4442
4443 - `permissions: array of string`
4444
4445 Permissions granted by the role.
4446
4447 - `predefined_role: boolean`
4448
4449 Whether the role is predefined and managed by OpenAI.
4450
4451 - `resource_type: string`
4452
4453 Resource type the role is bound to (for example `api.organization` or `api.project`).
4454
4455### Role Delete Response4291### Role Delete Response
4456 4292
4457- `RoleDeleteResponse object { id, deleted, object }`4293- `RoleDeleteResponse object { id, deleted, object }`
4504 4340
4505### Returns4341### Returns
4506 4342
45074343- `data: array of object { id, certificate_details, created_at, 3 more }`- `data: array of Certificate`
4508 4344
4509 - `id: string`4345 - `id: string`
4510 4346
4564 4400
4565```http4401```http
4566curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/certificates \4402curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/certificates \
45674403 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
4568```4404```
4569 4405
4570#### Response4406#### Response
4641 4477
4642### Returns4478### Returns
4643 4479
46444480- `data: array of object { id, certificate_details, created_at, 3 more }`- `data: array of Certificate`
4645 4481
4646 - `id: string`4482 - `id: string`
4647 4483
4702```http4538```http
4703curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/certificates/activate \4539curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/certificates/activate \
4704 -H 'Content-Type: application/json' \4540 -H 'Content-Type: application/json' \
47054541 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
4706 -d '{4542 -d '{
4707 "certificate_ids": [4543 "certificate_ids": [
4708 "cert_abc"4544 "cert_abc"
4795 4631
4796### Returns4632### Returns
4797 4633
47984634- `data: array of object { id, certificate_details, created_at, 3 more }`- `data: array of Certificate`
4799 4635
4800 - `id: string`4636 - `id: string`
4801 4637
4856```http4692```http
4857curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/certificates/deactivate \4693curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/certificates/deactivate \
4858 -H 'Content-Type: application/json' \4694 -H 'Content-Type: application/json' \
48594695 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
4860 -d '{4696 -d '{
4861 "certificate_ids": [4697 "certificate_ids": [
4862 "cert_abc"4698 "cert_abc"
4931 ],4767 ],
4932}4768}
4933```4769```
4934
4935## Domain Types
4936
4937### Certificate List Response
4938
4939- `CertificateListResponse object { id, certificate_details, created_at, 3 more }`
4940
4941 Represents an individual `certificate` uploaded to the organization.
4942
4943 - `id: string`
4944
4945 The identifier, which can be referenced in API endpoints
4946
4947 - `certificate_details: object { content, expires_at, valid_at }`
4948
4949 - `content: optional string`
4950
4951 The content of the certificate in PEM format.
4952
4953 - `expires_at: optional number`
4954
4955 The Unix timestamp (in seconds) of when the certificate expires.
4956
4957 - `valid_at: optional number`
4958
4959 The Unix timestamp (in seconds) of when the certificate becomes valid.
4960
4961 - `created_at: number`
4962
4963 The Unix timestamp (in seconds) of when the certificate was uploaded.
4964
4965 - `name: string`
4966
4967 The name of the certificate.
4968
4969 - `object: "certificate" or "organization.certificate" or "organization.project.certificate"`
4970
4971 The object type.
4972
4973 - If creating, updating, or getting a specific certificate, the object type is `certificate`.
4974 - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`.
4975 - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`.
4976
4977 - `"certificate"`
4978
4979 - `"organization.certificate"`
4980
4981 - `"organization.project.certificate"`
4982
4983 - `active: optional boolean`
4984
4985 Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate.
4986
4987### Certificate Activate Response
4988
4989- `CertificateActivateResponse object { id, certificate_details, created_at, 3 more }`
4990
4991 Represents an individual `certificate` uploaded to the organization.
4992
4993 - `id: string`
4994
4995 The identifier, which can be referenced in API endpoints
4996
4997 - `certificate_details: object { content, expires_at, valid_at }`
4998
4999 - `content: optional string`
5000
5001 The content of the certificate in PEM format.
5002
5003 - `expires_at: optional number`
5004
5005 The Unix timestamp (in seconds) of when the certificate expires.
5006
5007 - `valid_at: optional number`
5008
5009 The Unix timestamp (in seconds) of when the certificate becomes valid.
5010
5011 - `created_at: number`
5012
5013 The Unix timestamp (in seconds) of when the certificate was uploaded.
5014
5015 - `name: string`
5016
5017 The name of the certificate.
5018
5019 - `object: "certificate" or "organization.certificate" or "organization.project.certificate"`
5020
5021 The object type.
5022
5023 - If creating, updating, or getting a specific certificate, the object type is `certificate`.
5024 - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`.
5025 - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`.
5026
5027 - `"certificate"`
5028
5029 - `"organization.certificate"`
5030
5031 - `"organization.project.certificate"`
5032
5033 - `active: optional boolean`
5034
5035 Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate.
5036
5037### Certificate Deactivate Response
5038
5039- `CertificateDeactivateResponse object { id, certificate_details, created_at, 3 more }`
5040
5041 Represents an individual `certificate` uploaded to the organization.
5042
5043 - `id: string`
5044
5045 The identifier, which can be referenced in API endpoints
5046
5047 - `certificate_details: object { content, expires_at, valid_at }`
5048
5049 - `content: optional string`
5050
5051 The content of the certificate in PEM format.
5052
5053 - `expires_at: optional number`
5054
5055 The Unix timestamp (in seconds) of when the certificate expires.
5056
5057 - `valid_at: optional number`
5058
5059 The Unix timestamp (in seconds) of when the certificate becomes valid.
5060
5061 - `created_at: number`
5062
5063 The Unix timestamp (in seconds) of when the certificate was uploaded.
5064
5065 - `name: string`
5066
5067 The name of the certificate.
5068
5069 - `object: "certificate" or "organization.certificate" or "organization.project.certificate"`
5070
5071 The object type.
5072
5073 - If creating, updating, or getting a specific certificate, the object type is `certificate`.
5074 - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`.
5075 - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`.
5076
5077 - `"certificate"`
5078
5079 - `"organization.certificate"`
5080
5081 - `"organization.project.certificate"`
5082
5083 - `active: optional boolean`
5084
5085 Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate.
Previously: resources/organization/subresources/projects/methods/create/index.md
71```http71```http
72curl https://api.openai.com/v1/organization/projects \72curl https://api.openai.com/v1/organization/projects \
73 -H 'Content-Type: application/json' \73 -H 'Content-Type: application/json' \
7474 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
75 -d '{75 -d '{
76 "name": "name"76 "name": "name"
77 }'77 }'
Previously: resources/organization/subresources/projects/methods/list/index.md
66 66
67```http67```http
68curl https://api.openai.com/v1/organization/projects \68curl https://api.openai.com/v1/organization/projects \
6969 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
70```70```
71 71
72#### Response72#### Response
Previously: resources/organization/subresources/projects/methods/retrieve/index.md
48 48
49```http49```http
50curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \50curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \
5151 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
52```52```
53 53
54#### Response54#### Response
Previously: resources/organization/subresources/projects/methods/update/index.md
55```http55```http
56curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \56curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \
57 -H 'Content-Type: application/json' \57 -H 'Content-Type: application/json' \
5858 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
59 -d '{59 -d '{
60 "name": "name"60 "name": "name"
61 }'61 }'
Previously: resources/organization/subresources/projects/subresources/api_keys/index.md
22 22
23### Returns23### Returns
24 24
2525- `data: array of ProjectAPIEy`- `data: array of ProjectAPIKey`
26 26
27 - `id: string`27 - `id: string`
28 28
138 138
139```http139```http
140curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys \140curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys \
141141 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
142```142```
143 143
144#### Response144#### Response
234 234
235### Returns235### Returns
236 236
237237- `ProjectAPIEy object { id, created_at, last_used_at, 4 more }`- `ProjectAPIKey object { id, created_at, last_used_at, 4 more }`
238 238
239 Represents an individual API key in a project.239 Represents an individual API key in a project.
240 240
342 342
343```http343```http
344curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \344curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \
345345 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
346```346```
347 347
348#### Response348#### Response
438```http438```http
439curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \439curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \
440 -X DELETE \440 -X DELETE \
441441 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
442```442```
443 443
444#### Response444#### Response
471 471
472## Domain Types472## Domain Types
473 473
474474### Project API Ey### Project API Key
475 475
476476- `ProjectAPIEy object { id, created_at, last_used_at, 4 more }`- `ProjectAPIKey object { id, created_at, last_used_at, 4 more }`
477 477
478 Represents an individual API key in a project.478 Represents an individual API key in a project.
479 479
Previously: resources/organization/subresources/projects/subresources/api_keys/methods/delete/index.md
28```http28```http
29curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \29curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \
30 -X DELETE \30 -X DELETE \
3131 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
32```32```
33 33
34#### Response34#### Response
Previously: resources/organization/subresources/projects/subresources/api_keys/methods/list/index.md
20 20
21### Returns21### Returns
22 22
2323- `data: array of ProjectAPIEy`- `data: array of ProjectAPIKey`
24 24
25 - `id: string`25 - `id: string`
26 26
136 136
137```http137```http
138curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys \138curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys \
139139 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
140```140```
141 141
142#### Response142#### Response
Previously: resources/organization/subresources/projects/subresources/api_keys/methods/retrieve/index.md
12 12
13### Returns13### Returns
14 14
1515- `ProjectAPIEy object { id, created_at, last_used_at, 4 more }`- `ProjectAPIKey object { id, created_at, last_used_at, 4 more }`
16 16
17 Represents an individual API key in a project.17 Represents an individual API key in a project.
18 18
120 120
121```http121```http
122curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \122curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \
123123 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
124```124```
125 125
126#### Response126#### Response
Previously: resources/organization/subresources/projects/subresources/groups/index.md
30 30
31### Returns31### Returns
32 32
3333- `data: array of object { created_at, group_id, group_name, 2 more }`- `data: array of ProjectGroup`
34 34
35 Project group memberships returned in the current page.35 Project group memberships returned in the current page.
36 36
74 74
75```http75```http
76curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups \76curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups \
7777 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
78```78```
79 79
80#### Response80#### Response
145 145
146### Returns146### Returns
147 147
148148- `created_at: number`- `ProjectGroup object { created_at, group_id, group_name, 2 more }`
149
150 Details about a group's membership in a project.
151
152 - `created_at: number`
149 153
150 Unix timestamp (in seconds) when the group was granted project access.154 Unix timestamp (in seconds) when the group was granted project access.
151 155
152156- `group_id: string` - `group_id: string`
153 157
154 Identifier of the group that has access to the project.158 Identifier of the group that has access to the project.
155 159
156160- `group_name: string` - `group_name: string`
157 161
158 Display name of the group.162 Display name of the group.
159 163
160164- `object: "project.group"` - `object: "project.group"`
161 165
162 Always `project.group`.166 Always `project.group`.
163 167
164 - `"project.group"`168 - `"project.group"`
165 169
166170- `project_id: string` - `project_id: string`
167 171
168 Identifier of the project.172 Identifier of the project.
169 173
172```http176```http
173curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups \177curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups \
174 -H 'Content-Type: application/json' \178 -H 'Content-Type: application/json' \
175179 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
176 -d '{180 -d '{
177 "group_id": "group_id",181 "group_id": "group_id",
178 "role": "role"182 "role": "role"
244```http248```http
245curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups/$GROUP_ID \249curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups/$GROUP_ID \
246 -X DELETE \250 -X DELETE \
247251 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
248```252```
249 253
250#### Response254#### Response
275 279
276## Domain Types280## Domain Types
277 281
278282### Group List Response### Project Group
279
280- `GroupListResponse object { created_at, group_id, group_name, 2 more }`
281
282 Details about a group's membership in a project.
283
284 - `created_at: number`
285
286 Unix timestamp (in seconds) when the group was granted project access.
287
288 - `group_id: string`
289
290 Identifier of the group that has access to the project.
291
292 - `group_name: string`
293 283
294284 Display name of the group.- `ProjectGroup object { created_at, group_id, group_name, 2 more }`
295
296 - `object: "project.group"`
297
298 Always `project.group`.
299
300 - `"project.group"`
301
302 - `project_id: string`
303
304 Identifier of the project.
305
306### Group Create Response
307
308- `GroupCreateResponse object { created_at, group_id, group_name, 2 more }`
309 285
310 Details about a group's membership in a project.286 Details about a group's membership in a project.
311 287
447 423
448```http424```http
449curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles \425curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles \
450426 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
451```427```
452 428
453#### Response429#### Response
573 549
574 - `"group.role"`550 - `"group.role"`
575 551
576552- `role: object { id, description, name, 4 more }`- `role: Role`
577 553
578 Details about a role that can be assigned through the public Roles API.554 Details about a role that can be assigned through the public Roles API.
579 555
612```http588```http
613curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles \589curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles \
614 -H 'Content-Type: application/json' \590 -H 'Content-Type: application/json' \
615591 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
616 -d '{592 -d '{
617 "role_id": "role_id"593 "role_id": "role_id"
618 }'594 }'
711```http687```http
712curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles/$ROLE_ID \688curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles/$ROLE_ID \
713 -X DELETE \689 -X DELETE \
714690 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
715```691```
716 692
717#### Response693#### Response
830 806
831 - `"group.role"`807 - `"group.role"`
832 808
833809 - `role: object { id, description, name, 4 more }` - `role: Role`
834 810
835 Details about a role that can be assigned through the public Roles API.811 Details about a role that can be assigned through the public Roles API.
836 812
Previously: resources/organization/subresources/projects/subresources/groups/methods/delete/index.md
27```http27```http
28curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups/$GROUP_ID \28curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups/$GROUP_ID \
29 -X DELETE \29 -X DELETE \
3030 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
31```31```
32 32
33#### Response33#### Response
Previously: resources/organization/subresources/projects/subresources/groups/methods/list/index.md
28 28
29### Returns29### Returns
30 30
3131- `data: array of object { created_at, group_id, group_name, 2 more }`- `data: array of ProjectGroup`
32 32
33 Project group memberships returned in the current page.33 Project group memberships returned in the current page.
34 34
72 72
73```http73```http
74curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups \74curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups \
7575 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
76```76```
77 77
78#### Response78#### Response
Previously: resources/organization/subresources/projects/subresources/groups/subresources/roles/methods/create/index.md
50 50
51 - `"group.role"`51 - `"group.role"`
52 52
5353- `role: object { id, description, name, 4 more }`- `role: Role`
54 54
55 Details about a role that can be assigned through the public Roles API.55 Details about a role that can be assigned through the public Roles API.
56 56
89```http89```http
90curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles \90curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles \
91 -H 'Content-Type: application/json' \91 -H 'Content-Type: application/json' \
9292 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
93 -d '{93 -d '{
94 "role_id": "role_id"94 "role_id": "role_id"
95 }'95 }'
Previously: resources/organization/subresources/projects/subresources/groups/subresources/roles/methods/delete/index.md
27```http27```http
28curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles/$ROLE_ID \28curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles/$ROLE_ID \
29 -X DELETE \29 -X DELETE \
3030 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
31```31```
32 32
33#### Response33#### Response
Previously: resources/organization/subresources/projects/subresources/groups/subresources/roles/methods/list/index.md
96 96
97```http97```http
98curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles \98curl https://api.openai.com/v1/projects/$PROJECT_ID/groups/$GROUP_ID/roles \
9999 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
100```100```
101 101
102#### Response102#### Response
Previously: resources/organization/subresources/projects/subresources/rate_limits/index.md
26 26
27### Returns27### Returns
28 28
2929- `data: array of object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more }`- `data: array of ProjectRateLimit`
30 30
31 - `id: string`31 - `id: string`
32 32
80 80
81```http81```http
82curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/rate_limits \82curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/rate_limits \
8383 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
84```84```
85 85
86#### Response86#### Response
176 176
177### Returns177### Returns
178 178
179179- `id: string`- `ProjectRateLimit object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more }`
180
181 Represents a project rate limit config.
182
183 - `id: string`
180 184
181 The identifier, which can be referenced in API endpoints.185 The identifier, which can be referenced in API endpoints.
182 186
183187- `max_requests_per_1_minute: number` - `max_requests_per_1_minute: number`
184 188
185 The maximum requests per minute.189 The maximum requests per minute.
186 190
187191- `max_tokens_per_1_minute: number` - `max_tokens_per_1_minute: number`
188 192
189 The maximum tokens per minute.193 The maximum tokens per minute.
190 194
191195- `model: string` - `model: string`
192 196
193 The model this rate limit applies to.197 The model this rate limit applies to.
194 198
195199- `object: "project.rate_limit"` - `object: "project.rate_limit"`
196 200
197 The object type, which is always `project.rate_limit`201 The object type, which is always `project.rate_limit`
198 202
199 - `"project.rate_limit"`203 - `"project.rate_limit"`
200 204
201205- `batch_1_day_max_input_tokens: optional number` - `batch_1_day_max_input_tokens: optional number`
202 206
203 The maximum batch input tokens per day. Only present for relevant models.207 The maximum batch input tokens per day. Only present for relevant models.
204 208
205209- `max_audio_megabytes_per_1_minute: optional number` - `max_audio_megabytes_per_1_minute: optional number`
206 210
207 The maximum audio megabytes per minute. Only present for relevant models.211 The maximum audio megabytes per minute. Only present for relevant models.
208 212
209213- `max_images_per_1_minute: optional number` - `max_images_per_1_minute: optional number`
210 214
211 The maximum images per minute. Only present for relevant models.215 The maximum images per minute. Only present for relevant models.
212 216
213217- `max_requests_per_1_day: optional number` - `max_requests_per_1_day: optional number`
214 218
215 The maximum requests per day. Only present for relevant models.219 The maximum requests per day. Only present for relevant models.
216 220
219```http223```http
220curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/rate_limits/$RATE_LIMIT_ID \224curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/rate_limits/$RATE_LIMIT_ID \
221 -H 'Content-Type: application/json' \225 -H 'Content-Type: application/json' \
222226 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
223 -d '{}'227 -d '{}'
224```228```
225 229
265 269
266## Domain Types270## Domain Types
267 271
268272### Rate Limit List Rate Limits Response### Project Rate Limit
269
270- `RateLimitListRateLimitsResponse object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more }`
271
272 Represents a project rate limit config.
273
274 - `id: string`
275
276 The identifier, which can be referenced in API endpoints.
277
278 - `max_requests_per_1_minute: number`
279
280 The maximum requests per minute.
281
282 - `max_tokens_per_1_minute: number`
283
284 The maximum tokens per minute.
285
286 - `model: string`
287
288 The model this rate limit applies to.
289
290 - `object: "project.rate_limit"`
291
292 The object type, which is always `project.rate_limit`
293
294 - `"project.rate_limit"`
295
296 - `batch_1_day_max_input_tokens: optional number`
297
298 The maximum batch input tokens per day. Only present for relevant models.
299
300 - `max_audio_megabytes_per_1_minute: optional number`
301
302 The maximum audio megabytes per minute. Only present for relevant models.
303
304 - `max_images_per_1_minute: optional number`
305
306 The maximum images per minute. Only present for relevant models.
307
308 - `max_requests_per_1_day: optional number`
309
310 The maximum requests per day. Only present for relevant models.
311
312### Rate Limit Update Rate Limit Response
313 273
314274- `RateLimitUpdateRateLimitResponse object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more }`- `ProjectRateLimit object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more }`
315 275
316 Represents a project rate limit config.276 Represents a project rate limit config.
317 277
Previously: resources/organization/subresources/projects/subresources/roles/methods/create/index.md
24 24
25### Returns25### Returns
26 26
2727- `id: string`- `Role object { id, description, name, 4 more }`
28
29 Details about a role that can be assigned through the public Roles API.
30
31 - `id: string`
28 32
29 Identifier for the role.33 Identifier for the role.
30 34
3135- `description: string` - `description: string`
32 36
33 Optional description of the role.37 Optional description of the role.
34 38
3539- `name: string` - `name: string`
36 40
37 Unique name for the role.41 Unique name for the role.
38 42
3943- `object: "role"` - `object: "role"`
40 44
41 Always `role`.45 Always `role`.
42 46
43 - `"role"`47 - `"role"`
44 48
4549- `permissions: array of string` - `permissions: array of string`
46 50
47 Permissions granted by the role.51 Permissions granted by the role.
48 52
4953- `predefined_role: boolean` - `predefined_role: boolean`
50 54
51 Whether the role is predefined and managed by OpenAI.55 Whether the role is predefined and managed by OpenAI.
52 56
5357- `resource_type: string` - `resource_type: string`
54 58
55 Resource type the role is bound to (for example `api.organization` or `api.project`).59 Resource type the role is bound to (for example `api.organization` or `api.project`).
56 60
59```http63```http
60curl https://api.openai.com/v1/projects/$PROJECT_ID/roles \64curl https://api.openai.com/v1/projects/$PROJECT_ID/roles \
61 -H 'Content-Type: application/json' \65 -H 'Content-Type: application/json' \
6266 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
63 -d '{67 -d '{
64 "permissions": [68 "permissions": [
65 "string"69 "string"
Previously: resources/organization/subresources/projects/subresources/roles/methods/delete/index.md
31```http31```http
32curl https://api.openai.com/v1/projects/$PROJECT_ID/roles/$ROLE_ID \32curl https://api.openai.com/v1/projects/$PROJECT_ID/roles/$ROLE_ID \
33 -X DELETE \33 -X DELETE \
3434 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
35```35```
36 36
37#### Response37#### Response
Previously: resources/organization/subresources/projects/subresources/roles/methods/list/index.md
28 28
29### Returns29### Returns
30 30
3131- `data: array of object { id, description, name, 4 more }`- `data: array of Role`
32 32
33 Roles returned in the current page.33 Roles returned in the current page.
34 34
80 80
81```http81```http
82curl https://api.openai.com/v1/projects/$PROJECT_ID/roles \82curl https://api.openai.com/v1/projects/$PROJECT_ID/roles \
8383 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
84```84```
85 85
86#### Response86#### Response
Previously: resources/organization/subresources/projects/subresources/roles/methods/update/index.md
26 26
27### Returns27### Returns
28 28
2929- `id: string`- `Role object { id, description, name, 4 more }`
30
31 Details about a role that can be assigned through the public Roles API.
32
33 - `id: string`
30 34
31 Identifier for the role.35 Identifier for the role.
32 36
3337- `description: string` - `description: string`
34 38
35 Optional description of the role.39 Optional description of the role.
36 40
3741- `name: string` - `name: string`
38 42
39 Unique name for the role.43 Unique name for the role.
40 44
4145- `object: "role"` - `object: "role"`
42 46
43 Always `role`.47 Always `role`.
44 48
45 - `"role"`49 - `"role"`
46 50
4751- `permissions: array of string` - `permissions: array of string`
48 52
49 Permissions granted by the role.53 Permissions granted by the role.
50 54
5155- `predefined_role: boolean` - `predefined_role: boolean`
52 56
53 Whether the role is predefined and managed by OpenAI.57 Whether the role is predefined and managed by OpenAI.
54 58
5559- `resource_type: string` - `resource_type: string`
56 60
57 Resource type the role is bound to (for example `api.organization` or `api.project`).61 Resource type the role is bound to (for example `api.organization` or `api.project`).
58 62
61```http65```http
62curl https://api.openai.com/v1/projects/$PROJECT_ID/roles/$ROLE_ID \66curl https://api.openai.com/v1/projects/$PROJECT_ID/roles/$ROLE_ID \
63 -H 'Content-Type: application/json' \67 -H 'Content-Type: application/json' \
6468 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
65 -d '{}'69 -d '{}'
66```70```
67 71
Previously: resources/organization/subresources/projects/subresources/service_accounts/index.md
64 64
65```http65```http
66curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts \66curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts \
6767 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
68```68```
69 69
70#### Response70#### Response
170```http170```http
171curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts \171curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts \
172 -H 'Content-Type: application/json' \172 -H 'Content-Type: application/json' \
173173 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
174 -d '{174 -d '{
175 "name": "name"175 "name": "name"
176 }'176 }'
273 273
274```http274```http
275curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \275curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \
276276 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
277```277```
278 278
279#### Response279#### Response
338```http338```http
339curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \339curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \
340 -X DELETE \340 -X DELETE \
341341 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
342```342```
343 343
344#### Response344#### Response
Previously: resources/organization/subresources/projects/subresources/service_accounts/methods/create/index.md
53```http53```http
54curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts \54curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts \
55 -H 'Content-Type: application/json' \55 -H 'Content-Type: application/json' \
5656 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
57 -d '{57 -d '{
58 "name": "name"58 "name": "name"
59 }'59 }'
Previously: resources/organization/subresources/projects/subresources/service_accounts/methods/delete/index.md
28```http28```http
29curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \29curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \
30 -X DELETE \30 -X DELETE \
3131 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
32```32```
33 33
34#### Response34#### Response
Previously: resources/organization/subresources/projects/subresources/service_accounts/methods/list/index.md
62 62
63```http63```http
64curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts \64curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts \
6565 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
66```66```
67 67
68#### Response68#### Response
Previously: resources/organization/subresources/projects/subresources/service_accounts/methods/retrieve/index.md
46 46
47```http47```http
48curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \48curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_accounts/$SERVICE_ACCOUNT_ID \
4949 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
50```50```
51 51
52#### Response52#### Response
Previously: resources/organization/subresources/projects/subresources/users/index.md
66 66
67```http67```http
68curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \68curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \
6969 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
70```70```
71 71
72#### Response72#### Response
184```http184```http
185curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \185curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \
186 -H 'Content-Type: application/json' \186 -H 'Content-Type: application/json' \
187187 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
188 -d '{188 -d '{
189 "role": "owner",189 "role": "owner",
190 "user_id": "user_id"190 "user_id": "user_id"
280 280
281```http281```http
282curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \282curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \
283283 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
284```284```
285 285
286#### Response286#### Response
380```http380```http
381curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \381curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \
382 -H 'Content-Type: application/json' \382 -H 'Content-Type: application/json' \
383383 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
384 -d '{384 -d '{
385 "role": "owner"385 "role": "owner"
386 }'386 }'
453```http453```http
454curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \454curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \
455 -X DELETE \455 -X DELETE \
456456 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
457```457```
458 458
459#### Response459#### Response
634 634
635```http635```http
636curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles \636curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles \
637637 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
638```638```
639 639
640#### Response640#### Response
734 734
735 - `"user.role"`735 - `"user.role"`
736 736
737737- `role: object { id, description, name, 4 more }`- `role: Role`
738 738
739 Details about a role that can be assigned through the public Roles API.739 Details about a role that can be assigned through the public Roles API.
740 740
768 768
769 Resource type the role is bound to (for example `api.organization` or `api.project`).769 Resource type the role is bound to (for example `api.organization` or `api.project`).
770 770
771771- `user: User`- `user: OrganizationUser`
772 772
773 Represents an individual `user` within an organization.773 Represents an individual `user` within an organization.
774 774
807```http807```http
808curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles \808curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles \
809 -H 'Content-Type: application/json' \809 -H 'Content-Type: application/json' \
810810 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
811 -d '{811 -d '{
812 "role_id": "role_id"812 "role_id": "role_id"
813 }'813 }'
908```http908```http
909curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles/$ROLE_ID \909curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles/$ROLE_ID \
910 -X DELETE \910 -X DELETE \
911911 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
912```912```
913 913
914#### Response914#### Response
1001 1001
1002 - `"user.role"`1002 - `"user.role"`
1003 1003
10041004 - `role: object { id, description, name, 4 more }` - `role: Role`
1005 1005
1006 Details about a role that can be assigned through the public Roles API.1006 Details about a role that can be assigned through the public Roles API.
1007 1007
1035 1035
1036 Resource type the role is bound to (for example `api.organization` or `api.project`).1036 Resource type the role is bound to (for example `api.organization` or `api.project`).
1037 1037
10381038 - `user: User` - `user: OrganizationUser`
1039 1039
1040 Represents an individual `user` within an organization.1040 Represents an individual `user` within an organization.
1041 1041
Previously: resources/organization/subresources/projects/subresources/users/methods/create/index.md
63```http63```http
64curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \64curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \
65 -H 'Content-Type: application/json' \65 -H 'Content-Type: application/json' \
6666 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
67 -d '{67 -d '{
68 "role": "owner",68 "role": "owner",
69 "user_id": "user_id"69 "user_id": "user_id"
Previously: resources/organization/subresources/projects/subresources/users/methods/delete/index.md
28```http28```http
29curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \29curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \
30 -X DELETE \30 -X DELETE \
3131 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
32```32```
33 33
34#### Response34#### Response
Previously: resources/organization/subresources/projects/subresources/users/methods/list/index.md
64 64
65```http65```http
66curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \66curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \
6767 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
68```68```
69 69
70#### Response70#### Response
Previously: resources/organization/subresources/projects/subresources/users/methods/retrieve/index.md
50 50
51```http51```http
52curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \52curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \
5353 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
54```54```
55 55
56#### Response56#### Response
Previously: resources/organization/subresources/projects/subresources/users/methods/update/index.md
61```http61```http
62curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \62curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \
63 -H 'Content-Type: application/json' \63 -H 'Content-Type: application/json' \
6464 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
65 -d '{65 -d '{
66 "role": "owner"66 "role": "owner"
67 }'67 }'
Previously: resources/organization/subresources/projects/subresources/users/subresources/roles/methods/create/index.md
24 24
25 - `"user.role"`25 - `"user.role"`
26 26
2727- `role: object { id, description, name, 4 more }`- `role: Role`
28 28
29 Details about a role that can be assigned through the public Roles API.29 Details about a role that can be assigned through the public Roles API.
30 30
58 58
59 Resource type the role is bound to (for example `api.organization` or `api.project`).59 Resource type the role is bound to (for example `api.organization` or `api.project`).
60 60
6161- `user: User`- `user: OrganizationUser`
62 62
63 Represents an individual `user` within an organization.63 Represents an individual `user` within an organization.
64 64
97```http97```http
98curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles \98curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles \
99 -H 'Content-Type: application/json' \99 -H 'Content-Type: application/json' \
100100 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
101 -d '{101 -d '{
102 "role_id": "role_id"102 "role_id": "role_id"
103 }'103 }'
Previously: resources/organization/subresources/projects/subresources/users/subresources/roles/methods/delete/index.md
27```http27```http
28curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles/$ROLE_ID \28curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles/$ROLE_ID \
29 -X DELETE \29 -X DELETE \
3030 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
31```31```
32 32
33#### Response33#### Response
Previously: resources/organization/subresources/projects/subresources/users/subresources/roles/methods/list/index.md
96 96
97```http97```http
98curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles \98curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles \
9999 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
100```100```
101 101
102#### Response102#### Response
Previously: resources/organization/subresources/roles/index.md
26 26
27### Returns27### Returns
28 28
2929- `data: array of object { id, description, name, 4 more }`- `data: array of Role`
30 30
31 Roles returned in the current page.31 Roles returned in the current page.
32 32
78 78
79```http79```http
80curl https://api.openai.com/v1/organization/roles \80curl https://api.openai.com/v1/organization/roles \
8181 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
82```82```
83 83
84#### Response84#### Response
158 158
159### Returns159### Returns
160 160
161161- `id: string`- `Role object { id, description, name, 4 more }`
162
163 Details about a role that can be assigned through the public Roles API.
164
165 - `id: string`
162 166
163 Identifier for the role.167 Identifier for the role.
164 168
165169- `description: string` - `description: string`
166 170
167 Optional description of the role.171 Optional description of the role.
168 172
169173- `name: string` - `name: string`
170 174
171 Unique name for the role.175 Unique name for the role.
172 176
173177- `object: "role"` - `object: "role"`
174 178
175 Always `role`.179 Always `role`.
176 180
177 - `"role"`181 - `"role"`
178 182
179183- `permissions: array of string` - `permissions: array of string`
180 184
181 Permissions granted by the role.185 Permissions granted by the role.
182 186
183187- `predefined_role: boolean` - `predefined_role: boolean`
184 188
185 Whether the role is predefined and managed by OpenAI.189 Whether the role is predefined and managed by OpenAI.
186 190
187191- `resource_type: string` - `resource_type: string`
188 192
189 Resource type the role is bound to (for example `api.organization` or `api.project`).193 Resource type the role is bound to (for example `api.organization` or `api.project`).
190 194
193```http197```http
194curl https://api.openai.com/v1/organization/roles \198curl https://api.openai.com/v1/organization/roles \
195 -H 'Content-Type: application/json' \199 -H 'Content-Type: application/json' \
196200 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
197 -d '{201 -d '{
198 "permissions": [202 "permissions": [
199 "string"203 "string"
277 281
278### Returns282### Returns
279 283
280284- `id: string`- `Role object { id, description, name, 4 more }`
285
286 Details about a role that can be assigned through the public Roles API.
287
288 - `id: string`
281 289
282 Identifier for the role.290 Identifier for the role.
283 291
284292- `description: string` - `description: string`
285 293
286 Optional description of the role.294 Optional description of the role.
287 295
288296- `name: string` - `name: string`
289 297
290 Unique name for the role.298 Unique name for the role.
291 299
292300- `object: "role"` - `object: "role"`
293 301
294 Always `role`.302 Always `role`.
295 303
296 - `"role"`304 - `"role"`
297 305
298306- `permissions: array of string` - `permissions: array of string`
299 307
300 Permissions granted by the role.308 Permissions granted by the role.
301 309
302310- `predefined_role: boolean` - `predefined_role: boolean`
303 311
304 Whether the role is predefined and managed by OpenAI.312 Whether the role is predefined and managed by OpenAI.
305 313
306314- `resource_type: string` - `resource_type: string`
307 315
308 Resource type the role is bound to (for example `api.organization` or `api.project`).316 Resource type the role is bound to (for example `api.organization` or `api.project`).
309 317
312```http320```http
313curl https://api.openai.com/v1/organization/roles/$ROLE_ID \321curl https://api.openai.com/v1/organization/roles/$ROLE_ID \
314 -H 'Content-Type: application/json' \322 -H 'Content-Type: application/json' \
315323 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
316 -d '{}'324 -d '{}'
317```325```
318 326
396```http404```http
397curl https://api.openai.com/v1/organization/roles/$ROLE_ID \405curl https://api.openai.com/v1/organization/roles/$ROLE_ID \
398 -X DELETE \406 -X DELETE \
399407 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
400```408```
401 409
402#### Response410#### Response
429 437
430## Domain Types438## Domain Types
431 439
432440### Role List Response### Role
433
434- `RoleListResponse object { id, description, name, 4 more }`
435
436 Details about a role that can be assigned through the public Roles API.
437
438 - `id: string`
439
440 Identifier for the role.
441
442 - `description: string`
443
444 Optional description of the role.
445
446 - `name: string`
447
448 Unique name for the role.
449
450 - `object: "role"`
451
452 Always `role`.
453
454 - `"role"`
455
456 - `permissions: array of string`
457
458 Permissions granted by the role.
459
460 - `predefined_role: boolean`
461
462 Whether the role is predefined and managed by OpenAI.
463
464 - `resource_type: string`
465
466 Resource type the role is bound to (for example `api.organization` or `api.project`).
467
468### Role Create Response
469
470- `RoleCreateResponse object { id, description, name, 4 more }`
471
472 Details about a role that can be assigned through the public Roles API.
473
474 - `id: string`
475
476 Identifier for the role.
477
478 - `description: string`
479
480 Optional description of the role.
481
482 - `name: string`
483
484 Unique name for the role.
485
486 - `object: "role"`
487
488 Always `role`.
489
490 - `"role"`
491
492 - `permissions: array of string`
493
494 Permissions granted by the role.
495
496 - `predefined_role: boolean`
497
498 Whether the role is predefined and managed by OpenAI.
499
500 - `resource_type: string`
501
502 Resource type the role is bound to (for example `api.organization` or `api.project`).
503
504### Role Update Response
505 441
506442- `RoleUpdateResponse object { id, description, name, 4 more }`- `Role object { id, description, name, 4 more }`
507 443
508 Details about a role that can be assigned through the public Roles API.444 Details about a role that can be assigned through the public Roles API.
509 445
Previously: resources/organization/subresources/roles/methods/create/index.md
20 20
21### Returns21### Returns
22 22
2323- `id: string`- `Role object { id, description, name, 4 more }`
24
25 Details about a role that can be assigned through the public Roles API.
26
27 - `id: string`
24 28
25 Identifier for the role.29 Identifier for the role.
26 30
2731- `description: string` - `description: string`
28 32
29 Optional description of the role.33 Optional description of the role.
30 34
3135- `name: string` - `name: string`
32 36
33 Unique name for the role.37 Unique name for the role.
34 38
3539- `object: "role"` - `object: "role"`
36 40
37 Always `role`.41 Always `role`.
38 42
39 - `"role"`43 - `"role"`
40 44
4145- `permissions: array of string` - `permissions: array of string`
42 46
43 Permissions granted by the role.47 Permissions granted by the role.
44 48
4549- `predefined_role: boolean` - `predefined_role: boolean`
46 50
47 Whether the role is predefined and managed by OpenAI.51 Whether the role is predefined and managed by OpenAI.
48 52
4953- `resource_type: string` - `resource_type: string`
50 54
51 Resource type the role is bound to (for example `api.organization` or `api.project`).55 Resource type the role is bound to (for example `api.organization` or `api.project`).
52 56
55```http59```http
56curl https://api.openai.com/v1/organization/roles \60curl https://api.openai.com/v1/organization/roles \
57 -H 'Content-Type: application/json' \61 -H 'Content-Type: application/json' \
5862 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
59 -d '{63 -d '{
60 "permissions": [64 "permissions": [
61 "string"65 "string"
Previously: resources/organization/subresources/roles/methods/delete/index.md
29```http29```http
30curl https://api.openai.com/v1/organization/roles/$ROLE_ID \30curl https://api.openai.com/v1/organization/roles/$ROLE_ID \
31 -X DELETE \31 -X DELETE \
3232 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
33```33```
34 34
35#### Response35#### Response
Previously: resources/organization/subresources/roles/methods/list/index.md
24 24
25### Returns25### Returns
26 26
2727- `data: array of object { id, description, name, 4 more }`- `data: array of Role`
28 28
29 Roles returned in the current page.29 Roles returned in the current page.
30 30
76 76
77```http77```http
78curl https://api.openai.com/v1/organization/roles \78curl https://api.openai.com/v1/organization/roles \
7979 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
80```80```
81 81
82#### Response82#### Response
Previously: resources/organization/subresources/roles/methods/update/index.md
24 24
25### Returns25### Returns
26 26
2727- `id: string`- `Role object { id, description, name, 4 more }`
28
29 Details about a role that can be assigned through the public Roles API.
30
31 - `id: string`
28 32
29 Identifier for the role.33 Identifier for the role.
30 34
3135- `description: string` - `description: string`
32 36
33 Optional description of the role.37 Optional description of the role.
34 38
3539- `name: string` - `name: string`
36 40
37 Unique name for the role.41 Unique name for the role.
38 42
3943- `object: "role"` - `object: "role"`
40 44
41 Always `role`.45 Always `role`.
42 46
43 - `"role"`47 - `"role"`
44 48
4549- `permissions: array of string` - `permissions: array of string`
46 50
47 Permissions granted by the role.51 Permissions granted by the role.
48 52
4953- `predefined_role: boolean` - `predefined_role: boolean`
50 54
51 Whether the role is predefined and managed by OpenAI.55 Whether the role is predefined and managed by OpenAI.
52 56
5357- `resource_type: string` - `resource_type: string`
54 58
55 Resource type the role is bound to (for example `api.organization` or `api.project`).59 Resource type the role is bound to (for example `api.organization` or `api.project`).
56 60
59```http63```http
60curl https://api.openai.com/v1/organization/roles/$ROLE_ID \64curl https://api.openai.com/v1/organization/roles/$ROLE_ID \
61 -H 'Content-Type: application/json' \65 -H 'Content-Type: application/json' \
6266 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
63 -d '{}'67 -d '{}'
64```68```
65 69
Previously: resources/organization/subresources/usage/index.md
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, line_item, project_id }` - `CostsResult 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
354 354
355 The numeric value of the cost.355 The numeric value of the cost.
356 356
357 - `api_key_id: optional string`
358
359 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
360
357 - `line_item: optional string`361 - `line_item: optional string`
358 362
359 When `group_by=line_item`, this field provides the line item of the grouped costs result.363 When `group_by=line_item`, this field provides the line item of the grouped costs result.
376 380
377```http381```http
378curl https://api.openai.com/v1/organization/usage/audio_speeches \382curl https://api.openai.com/v1/organization/usage/audio_speeches \
379383 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
380```384```
381 385
382#### Response386#### Response
783 787
784 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.
785 789
786790 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
787 791
788 The aggregated costs details of the specific time bucket.792 The aggregated costs details of the specific time bucket.
789 793
803 807
804 The numeric value of the cost.808 The numeric value of the cost.
805 809
810 - `api_key_id: optional string`
811
812 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
813
806 - `line_item: optional string`814 - `line_item: optional string`
807 815
808 When `group_by=line_item`, this field provides the line item of the grouped costs result.816 When `group_by=line_item`, this field provides the line item of the grouped costs result.
825 833
826```http834```http
827curl https://api.openai.com/v1/organization/usage/audio_transcriptions \835curl https://api.openai.com/v1/organization/usage/audio_transcriptions \
828836 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
829```837```
830 838
831#### Response839#### Response
1214 1222
1215 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.
1216 1224
12171225 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
1218 1226
1219 The aggregated costs details of the specific time bucket.1227 The aggregated costs details of the specific time bucket.
1220 1228
1234 1242
1235 The numeric value of the cost.1243 The numeric value of the cost.
1236 1244
1245 - `api_key_id: optional string`
1246
1247 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
1248
1237 - `line_item: optional string`1249 - `line_item: optional string`
1238 1250
1239 When `group_by=line_item`, this field provides the line item of the grouped costs result.1251 When `group_by=line_item`, this field provides the line item of the grouped costs result.
1256 1268
1257```http1269```http
1258curl https://api.openai.com/v1/organization/usage/code_interpreter_sessions \1270curl https://api.openai.com/v1/organization/usage/code_interpreter_sessions \
12591271 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
1260```1272```
1261 1273
1262#### Response1274#### Response
1667 1679
1668 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.
1669 1681
16701682 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
1671 1683
1672 The aggregated costs details of the specific time bucket.1684 The aggregated costs details of the specific time bucket.
1673 1685
1687 1699
1688 The numeric value of the cost.1700 The numeric value of the cost.
1689 1701
1702 - `api_key_id: optional string`
1703
1704 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
1705
1690 - `line_item: optional string`1706 - `line_item: optional string`
1691 1707
1692 When `group_by=line_item`, this field provides the line item of the grouped costs result.1708 When `group_by=line_item`, this field provides the line item of the grouped costs result.
1709 1725
1710```http1726```http
1711curl https://api.openai.com/v1/organization/usage/completions \1727curl https://api.openai.com/v1/organization/usage/completions \
17121728 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
1713```1729```
1714 1730
1715#### Response1731#### Response
2122 2138
2123 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.
2124 2140
21252141 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
2126 2142
2127 The aggregated costs details of the specific time bucket.2143 The aggregated costs details of the specific time bucket.
2128 2144
2142 2158
2143 The numeric value of the cost.2159 The numeric value of the cost.
2144 2160
2161 - `api_key_id: optional string`
2162
2163 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
2164
2145 - `line_item: optional string`2165 - `line_item: optional string`
2146 2166
2147 When `group_by=line_item`, this field provides the line item of the grouped costs result.2167 When `group_by=line_item`, this field provides the line item of the grouped costs result.
2164 2184
2165```http2185```http
2166curl https://api.openai.com/v1/organization/usage/embeddings \2186curl https://api.openai.com/v1/organization/usage/embeddings \
21672187 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
2168```2188```
2169 2189
2170#### Response2190#### Response
2599 2619
2600 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.
2601 2621
26022622 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
2603 2623
2604 The aggregated costs details of the specific time bucket.2624 The aggregated costs details of the specific time bucket.
2605 2625
2619 2639
2620 The numeric value of the cost.2640 The numeric value of the cost.
2621 2641
2642 - `api_key_id: optional string`
2643
2644 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
2645
2622 - `line_item: optional string`2646 - `line_item: optional string`
2623 2647
2624 When `group_by=line_item`, this field provides the line item of the grouped costs result.2648 When `group_by=line_item`, this field provides the line item of the grouped costs result.
2641 2665
2642```http2666```http
2643curl https://api.openai.com/v1/organization/usage/images \2667curl https://api.openai.com/v1/organization/usage/images \
26442668 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
2645```2669```
2646 2670
2647#### Response2671#### Response
3050 3074
3051 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.
3052 3076
30533077 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
3054 3078
3055 The aggregated costs details of the specific time bucket.3079 The aggregated costs details of the specific time bucket.
3056 3080
3070 3094
3071 The numeric value of the cost.3095 The numeric value of the cost.
3072 3096
3097 - `api_key_id: optional string`
3098
3099 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
3100
3073 - `line_item: optional string`3101 - `line_item: optional string`
3074 3102
3075 When `group_by=line_item`, this field provides the line item of the grouped costs result.3103 When `group_by=line_item`, this field provides the line item of the grouped costs result.
3092 3120
3093```http3121```http
3094curl https://api.openai.com/v1/organization/usage/moderations \3122curl https://api.openai.com/v1/organization/usage/moderations \
30953123 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
3096```3124```
3097 3125
3098#### Response3126#### Response
3481 3509
3482 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.
3483 3511
34843512 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
3485 3513
3486 The aggregated costs details of the specific time bucket.3514 The aggregated costs details of the specific time bucket.
3487 3515
3501 3529
3502 The numeric value of the cost.3530 The numeric value of the cost.
3503 3531
3532 - `api_key_id: optional string`
3533
3534 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
3535
3504 - `line_item: optional string`3536 - `line_item: optional string`
3505 3537
3506 When `group_by=line_item`, this field provides the line item of the grouped costs result.3538 When `group_by=line_item`, this field provides the line item of the grouped costs result.
3523 3555
3524```http3556```http
3525curl https://api.openai.com/v1/organization/usage/vector_stores \3557curl https://api.openai.com/v1/organization/usage/vector_stores \
35263558 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
3527```3559```
3528 3560
3529#### Response3561#### Response
3592}3624}
3593```3625```
3594 3626
35953627## Domain Types## Costs
3596 3628
35973629### Usage Get Audio Speeches Response**get** `/organization/costs`
3598 3630
35993631- `UsageGetAudioSpeechesResponse object { data, has_more, next_page, object }`Get costs details for the organization.
3600 3632
36013633 - `data: array of object { end_time, object, result, start_time }`### Query Parameters
3634
3635- `start_time: number`
3636
3637 Start time (Unix seconds) of the query time range, inclusive.
3638
3639- `api_key_ids: optional array of string`
3640
3641 Return only costs for these API keys.
3642
3643- `bucket_width: optional "1d"`
3644
3645 Width of each time bucket in response. Currently only `1d` is supported, default to `1d`.
3646
3647 - `"1d"`
3648
3649- `end_time: optional number`
3650
3651 End time (Unix seconds) of the query time range, exclusive.
3652
3653- `group_by: optional array of "project_id" or "line_item" or "api_key_id"`
3654
3655 Group the costs by the specified fields. Support fields include `project_id`, `line_item`, `api_key_id` and any combination of them.
3656
3657 - `"project_id"`
3658
3659 - `"line_item"`
3660
3661 - `"api_key_id"`
3662
3663- `limit: optional number`
3664
3665 A limit on the number of buckets to be returned. Limit can range between 1 and 180, and the default is 7.
3666
3667- `page: optional string`
3668
3669 A cursor for use in pagination. Corresponding to the `next_page` field from the previous response.
3670
3671- `project_ids: optional array of string`
3672
3673 Return only costs for these projects.
3674
3675### Returns
3676
3677- `data: array of object { end_time, object, result, start_time }`
3602 3678
3603 - `end_time: number`3679 - `end_time: number`
3604 3680
3864 3940
3865 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.
3866 3942
38673943 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
3868 3944
3869 The aggregated costs details of the specific time bucket.3945 The aggregated costs details of the specific time bucket.
3870 3946
3884 3960
3885 The numeric value of the cost.3961 The numeric value of the cost.
3886 3962
3963 - `api_key_id: optional string`
3964
3965 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
3966
3887 - `line_item: optional string`3967 - `line_item: optional string`
3888 3968
3889 When `group_by=line_item`, this field provides the line item of the grouped costs result.3969 When `group_by=line_item`, this field provides the line item of the grouped costs result.
3894 3974
3895 - `start_time: number`3975 - `start_time: number`
3896 3976
38973977 - `has_more: boolean`- `has_more: boolean`
3898 3978
38993979 - `next_page: string`- `next_page: string`
3900 3980
39013981 - `object: "page"`- `object: "page"`
3902 3982
3903 - `"page"`3983 - `"page"`
3904 3984
39053985### Usage Get Audio Transcriptions Response### Example
3986
3987```http
3988curl https://api.openai.com/v1/organization/costs \
3989 -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
3990```
3991
3992#### Response
3993
3994```json
3995{
3996 "data": [
3997 {
3998 "end_time": 0,
3999 "object": "bucket",
4000 "result": [
4001 {
4002 "input_tokens": 0,
4003 "num_model_requests": 0,
4004 "object": "organization.usage.completions.result",
4005 "output_tokens": 0,
4006 "api_key_id": "api_key_id",
4007 "batch": true,
4008 "input_audio_tokens": 0,
4009 "input_cached_tokens": 0,
4010 "model": "model",
4011 "output_audio_tokens": 0,
4012 "project_id": "project_id",
4013 "service_tier": "service_tier",
4014 "user_id": "user_id"
4015 }
4016 ],
4017 "start_time": 0
4018 }
4019 ],
4020 "has_more": true,
4021 "next_page": "next_page",
4022 "object": "page"
4023}
4024```
4025
4026### Example
4027
4028```http
4029curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1" \
4030-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
4031-H "Content-Type: application/json"
4032```
4033
4034#### Response
4035
4036```json
4037{
4038 "object": "page",
4039 "data": [
4040 {
4041 "object": "bucket",
4042 "start_time": 1730419200,
4043 "end_time": 1730505600,
4044 "results": [
4045 {
4046 "object": "organization.costs.result",
4047 "amount": {
4048 "value": 0.06,
4049 "currency": "usd"
4050 },
4051 "line_item": null,
4052 "project_id": null,
4053 "api_key_id": null
4054 }
4055 ]
4056 }
4057 ],
4058 "has_more": false,
4059 "next_page": null
4060}
4061```
4062
4063## Domain Types
4064
4065### Usage Audio Speeches Response
3906 4066
39074067- `UsageGetAudioTranscriptionsResponse object { data, has_more, next_page, object }`- `UsageAudioSpeechesResponse object { data, has_more, next_page, object }`
3908 4068
3909 - `data: array of object { end_time, object, result, start_time }`4069 - `data: array of object { end_time, object, result, start_time }`
3910 4070
4172 4332
4173 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.
4174 4334
41754335 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
4176 4336
4177 The aggregated costs details of the specific time bucket.4337 The aggregated costs details of the specific time bucket.
4178 4338
4192 4352
4193 The numeric value of the cost.4353 The numeric value of the cost.
4194 4354
4355 - `api_key_id: optional string`
4356
4357 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
4358
4195 - `line_item: optional string`4359 - `line_item: optional string`
4196 4360
4197 When `group_by=line_item`, this field provides the line item of the grouped costs result.4361 When `group_by=line_item`, this field provides the line item of the grouped costs result.
4210 4374
4211 - `"page"`4375 - `"page"`
4212 4376
42134377### Usage Get Code Interpreter Sessions Response### Usage Audio Transcriptions Response
4214 4378
42154379- `UsageGetCodeInterpreterSessionsResponse object { data, has_more, next_page, object }`- `UsageAudioTranscriptionsResponse object { data, has_more, next_page, object }`
4216 4380
4217 - `data: array of object { end_time, object, result, start_time }`4381 - `data: array of object { end_time, object, result, start_time }`
4218 4382
4480 4644
4481 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.
4482 4646
44834647 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
4484 4648
4485 The aggregated costs details of the specific time bucket.4649 The aggregated costs details of the specific time bucket.
4486 4650
4500 4664
4501 The numeric value of the cost.4665 The numeric value of the cost.
4502 4666
4667 - `api_key_id: optional string`
4668
4669 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
4670
4503 - `line_item: optional string`4671 - `line_item: optional string`
4504 4672
4505 When `group_by=line_item`, this field provides the line item of the grouped costs result.4673 When `group_by=line_item`, this field provides the line item of the grouped costs result.
4518 4686
4519 - `"page"`4687 - `"page"`
4520 4688
45214689### Usage Get Completions Response### Usage Code Interpreter Sessions Response
4522 4690
45234691- `UsageGetCompletionsResponse object { data, has_more, next_page, object }`- `UsageCodeInterpreterSessionsResponse object { data, has_more, next_page, object }`
4524 4692
4525 - `data: array of object { end_time, object, result, start_time }`4693 - `data: array of object { end_time, object, result, start_time }`
4526 4694
4788 4956
4789 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.
4790 4958
47914959 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
4792 4960
4793 The aggregated costs details of the specific time bucket.4961 The aggregated costs details of the specific time bucket.
4794 4962
4808 4976
4809 The numeric value of the cost.4977 The numeric value of the cost.
4810 4978
4979 - `api_key_id: optional string`
4980
4981 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
4982
4811 - `line_item: optional string`4983 - `line_item: optional string`
4812 4984
4813 When `group_by=line_item`, this field provides the line item of the grouped costs result.4985 When `group_by=line_item`, this field provides the line item of the grouped costs result.
4826 4998
4827 - `"page"`4999 - `"page"`
4828 5000
48295001### Usage Get Embeddings Response### Usage Completions Response
4830 5002
48315003- `UsageGetEmbeddingsResponse object { data, has_more, next_page, object }`- `UsageCompletionsResponse object { data, has_more, next_page, object }`
4832 5004
4833 - `data: array of object { end_time, object, result, start_time }`5005 - `data: array of object { end_time, object, result, start_time }`
4834 5006
5096 5268
5097 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.
5098 5270
50995271 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
5100 5272
5101 The aggregated costs details of the specific time bucket.5273 The aggregated costs details of the specific time bucket.
5102 5274
5116 5288
5117 The numeric value of the cost.5289 The numeric value of the cost.
5118 5290
5291 - `api_key_id: optional string`
5292
5293 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
5294
5119 - `line_item: optional string`5295 - `line_item: optional string`
5120 5296
5121 When `group_by=line_item`, this field provides the line item of the grouped costs result.5297 When `group_by=line_item`, this field provides the line item of the grouped costs result.
5134 5310
5135 - `"page"`5311 - `"page"`
5136 5312
51375313### Usage Get Images Response### Usage Embeddings Response
5138 5314
51395315- `UsageGetImagesResponse object { data, has_more, next_page, object }`- `UsageEmbeddingsResponse object { data, has_more, next_page, object }`
5140 5316
5141 - `data: array of object { end_time, object, result, start_time }`5317 - `data: array of object { end_time, object, result, start_time }`
5142 5318
5404 5580
5405 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.
5406 5582
54075583 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
5408 5584
5409 The aggregated costs details of the specific time bucket.5585 The aggregated costs details of the specific time bucket.
5410 5586
5424 5600
5425 The numeric value of the cost.5601 The numeric value of the cost.
5426 5602
5603 - `api_key_id: optional string`
5604
5605 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
5606
5427 - `line_item: optional string`5607 - `line_item: optional string`
5428 5608
5429 When `group_by=line_item`, this field provides the line item of the grouped costs result.5609 When `group_by=line_item`, this field provides the line item of the grouped costs result.
5442 5622
5443 - `"page"`5623 - `"page"`
5444 5624
54455625### Usage Get Moderations Response### Usage Images Response
5446 5626
54475627- `UsageGetModerationsResponse object { data, has_more, next_page, object }`- `UsageImagesResponse object { data, has_more, next_page, object }`
5448 5628
5449 - `data: array of object { end_time, object, result, start_time }`5629 - `data: array of object { end_time, object, result, start_time }`
5450 5630
5712 5892
5713 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.
5714 5894
57155895 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
5716 5896
5717 The aggregated costs details of the specific time bucket.5897 The aggregated costs details of the specific time bucket.
5718 5898
5732 5912
5733 The numeric value of the cost.5913 The numeric value of the cost.
5734 5914
5915 - `api_key_id: optional string`
5916
5917 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
5918
5735 - `line_item: optional string`5919 - `line_item: optional string`
5736 5920
5737 When `group_by=line_item`, this field provides the line item of the grouped costs result.5921 When `group_by=line_item`, this field provides the line item of the grouped costs result.
5750 5934
5751 - `"page"`5935 - `"page"`
5752 5936
57535937### Usage Get Vector Stores Response### Usage Moderations Response
5754 5938
57555939- `UsageGetVectorStoresResponse object { data, has_more, next_page, object }`- `UsageModerationsResponse object { data, has_more, next_page, object }`
5756 5940
5757 - `data: array of object { end_time, object, result, start_time }`5941 - `data: array of object { end_time, object, result, start_time }`
5758 5942
6020 6204
6021 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.
6022 6206
60236207 - `CostsResult object { object, amount, line_item, project_id }` - `CostsResult object { object, amount, api_key_id, 2 more }`
6024 6208
6025 The aggregated costs details of the specific time bucket.6209 The aggregated costs details of the specific time bucket.
6026 6210
6040 6224
6041 The numeric value of the cost.6225 The numeric value of the cost.
6042 6226
6227 - `api_key_id: optional string`
6228
6229 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
6230
6231 - `line_item: optional string`
6232
6233 When `group_by=line_item`, this field provides the line item of the grouped costs result.
6234
6235 - `project_id: optional string`
6236
6237 When `group_by=project_id`, this field provides the project ID of the grouped costs result.
6238
6239 - `start_time: number`
6240
6241 - `has_more: boolean`
6242
6243 - `next_page: string`
6244
6245 - `object: "page"`
6246
6247 - `"page"`
6248
6249### Usage Vector Stores Response
6250
6251- `UsageVectorStoresResponse object { data, has_more, next_page, object }`
6252
6253 - `data: array of object { end_time, object, result, start_time }`
6254
6255 - `end_time: number`
6256
6257 - `object: "bucket"`
6258
6259 - `"bucket"`
6260
6261 - `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`
6262
6263 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
6264
6265 The aggregated completions usage details of the specific time bucket.
6266
6267 - `input_tokens: number`
6268
6269 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.
6270
6271 - `num_model_requests: number`
6272
6273 The count of requests made to the model.
6274
6275 - `object: "organization.usage.completions.result"`
6276
6277 - `"organization.usage.completions.result"`
6278
6279 - `output_tokens: number`
6280
6281 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.
6282
6283 - `api_key_id: optional string`
6284
6285 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
6286
6287 - `batch: optional boolean`
6288
6289 When `group_by=batch`, this field tells whether the grouped usage result is batch or not.
6290
6291 - `input_audio_tokens: optional number`
6292
6293 The aggregated number of audio input tokens used, including cached tokens.
6294
6295 - `input_cached_tokens: optional number`
6296
6297 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.
6298
6299 - `model: optional string`
6300
6301 When `group_by=model`, this field provides the model name of the grouped usage result.
6302
6303 - `output_audio_tokens: optional number`
6304
6305 The aggregated number of audio output tokens used.
6306
6307 - `project_id: optional string`
6308
6309 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6310
6311 - `service_tier: optional string`
6312
6313 When `group_by=service_tier`, this field provides the service tier of the grouped usage result.
6314
6315 - `user_id: optional string`
6316
6317 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6318
6319 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
6320
6321 The aggregated embeddings usage details of the specific time bucket.
6322
6323 - `input_tokens: number`
6324
6325 The aggregated number of input tokens used.
6326
6327 - `num_model_requests: number`
6328
6329 The count of requests made to the model.
6330
6331 - `object: "organization.usage.embeddings.result"`
6332
6333 - `"organization.usage.embeddings.result"`
6334
6335 - `api_key_id: optional string`
6336
6337 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
6338
6339 - `model: optional string`
6340
6341 When `group_by=model`, this field provides the model name of the grouped usage result.
6342
6343 - `project_id: optional string`
6344
6345 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6346
6347 - `user_id: optional string`
6348
6349 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6350
6351 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
6352
6353 The aggregated moderations usage details of the specific time bucket.
6354
6355 - `input_tokens: number`
6356
6357 The aggregated number of input tokens used.
6358
6359 - `num_model_requests: number`
6360
6361 The count of requests made to the model.
6362
6363 - `object: "organization.usage.moderations.result"`
6364
6365 - `"organization.usage.moderations.result"`
6366
6367 - `api_key_id: optional string`
6368
6369 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
6370
6371 - `model: optional string`
6372
6373 When `group_by=model`, this field provides the model name of the grouped usage result.
6374
6375 - `project_id: optional string`
6376
6377 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6378
6379 - `user_id: optional string`
6380
6381 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6382
6383 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`
6384
6385 The aggregated images usage details of the specific time bucket.
6386
6387 - `images: number`
6388
6389 The number of images processed.
6390
6391 - `num_model_requests: number`
6392
6393 The count of requests made to the model.
6394
6395 - `object: "organization.usage.images.result"`
6396
6397 - `"organization.usage.images.result"`
6398
6399 - `api_key_id: optional string`
6400
6401 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
6402
6403 - `model: optional string`
6404
6405 When `group_by=model`, this field provides the model name of the grouped usage result.
6406
6407 - `project_id: optional string`
6408
6409 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6410
6411 - `size: optional string`
6412
6413 When `group_by=size`, this field provides the image size of the grouped usage result.
6414
6415 - `source: optional string`
6416
6417 When `group_by=source`, this field provides the source of the grouped usage result, possible values are `image.generation`, `image.edit`, `image.variation`.
6418
6419 - `user_id: optional string`
6420
6421 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6422
6423 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
6424
6425 The aggregated audio speeches usage details of the specific time bucket.
6426
6427 - `characters: number`
6428
6429 The number of characters processed.
6430
6431 - `num_model_requests: number`
6432
6433 The count of requests made to the model.
6434
6435 - `object: "organization.usage.audio_speeches.result"`
6436
6437 - `"organization.usage.audio_speeches.result"`
6438
6439 - `api_key_id: optional string`
6440
6441 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
6442
6443 - `model: optional string`
6444
6445 When `group_by=model`, this field provides the model name of the grouped usage result.
6446
6447 - `project_id: optional string`
6448
6449 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6450
6451 - `user_id: optional string`
6452
6453 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6454
6455 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
6456
6457 The aggregated audio transcriptions usage details of the specific time bucket.
6458
6459 - `num_model_requests: number`
6460
6461 The count of requests made to the model.
6462
6463 - `object: "organization.usage.audio_transcriptions.result"`
6464
6465 - `"organization.usage.audio_transcriptions.result"`
6466
6467 - `seconds: number`
6468
6469 The number of seconds processed.
6470
6471 - `api_key_id: optional string`
6472
6473 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
6474
6475 - `model: optional string`
6476
6477 When `group_by=model`, this field provides the model name of the grouped usage result.
6478
6479 - `project_id: optional string`
6480
6481 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6482
6483 - `user_id: optional string`
6484
6485 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6486
6487 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`
6488
6489 The aggregated vector stores usage details of the specific time bucket.
6490
6491 - `object: "organization.usage.vector_stores.result"`
6492
6493 - `"organization.usage.vector_stores.result"`
6494
6495 - `usage_bytes: number`
6496
6497 The vector stores usage in bytes.
6498
6499 - `project_id: optional string`
6500
6501 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6502
6503 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`
6504
6505 The aggregated code interpreter sessions usage details of the specific time bucket.
6506
6507 - `object: "organization.usage.code_interpreter_sessions.result"`
6508
6509 - `"organization.usage.code_interpreter_sessions.result"`
6510
6511 - `num_sessions: optional number`
6512
6513 The number of code interpreter sessions.
6514
6515 - `project_id: optional string`
6516
6517 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6518
6519 - `CostsResult object { object, amount, api_key_id, 2 more }`
6520
6521 The aggregated costs details of the specific time bucket.
6522
6523 - `object: "organization.costs.result"`
6524
6525 - `"organization.costs.result"`
6526
6527 - `amount: optional object { currency, value }`
6528
6529 The monetary value in its associated currency.
6530
6531 - `currency: optional string`
6532
6533 Lowercase ISO-4217 currency e.g. "usd"
6534
6535 - `value: optional number`
6536
6537 The numeric value of the cost.
6538
6539 - `api_key_id: optional string`
6540
6541 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
6542
6543 - `line_item: optional string`
6544
6545 When `group_by=line_item`, this field provides the line item of the grouped costs result.
6546
6547 - `project_id: optional string`
6548
6549 When `group_by=project_id`, this field provides the project ID of the grouped costs result.
6550
6551 - `start_time: number`
6552
6553 - `has_more: boolean`
6554
6555 - `next_page: string`
6556
6557 - `object: "page"`
6558
6559 - `"page"`
6560
6561### Usage Costs Response
6562
6563- `UsageCostsResponse object { data, has_more, next_page, object }`
6564
6565 - `data: array of object { end_time, object, result, start_time }`
6566
6567 - `end_time: number`
6568
6569 - `object: "bucket"`
6570
6571 - `"bucket"`
6572
6573 - `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`
6574
6575 - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }`
6576
6577 The aggregated completions usage details of the specific time bucket.
6578
6579 - `input_tokens: number`
6580
6581 The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.
6582
6583 - `num_model_requests: number`
6584
6585 The count of requests made to the model.
6586
6587 - `object: "organization.usage.completions.result"`
6588
6589 - `"organization.usage.completions.result"`
6590
6591 - `output_tokens: number`
6592
6593 The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.
6594
6595 - `api_key_id: optional string`
6596
6597 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
6598
6599 - `batch: optional boolean`
6600
6601 When `group_by=batch`, this field tells whether the grouped usage result is batch or not.
6602
6603 - `input_audio_tokens: optional number`
6604
6605 The aggregated number of audio input tokens used, including cached tokens.
6606
6607 - `input_cached_tokens: optional number`
6608
6609 The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.
6610
6611 - `model: optional string`
6612
6613 When `group_by=model`, this field provides the model name of the grouped usage result.
6614
6615 - `output_audio_tokens: optional number`
6616
6617 The aggregated number of audio output tokens used.
6618
6619 - `project_id: optional string`
6620
6621 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6622
6623 - `service_tier: optional string`
6624
6625 When `group_by=service_tier`, this field provides the service tier of the grouped usage result.
6626
6627 - `user_id: optional string`
6628
6629 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6630
6631 - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }`
6632
6633 The aggregated embeddings usage details of the specific time bucket.
6634
6635 - `input_tokens: number`
6636
6637 The aggregated number of input tokens used.
6638
6639 - `num_model_requests: number`
6640
6641 The count of requests made to the model.
6642
6643 - `object: "organization.usage.embeddings.result"`
6644
6645 - `"organization.usage.embeddings.result"`
6646
6647 - `api_key_id: optional string`
6648
6649 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
6650
6651 - `model: optional string`
6652
6653 When `group_by=model`, this field provides the model name of the grouped usage result.
6654
6655 - `project_id: optional string`
6656
6657 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6658
6659 - `user_id: optional string`
6660
6661 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6662
6663 - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }`
6664
6665 The aggregated moderations usage details of the specific time bucket.
6666
6667 - `input_tokens: number`
6668
6669 The aggregated number of input tokens used.
6670
6671 - `num_model_requests: number`
6672
6673 The count of requests made to the model.
6674
6675 - `object: "organization.usage.moderations.result"`
6676
6677 - `"organization.usage.moderations.result"`
6678
6679 - `api_key_id: optional string`
6680
6681 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
6682
6683 - `model: optional string`
6684
6685 When `group_by=model`, this field provides the model name of the grouped usage result.
6686
6687 - `project_id: optional string`
6688
6689 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6690
6691 - `user_id: optional string`
6692
6693 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6694
6695 - `UsageImagesResult object { images, num_model_requests, object, 6 more }`
6696
6697 The aggregated images usage details of the specific time bucket.
6698
6699 - `images: number`
6700
6701 The number of images processed.
6702
6703 - `num_model_requests: number`
6704
6705 The count of requests made to the model.
6706
6707 - `object: "organization.usage.images.result"`
6708
6709 - `"organization.usage.images.result"`
6710
6711 - `api_key_id: optional string`
6712
6713 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
6714
6715 - `model: optional string`
6716
6717 When `group_by=model`, this field provides the model name of the grouped usage result.
6718
6719 - `project_id: optional string`
6720
6721 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6722
6723 - `size: optional string`
6724
6725 When `group_by=size`, this field provides the image size of the grouped usage result.
6726
6727 - `source: optional string`
6728
6729 When `group_by=source`, this field provides the source of the grouped usage result, possible values are `image.generation`, `image.edit`, `image.variation`.
6730
6731 - `user_id: optional string`
6732
6733 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6734
6735 - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }`
6736
6737 The aggregated audio speeches usage details of the specific time bucket.
6738
6739 - `characters: number`
6740
6741 The number of characters processed.
6742
6743 - `num_model_requests: number`
6744
6745 The count of requests made to the model.
6746
6747 - `object: "organization.usage.audio_speeches.result"`
6748
6749 - `"organization.usage.audio_speeches.result"`
6750
6751 - `api_key_id: optional string`
6752
6753 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
6754
6755 - `model: optional string`
6756
6757 When `group_by=model`, this field provides the model name of the grouped usage result.
6758
6759 - `project_id: optional string`
6760
6761 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6762
6763 - `user_id: optional string`
6764
6765 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6766
6767 - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }`
6768
6769 The aggregated audio transcriptions usage details of the specific time bucket.
6770
6771 - `num_model_requests: number`
6772
6773 The count of requests made to the model.
6774
6775 - `object: "organization.usage.audio_transcriptions.result"`
6776
6777 - `"organization.usage.audio_transcriptions.result"`
6778
6779 - `seconds: number`
6780
6781 The number of seconds processed.
6782
6783 - `api_key_id: optional string`
6784
6785 When `group_by=api_key_id`, this field provides the API key ID of the grouped usage result.
6786
6787 - `model: optional string`
6788
6789 When `group_by=model`, this field provides the model name of the grouped usage result.
6790
6791 - `project_id: optional string`
6792
6793 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6794
6795 - `user_id: optional string`
6796
6797 When `group_by=user_id`, this field provides the user ID of the grouped usage result.
6798
6799 - `UsageVectorStoresResult object { object, usage_bytes, project_id }`
6800
6801 The aggregated vector stores usage details of the specific time bucket.
6802
6803 - `object: "organization.usage.vector_stores.result"`
6804
6805 - `"organization.usage.vector_stores.result"`
6806
6807 - `usage_bytes: number`
6808
6809 The vector stores usage in bytes.
6810
6811 - `project_id: optional string`
6812
6813 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6814
6815 - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }`
6816
6817 The aggregated code interpreter sessions usage details of the specific time bucket.
6818
6819 - `object: "organization.usage.code_interpreter_sessions.result"`
6820
6821 - `"organization.usage.code_interpreter_sessions.result"`
6822
6823 - `num_sessions: optional number`
6824
6825 The number of code interpreter sessions.
6826
6827 - `project_id: optional string`
6828
6829 When `group_by=project_id`, this field provides the project ID of the grouped usage result.
6830
6831 - `CostsResult object { object, amount, api_key_id, 2 more }`
6832
6833 The aggregated costs details of the specific time bucket.
6834
6835 - `object: "organization.costs.result"`
6836
6837 - `"organization.costs.result"`
6838
6839 - `amount: optional object { currency, value }`
6840
6841 The monetary value in its associated currency.
6842
6843 - `currency: optional string`
6844
6845 Lowercase ISO-4217 currency e.g. "usd"
6846
6847 - `value: optional number`
6848
6849 The numeric value of the cost.
6850
6851 - `api_key_id: optional string`
6852
6853 When `group_by=api_key_id`, this field provides the API Key ID of the grouped costs result.
6854
6043 - `line_item: optional string`6855 - `line_item: optional string`
6044 6856
6045 When `group_by=line_item`, this field provides the line item of the grouped costs result.6857 When `group_by=line_item`, this field provides the line item of the grouped costs result.
Previously: resources/organization/subresources/users/index.md
22 22
23### Returns23### Returns
24 24
2525- `data: array of User`- `data: array of OrganizationUser`
26 26
27 - `id: string`27 - `id: string`
28 28
68 68
69```http69```http
70curl https://api.openai.com/v1/organization/users \70curl https://api.openai.com/v1/organization/users \
7171 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
72```72```
73 73
74#### Response74#### Response
133 133
134### Returns134### Returns
135 135
136136- `User object { id, added_at, email, 3 more }`- `OrganizationUser object { id, added_at, email, 3 more }`
137 137
138 Represents an individual `user` within an organization.138 Represents an individual `user` within an organization.
139 139
171 171
172```http172```http
173curl https://api.openai.com/v1/organization/users/$USER_ID \173curl https://api.openai.com/v1/organization/users/$USER_ID \
174174 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
175```175```
176 176
177#### Response177#### Response
230 230
231### Returns231### Returns
232 232
233233- `User object { id, added_at, email, 3 more }`- `OrganizationUser object { id, added_at, email, 3 more }`
234 234
235 Represents an individual `user` within an organization.235 Represents an individual `user` within an organization.
236 236
269```http269```http
270curl https://api.openai.com/v1/organization/users/$USER_ID \270curl https://api.openai.com/v1/organization/users/$USER_ID \
271 -H 'Content-Type: application/json' \271 -H 'Content-Type: application/json' \
272272 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
273 -d '{273 -d '{
274 "role": "owner"274 "role": "owner"
275 }'275 }'
337```http337```http
338curl https://api.openai.com/v1/organization/users/$USER_ID \338curl https://api.openai.com/v1/organization/users/$USER_ID \
339 -X DELETE \339 -X DELETE \
340340 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
341```341```
342 342
343#### Response343#### Response
370 370
371## Domain Types371## Domain Types
372 372
373373### User### Organization User
374 374
375375- `User object { id, added_at, email, 3 more }`- `OrganizationUser object { id, added_at, email, 3 more }`
376 376
377 Represents an individual `user` within an organization.377 Represents an individual `user` within an organization.
378 378
516 516
517```http517```http
518curl https://api.openai.com/v1/organization/users/$USER_ID/roles \518curl https://api.openai.com/v1/organization/users/$USER_ID/roles \
519519 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
520```520```
521 521
522#### Response522#### Response
614 614
615 - `"user.role"`615 - `"user.role"`
616 616
617617- `role: object { id, description, name, 4 more }`- `role: Role`
618 618
619 Details about a role that can be assigned through the public Roles API.619 Details about a role that can be assigned through the public Roles API.
620 620
648 648
649 Resource type the role is bound to (for example `api.organization` or `api.project`).649 Resource type the role is bound to (for example `api.organization` or `api.project`).
650 650
651651- `user: User`- `user: OrganizationUser`
652 652
653 Represents an individual `user` within an organization.653 Represents an individual `user` within an organization.
654 654
687```http687```http
688curl https://api.openai.com/v1/organization/users/$USER_ID/roles \688curl https://api.openai.com/v1/organization/users/$USER_ID/roles \
689 -H 'Content-Type: application/json' \689 -H 'Content-Type: application/json' \
690690 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
691 -d '{691 -d '{
692 "role_id": "role_id"692 "role_id": "role_id"
693 }'693 }'
786```http786```http
787curl https://api.openai.com/v1/organization/users/$USER_ID/roles/$ROLE_ID \787curl https://api.openai.com/v1/organization/users/$USER_ID/roles/$ROLE_ID \
788 -X DELETE \788 -X DELETE \
789789 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
790```790```
791 791
792#### Response792#### Response
879 879
880 - `"user.role"`880 - `"user.role"`
881 881
882882 - `role: object { id, description, name, 4 more }` - `role: Role`
883 883
884 Details about a role that can be assigned through the public Roles API.884 Details about a role that can be assigned through the public Roles API.
885 885
913 913
914 Resource type the role is bound to (for example `api.organization` or `api.project`).914 Resource type the role is bound to (for example `api.organization` or `api.project`).
915 915
916916 - `user: User` - `user: OrganizationUser`
917 917
918 Represents an individual `user` within an organization.918 Represents an individual `user` within an organization.
919 919
Previously: resources/organization/subresources/users/methods/delete/index.md
23```http23```http
24curl https://api.openai.com/v1/organization/users/$USER_ID \24curl https://api.openai.com/v1/organization/users/$USER_ID \
25 -X DELETE \25 -X DELETE \
2626 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
27```27```
28 28
29#### Response29#### Response
Previously: resources/organization/subresources/users/methods/list/index.md
20 20
21### Returns21### Returns
22 22
2323- `data: array of User`- `data: array of OrganizationUser`
24 24
25 - `id: string`25 - `id: string`
26 26
66 66
67```http67```http
68curl https://api.openai.com/v1/organization/users \68curl https://api.openai.com/v1/organization/users \
6969 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
70```70```
71 71
72#### Response72#### Response
Previously: resources/organization/subresources/users/methods/retrieve/index.md
10 10
11### Returns11### Returns
12 12
1313- `User object { id, added_at, email, 3 more }`- `OrganizationUser object { id, added_at, email, 3 more }`
14 14
15 Represents an individual `user` within an organization.15 Represents an individual `user` within an organization.
16 16
48 48
49```http49```http
50curl https://api.openai.com/v1/organization/users/$USER_ID \50curl https://api.openai.com/v1/organization/users/$USER_ID \
5151 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
52```52```
53 53
54#### Response54#### Response
Previously: resources/organization/subresources/users/methods/update/index.md
20 20
21### Returns21### Returns
22 22
2323- `User object { id, added_at, email, 3 more }`- `OrganizationUser object { id, added_at, email, 3 more }`
24 24
25 Represents an individual `user` within an organization.25 Represents an individual `user` within an organization.
26 26
59```http59```http
60curl https://api.openai.com/v1/organization/users/$USER_ID \60curl https://api.openai.com/v1/organization/users/$USER_ID \
61 -H 'Content-Type: application/json' \61 -H 'Content-Type: application/json' \
6262 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
63 -d '{63 -d '{
64 "role": "owner"64 "role": "owner"
65 }'65 }'
Previously: resources/organization/subresources/users/subresources/roles/methods/create/index.md
22 22
23 - `"user.role"`23 - `"user.role"`
24 24
2525- `role: object { id, description, name, 4 more }`- `role: Role`
26 26
27 Details about a role that can be assigned through the public Roles API.27 Details about a role that can be assigned through the public Roles API.
28 28
56 56
57 Resource type the role is bound to (for example `api.organization` or `api.project`).57 Resource type the role is bound to (for example `api.organization` or `api.project`).
58 58
5959- `user: User`- `user: OrganizationUser`
60 60
61 Represents an individual `user` within an organization.61 Represents an individual `user` within an organization.
62 62
95```http95```http
96curl https://api.openai.com/v1/organization/users/$USER_ID/roles \96curl https://api.openai.com/v1/organization/users/$USER_ID/roles \
97 -H 'Content-Type: application/json' \97 -H 'Content-Type: application/json' \
9898 -H "Authorization: Bearer $OPENAI_API_KEY" \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
99 -d '{99 -d '{
100 "role_id": "role_id"100 "role_id": "role_id"
101 }'101 }'
Previously: resources/organization/subresources/users/subresources/roles/methods/delete/index.md
25```http25```http
26curl https://api.openai.com/v1/organization/users/$USER_ID/roles/$ROLE_ID \26curl https://api.openai.com/v1/organization/users/$USER_ID/roles/$ROLE_ID \
27 -X DELETE \27 -X DELETE \
2828 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
29```29```
30 30
31#### Response31#### Response
Previously: resources/organization/subresources/users/subresources/roles/methods/list/index.md
94 94
95```http95```http
96curl https://api.openai.com/v1/organization/users/$USER_ID/roles \96curl https://api.openai.com/v1/organization/users/$USER_ID/roles \
9797 -H "Authorization: Bearer $OPENAI_API_KEY" -H "Authorization: Bearer $OPENAI_ADMIN_KEY"
98```98```
99 99
100#### Response100#### Response
1671 "end_index": 0,1671 "end_index": 0,
1672 "start_index": 0,1672 "start_index": 0,
1673 "title": "title",1673 "title": "title",
16741674 "url": "url" "url": "https://example.com"
1675 }1675 }
1676 }1676 }
1677 ],1677 ],
2627 "end_index": 0,2627 "end_index": 0,
2628 "start_index": 0,2628 "start_index": 0,
2629 "title": "title",2629 "title": "title",
26302630 "url": "url" "url": "https://example.com"
2631 }2631 }
2632 }2632 }
2633 ],2633 ],
3143 "end_index": 0,3143 "end_index": 0,
3144 "start_index": 0,3144 "start_index": 0,
3145 "title": "title",3145 "title": "title",
31463146 "url": "url" "url": "https://example.com"
3147 }3147 }
3148 }3148 }
3149 ],3149 ],
3663 "end_index": 0,3663 "end_index": 0,
3664 "start_index": 0,3664 "start_index": 0,
3665 "title": "title",3665 "title": "title",
36663666 "url": "url" "url": "https://example.com"
3667 }3667 }
3668 }3668 }
3669 ],3669 ],
6430 "end_index": 0,6430 "end_index": 0,
6431 "start_index": 0,6431 "start_index": 0,
6432 "title": "title",6432 "title": "title",
64336433 "url": "url" "url": "https://example.com"
6434 }6434 }
6435 }6435 }
6436 ],6436 ],
400 "end_index": 0,400 "end_index": 0,
401 "start_index": 0,401 "start_index": 0,
402 "title": "title",402 "title": "title",
403403 "url": "url" "url": "https://example.com"
404 }404 }
405 }405 }
406 ],406 ],
5966 "testing_criteria": "testing_criteria"5966 "testing_criteria": "testing_criteria"
5967 }5967 }
5968 ],5968 ],
59695969 "report_url": "report_url", "report_url": "https://example.com",
5970 "result_counts": {5970 "result_counts": {
5971 "errored": 0,5971 "errored": 0,
5972 "failed": 0,5972 "failed": 0,
10054 "testing_criteria": "testing_criteria"10054 "testing_criteria": "testing_criteria"
10055 }10055 }
10056 ],10056 ],
1005710057 "report_url": "report_url", "report_url": "https://example.com",
10058 "result_counts": {10058 "result_counts": {
10059 "errored": 0,10059 "errored": 0,
10060 "failed": 0,10060 "failed": 0,
12212 "testing_criteria": "testing_criteria"12212 "testing_criteria": "testing_criteria"
12213 }12213 }
12214 ],12214 ],
1221512215 "report_url": "report_url", "report_url": "https://example.com",
12216 "result_counts": {12216 "result_counts": {
12217 "errored": 0,12217 "errored": 0,
12218 "failed": 0,12218 "failed": 0,
14453 "testing_criteria": "testing_criteria"14453 "testing_criteria": "testing_criteria"
14454 }14454 }
14455 ],14455 ],
1445614456 "report_url": "report_url", "report_url": "https://example.com",
14457 "result_counts": {14457 "result_counts": {
14458 "errored": 0,14458 "errored": 0,
14459 "failed": 0,14459 "failed": 0,
2069 "testing_criteria": "testing_criteria"2069 "testing_criteria": "testing_criteria"
2070 }2070 }
2071 ],2071 ],
20722072 "report_url": "report_url", "report_url": "https://example.com",
2073 "result_counts": {2073 "result_counts": {
2074 "errored": 0,2074 "errored": 0,
2075 "failed": 0,2075 "failed": 0,
284 {284 {
285 "b64_json": "b64_json",285 "b64_json": "b64_json",
286 "revised_prompt": "revised_prompt",286 "revised_prompt": "revised_prompt",
287287 "url": "url" "url": "https://example.com"
288 }288 }
289 ],289 ],
290 "output_format": "png",290 "output_format": "png",
650 {650 {
651 "b64_json": "b64_json",651 "b64_json": "b64_json",
652 "revised_prompt": "revised_prompt",652 "revised_prompt": "revised_prompt",
653653 "url": "url" "url": "https://example.com"
654 }654 }
655 ],655 ],
656 "output_format": "png",656 "output_format": "png",
844 {844 {
845 "b64_json": "b64_json",845 "b64_json": "b64_json",
846 "revised_prompt": "revised_prompt",846 "revised_prompt": "revised_prompt",
847847 "url": "url" "url": "https://example.com"
848 }848 }
849 ],849 ],
850 "output_format": "png",850 "output_format": "png",
131 {131 {
132 "b64_json": "b64_json",132 "b64_json": "b64_json",
133 "revised_prompt": "revised_prompt",133 "revised_prompt": "revised_prompt",
134134 "url": "url" "url": "https://example.com"
135 }135 }
136 ],136 ],
137 "output_format": "png",137 "output_format": "png",