diff --git a/en/resources/admin/subresources/organization/index.md b/en/resources/admin/subresources/organization/index.md index 02f38c4..0b961c8 100644 --- a/en/resources/admin/subresources/organization/index.md +++ b/en/resources/admin/subresources/organization/index.md @@ -166,80 +166,12 @@ List user actions and configuration changes within this organization. ### Returns -- `data: array of object { id, actor, effective_at, 49 more }` +- `data: array of object { id, effective_at, type, 49 more }` - `id: string` The ID of this log. - - `actor: object { api_key, session, type }` - - The actor who performed the audit logged action. - - - `api_key: optional object { id, service_account, type, user }` - - The API Key used to perform the audit logged action. - - - `id: optional string` - - The tracking id of the API key. - - - `service_account: optional object { id }` - - The service account that performed the audit logged action. - - - `id: optional string` - - The service account id. - - - `type: optional "user" or "service_account"` - - The type of API key. Can be either `user` or `service_account`. - - - `"user"` - - - `"service_account"` - - - `user: optional object { id, email }` - - The user who performed the audit logged action. - - - `id: optional string` - - The user id. - - - `email: optional string` - - The user email. - - - `session: optional object { ip_address, user }` - - The session in which the audit logged action was performed. - - - `ip_address: optional string` - - The IP address from which the action was performed. - - - `user: optional object { id, email }` - - The user who performed the audit logged action. - - - `id: optional string` - - The user id. - - - `email: optional string` - - The user email. - - - `type: optional "session" or "api_key"` - - The type of actor. Is either `session` or `api_key`. - - - `"session"` - - - `"api_key"` - - `effective_at: number` The Unix timestamp (in seconds) of the event. @@ -350,6 +282,74 @@ List user actions and configuration changes within this organization. - `"user.deleted"` + - `actor: optional object { api_key, session, type }` + + The actor who performed the audit logged action. + + - `api_key: optional object { id, service_account, type, user }` + + The API Key used to perform the audit logged action. + + - `id: optional string` + + The tracking id of the API key. + + - `service_account: optional object { id }` + + The service account that performed the audit logged action. + + - `id: optional string` + + The service account id. + + - `type: optional "user" or "service_account"` + + The type of API key. Can be either `user` or `service_account`. + + - `"user"` + + - `"service_account"` + + - `user: optional object { id, email }` + + The user who performed the audit logged action. + + - `id: optional string` + + The user id. + + - `email: optional string` + + The user email. + + - `session: optional object { ip_address, user }` + + The session in which the audit logged action was performed. + + - `ip_address: optional string` + + The IP address from which the action was performed. + + - `user: optional object { id, email }` + + The user who performed the audit logged action. + + - `id: optional string` + + The user id. + + - `email: optional string` + + The user email. + + - `type: optional "session" or "api_key"` + + The type of actor. Is either `session` or `api_key`. + + - `"session"` + + - `"api_key"` + - `"api_key.created": optional object { id, data }` The details for events with this `type`. @@ -1054,16 +1054,16 @@ List user actions and configuration changes within this organization. The role of the user. Is either `owner` or `member`. -- `first_id: string` - - `has_more: boolean` -- `last_id: string` - - `object: "list"` - `"list"` +- `first_id: optional string` + +- `last_id: optional string` + ### Example ```http @@ -1078,6 +1078,8 @@ curl https://api.openai.com/v1/organization/audit_logs \ "data": [ { "id": "id", + "effective_at": 0, + "type": "api_key.created", "actor": { "api_key": { "id": "id", @@ -1099,8 +1101,6 @@ curl https://api.openai.com/v1/organization/audit_logs \ }, "type": "session" }, - "effective_at": 0, - "type": "api_key.created", "api_key.created": { "id": "id", "data": { @@ -1369,10 +1369,10 @@ curl https://api.openai.com/v1/organization/audit_logs \ } } ], - "first_id": "audit_log-defb456h8dks", "has_more": true, - "last_id": "audit_log-hnbkd8s93s", - "object": "list" + "object": "list", + "first_id": "audit_log-defb456h8dks", + "last_id": "audit_log-hnbkd8s93s" } ``` @@ -1452,7 +1452,7 @@ curl https://api.openai.com/v1/organization/audit_logs \ ### Audit Log List Response -- `AuditLogListResponse object { id, actor, effective_at, 49 more }` +- `AuditLogListResponse object { id, effective_at, type, 49 more }` A log of a user action or configuration change within this organization. @@ -1460,74 +1460,6 @@ curl https://api.openai.com/v1/organization/audit_logs \ The ID of this log. - - `actor: object { api_key, session, type }` - - The actor who performed the audit logged action. - - - `api_key: optional object { id, service_account, type, user }` - - The API Key used to perform the audit logged action. - - - `id: optional string` - - The tracking id of the API key. - - - `service_account: optional object { id }` - - The service account that performed the audit logged action. - - - `id: optional string` - - The service account id. - - - `type: optional "user" or "service_account"` - - The type of API key. Can be either `user` or `service_account`. - - - `"user"` - - - `"service_account"` - - - `user: optional object { id, email }` - - The user who performed the audit logged action. - - - `id: optional string` - - The user id. - - - `email: optional string` - - The user email. - - - `session: optional object { ip_address, user }` - - The session in which the audit logged action was performed. - - - `ip_address: optional string` - - The IP address from which the action was performed. - - - `user: optional object { id, email }` - - The user who performed the audit logged action. - - - `id: optional string` - - The user id. - - - `email: optional string` - - The user email. - - - `type: optional "session" or "api_key"` - - The type of actor. Is either `session` or `api_key`. - - - `"session"` - - - `"api_key"` - - `effective_at: number` The Unix timestamp (in seconds) of the event. @@ -1638,45 +1570,113 @@ curl https://api.openai.com/v1/organization/audit_logs \ - `"user.deleted"` - - `"api_key.created": optional object { id, data }` + - `actor: optional object { api_key, session, type }` - The details for events with this `type`. + The actor who performed the audit logged action. + + - `api_key: optional object { id, service_account, type, user }` + + The API Key used to perform the audit logged action. - `id: optional string` - The tracking ID of the API key. + The tracking id of the API key. - - `data: optional object { scopes }` + - `service_account: optional object { id }` - The payload used to create the API key. + The service account that performed the audit logged action. - - `scopes: optional array of string` + - `id: optional string` - A list of scopes allowed for the API key, e.g. `["api.model.request"]` + The service account id. - - `"api_key.deleted": optional object { id }` + - `type: optional "user" or "service_account"` - The details for events with this `type`. + The type of API key. Can be either `user` or `service_account`. - - `id: optional string` + - `"user"` - The tracking ID of the API key. + - `"service_account"` - - `"api_key.updated": optional object { id, changes_requested }` + - `user: optional object { id, email }` - The details for events with this `type`. + The user who performed the audit logged action. - `id: optional string` - The tracking ID of the API key. + The user id. - - `changes_requested: optional object { scopes }` + - `email: optional string` - The payload used to update the API key. + The user email. - - `scopes: optional array of string` + - `session: optional object { ip_address, user }` - A list of scopes allowed for the API key, e.g. `["api.model.request"]` + The session in which the audit logged action was performed. + + - `ip_address: optional string` + + The IP address from which the action was performed. + + - `user: optional object { id, email }` + + The user who performed the audit logged action. + + - `id: optional string` + + The user id. + + - `email: optional string` + + The user email. + + - `type: optional "session" or "api_key"` + + The type of actor. Is either `session` or `api_key`. + + - `"session"` + + - `"api_key"` + + - `"api_key.created": optional object { id, data }` + + The details for events with this `type`. + + - `id: optional string` + + The tracking ID of the API key. + + - `data: optional object { scopes }` + + The payload used to create the API key. + + - `scopes: optional array of string` + + A list of scopes allowed for the API key, e.g. `["api.model.request"]` + + - `"api_key.deleted": optional object { id }` + + The details for events with this `type`. + + - `id: optional string` + + The tracking ID of the API key. + + - `"api_key.updated": optional object { id, changes_requested }` + + The details for events with this `type`. + + - `id: optional string` + + The tracking ID of the API key. + + - `changes_requested: optional object { scopes }` + + The payload used to update the API key. + + - `scopes: optional array of string` + + A list of scopes allowed for the API key, e.g. `["api.model.request"]` - `"certificate.created": optional object { id, name }` @@ -2370,7 +2370,7 @@ List organization API keys ### Returns -- `data: optional array of AdminAPIKey` +- `data: array of AdminAPIKey` - `id: string` @@ -2380,18 +2380,12 @@ List organization API keys The Unix timestamp (in seconds) of when the API key was created - - `last_used_at: number` - - The Unix timestamp (in seconds) of when the API key was last used - - - `name: string` - - The name of the API key - - - `object: string` + - `object: "organization.admin_api_key"` The object type, which is always `organization.admin_api_key` + - `"organization.admin_api_key"` + - `owner: object { id, created_at, name, 3 more }` - `id: optional string` @@ -2422,17 +2416,23 @@ List organization API keys The redacted value of the API key - - `value: optional string` + - `last_used_at: optional number` - The value of the API key. Only shown on create. + The Unix timestamp (in seconds) of when the API key was last used -- `first_id: optional string` + - `name: optional string` -- `has_more: optional boolean` + The name of the API key -- `last_id: optional string` +- `has_more: boolean` + +- `object: "list"` + + - `"list"` + +- `first_id: optional string` -- `object: optional string` +- `last_id: optional string` ### Example @@ -2449,8 +2449,6 @@ curl https://api.openai.com/v1/organization/admin_api_keys \ { "id": "key_abc", "created_at": 1711471533, - "last_used_at": 1711471534, - "name": "Administration Key", "object": "organization.admin_api_key", "owner": { "id": "sa_456", @@ -2461,13 +2459,14 @@ curl https://api.openai.com/v1/organization/admin_api_keys \ "type": "user" }, "redacted_value": "sk-admin...def", - "value": "sk-admin-1234abcd" + "last_used_at": 1711471534, + "name": "Administration Key" } ], - "first_id": "key_abc", "has_more": false, - "last_id": "key_xyz", - "object": "list" + "object": "list", + "first_id": "key_abc", + "last_id": "key_xyz" } ``` @@ -2520,61 +2519,7 @@ Create an organization admin API key ### Returns -- `AdminAPIKey object { id, created_at, last_used_at, 5 more }` - - Represents an individual Admin API key in an org. - - - `id: string` - - The identifier, which can be referenced in API endpoints - - - `created_at: number` - - The Unix timestamp (in seconds) of when the API key was created - - - `last_used_at: number` - - The Unix timestamp (in seconds) of when the API key was last used - - - `name: string` - - The name of the API key - - - `object: string` - - The object type, which is always `organization.admin_api_key` - - - `owner: object { id, created_at, name, 3 more }` - - - `id: optional string` - - The identifier, which can be referenced in API endpoints - - - `created_at: optional number` - - The Unix timestamp (in seconds) of when the user was created - - - `name: optional string` - - The name of the user - - - `object: optional string` - - The object type, which is always organization.user - - - `role: optional string` - - Always `owner` - - - `type: optional string` - - Always `user` - - - `redacted_value: string` - - The redacted value of the API key - - - `value: optional string` +- `value: string` The value of the API key. Only shown on create. @@ -2595,8 +2540,6 @@ curl https://api.openai.com/v1/organization/admin_api_keys \ { "id": "key_abc", "created_at": 1711471533, - "last_used_at": 1711471534, - "name": "Administration Key", "object": "organization.admin_api_key", "owner": { "id": "sa_456", @@ -2607,6 +2550,8 @@ curl https://api.openai.com/v1/organization/admin_api_keys \ "type": "user" }, "redacted_value": "sk-admin...def", + "last_used_at": 1711471534, + "name": "Administration Key", "value": "sk-admin-1234abcd" } ``` @@ -2658,7 +2603,7 @@ Retrieve a single organization API key ### Returns -- `AdminAPIKey object { id, created_at, last_used_at, 5 more }` +- `AdminAPIKey object { id, created_at, object, 4 more }` Represents an individual Admin API key in an org. @@ -2670,18 +2615,12 @@ Retrieve a single organization API key The Unix timestamp (in seconds) of when the API key was created - - `last_used_at: number` - - The Unix timestamp (in seconds) of when the API key was last used - - - `name: string` - - The name of the API key - - - `object: string` + - `object: "organization.admin_api_key"` The object type, which is always `organization.admin_api_key` + - `"organization.admin_api_key"` + - `owner: object { id, created_at, name, 3 more }` - `id: optional string` @@ -2712,9 +2651,13 @@ Retrieve a single organization API key The redacted value of the API key - - `value: optional string` + - `last_used_at: optional number` - The value of the API key. Only shown on create. + The Unix timestamp (in seconds) of when the API key was last used + + - `name: optional string` + + The name of the API key ### Example @@ -2729,8 +2672,6 @@ curl https://api.openai.com/v1/organization/admin_api_keys/$KEY_ID \ { "id": "key_abc", "created_at": 1711471533, - "last_used_at": 1711471534, - "name": "Administration Key", "object": "organization.admin_api_key", "owner": { "id": "sa_456", @@ -2741,7 +2682,8 @@ curl https://api.openai.com/v1/organization/admin_api_keys/$KEY_ID \ "type": "user" }, "redacted_value": "sk-admin...def", - "value": "sk-admin-1234abcd" + "last_used_at": 1711471534, + "name": "Administration Key" } ``` @@ -2788,11 +2730,13 @@ Delete an organization admin API key ### Returns -- `id: optional string` +- `id: string` + +- `deleted: boolean` -- `deleted: optional boolean` +- `object: "organization.admin_api_key.deleted"` -- `object: optional string` + - `"organization.admin_api_key.deleted"` ### Example @@ -2834,7 +2778,7 @@ curl -X DELETE https://api.openai.com/v1/organization/admin_api_keys/key_abc \ ### Admin API Key -- `AdminAPIKey object { id, created_at, last_used_at, 5 more }` +- `AdminAPIKey object { id, created_at, object, 4 more }` Represents an individual Admin API key in an org. @@ -2846,18 +2790,12 @@ curl -X DELETE https://api.openai.com/v1/organization/admin_api_keys/key_abc \ The Unix timestamp (in seconds) of when the API key was created - - `last_used_at: number` - - The Unix timestamp (in seconds) of when the API key was last used - - - `name: string` - - The name of the API key - - - `object: string` + - `object: "organization.admin_api_key"` The object type, which is always `organization.admin_api_key` + - `"organization.admin_api_key"` + - `owner: object { id, created_at, name, 3 more }` - `id: optional string` @@ -2888,7 +2826,21 @@ curl -X DELETE https://api.openai.com/v1/organization/admin_api_keys/key_abc \ The redacted value of the API key - - `value: optional string` + - `last_used_at: optional number` + + The Unix timestamp (in seconds) of when the API key was last used + + - `name: optional string` + + The name of the API key + +### Admin API Key Create Response + +- `AdminAPIKeyCreateResponse = AdminAPIKey` + + Represents an individual Admin API key in an org. + + - `value: string` The value of the API key. Only shown on create. @@ -2896,11 +2848,13 @@ curl -X DELETE https://api.openai.com/v1/organization/admin_api_keys/key_abc \ - `AdminAPIKeyDeleteResponse object { id, deleted, object }` - - `id: optional string` + - `id: string` + + - `deleted: boolean` - - `deleted: optional boolean` + - `object: "organization.admin_api_key.deleted"` - - `object: optional string` + - `"organization.admin_api_key.deleted"` # Usage @@ -2972,7 +2926,7 @@ Get audio speeches usage details for the organization. ### Returns -- `data: array of object { end_time, object, result, start_time }` +- `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -2980,9 +2934,9 @@ Get audio speeches usage details for the organization. - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -3038,7 +2992,7 @@ Get audio speeches usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -3070,7 +3024,7 @@ Get audio speeches usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -3102,7 +3056,7 @@ Get audio speeches usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -3142,7 +3096,7 @@ Get audio speeches usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -3174,7 +3128,7 @@ Get audio speeches usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -3206,7 +3160,7 @@ Get audio speeches usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -3222,23 +3176,23 @@ Get audio speeches usage details for the organization. When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -3295,7 +3249,7 @@ curl https://api.openai.com/v1/organization/usage/audio_speeches \ { "end_time": 0, "object": "bucket", - "result": [ + "results": [ { "input_tokens": 0, "num_model_requests": 0, @@ -3425,7 +3379,7 @@ Get audio transcriptions usage details for the organization. ### Returns -- `data: array of object { end_time, object, result, start_time }` +- `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -3433,9 +3387,9 @@ Get audio transcriptions usage details for the organization. - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -3491,7 +3445,7 @@ Get audio transcriptions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -3523,7 +3477,7 @@ Get audio transcriptions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -3555,7 +3509,7 @@ Get audio transcriptions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -3595,7 +3549,7 @@ Get audio transcriptions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -3627,7 +3581,7 @@ Get audio transcriptions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -3659,7 +3613,7 @@ Get audio transcriptions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -3675,23 +3629,23 @@ Get audio transcriptions usage details for the organization. When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -3748,7 +3702,7 @@ curl https://api.openai.com/v1/organization/usage/audio_transcriptions \ { "end_time": 0, "object": "bucket", - "result": [ + "results": [ { "input_tokens": 0, "num_model_requests": 0, @@ -3860,7 +3814,7 @@ Get code interpreter sessions usage details for the organization. ### Returns -- `data: array of object { end_time, object, result, start_time }` +- `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -3868,9 +3822,9 @@ Get code interpreter sessions usage details for the organization. - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -3926,7 +3880,7 @@ Get code interpreter sessions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -3958,7 +3912,7 @@ Get code interpreter sessions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -3990,7 +3944,7 @@ Get code interpreter sessions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -4030,7 +3984,7 @@ Get code interpreter sessions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -4062,7 +4016,7 @@ Get code interpreter sessions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -4094,7 +4048,7 @@ Get code interpreter sessions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -4110,23 +4064,23 @@ Get code interpreter sessions usage details for the organization. When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -4183,7 +4137,7 @@ curl https://api.openai.com/v1/organization/usage/code_interpreter_sessions \ { "end_time": 0, "object": "bucket", - "result": [ + "results": [ { "input_tokens": 0, "num_model_requests": 0, @@ -4317,7 +4271,7 @@ Get completions usage details for the organization. ### Returns -- `data: array of object { end_time, object, result, start_time }` +- `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -4325,9 +4279,9 @@ Get completions usage details for the organization. - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -4383,7 +4337,7 @@ Get completions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -4415,7 +4369,7 @@ Get completions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -4447,7 +4401,7 @@ Get completions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -4487,7 +4441,7 @@ Get completions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -4519,7 +4473,7 @@ Get completions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -4551,7 +4505,7 @@ Get completions usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -4567,23 +4521,23 @@ Get completions usage details for the organization. When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -4640,7 +4594,7 @@ curl https://api.openai.com/v1/organization/usage/completions \ { "end_time": 0, "object": "bucket", - "result": [ + "results": [ { "input_tokens": 0, "num_model_requests": 0, @@ -4776,7 +4730,7 @@ Get embeddings usage details for the organization. ### Returns -- `data: array of object { end_time, object, result, start_time }` +- `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -4784,9 +4738,9 @@ Get embeddings usage details for the organization. - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -4842,7 +4796,7 @@ Get embeddings usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -4874,7 +4828,7 @@ Get embeddings usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -4906,7 +4860,7 @@ Get embeddings usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -4946,7 +4900,7 @@ Get embeddings usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -4978,7 +4932,7 @@ Get embeddings usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -5010,7 +4964,7 @@ Get embeddings usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -5026,23 +4980,23 @@ Get embeddings usage details for the organization. When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -5099,7 +5053,7 @@ curl https://api.openai.com/v1/organization/usage/embeddings \ { "end_time": 0, "object": "bucket", - "result": [ + "results": [ { "input_tokens": 0, "num_model_requests": 0, @@ -5257,7 +5211,7 @@ Get images usage details for the organization. ### Returns -- `data: array of object { end_time, object, result, start_time }` +- `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -5265,9 +5219,9 @@ Get images usage details for the organization. - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -5323,7 +5277,7 @@ Get images usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -5355,7 +5309,7 @@ Get images usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -5387,7 +5341,7 @@ Get images usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -5427,7 +5381,7 @@ Get images usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -5459,7 +5413,7 @@ Get images usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -5491,7 +5445,7 @@ Get images usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -5507,23 +5461,23 @@ Get images usage details for the organization. When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -5580,7 +5534,7 @@ curl https://api.openai.com/v1/organization/usage/images \ { "end_time": 0, "object": "bucket", - "result": [ + "results": [ { "input_tokens": 0, "num_model_requests": 0, @@ -5712,7 +5666,7 @@ Get moderations usage details for the organization. ### Returns -- `data: array of object { end_time, object, result, start_time }` +- `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -5720,9 +5674,9 @@ Get moderations usage details for the organization. - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -5778,7 +5732,7 @@ Get moderations usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -5810,7 +5764,7 @@ Get moderations usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -5842,7 +5796,7 @@ Get moderations usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -5882,7 +5836,7 @@ Get moderations usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -5914,7 +5868,7 @@ Get moderations usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -5946,7 +5900,7 @@ Get moderations usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -5962,23 +5916,23 @@ Get moderations usage details for the organization. When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -6035,7 +5989,7 @@ curl https://api.openai.com/v1/organization/usage/moderations \ { "end_time": 0, "object": "bucket", - "result": [ + "results": [ { "input_tokens": 0, "num_model_requests": 0, @@ -6147,7 +6101,7 @@ Get vector stores usage details for the organization. ### Returns -- `data: array of object { end_time, object, result, start_time }` +- `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -6155,9 +6109,9 @@ Get vector stores usage details for the organization. - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -6213,7 +6167,7 @@ Get vector stores usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -6245,7 +6199,7 @@ Get vector stores usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -6277,7 +6231,7 @@ Get vector stores usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -6317,7 +6271,7 @@ Get vector stores usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -6349,7 +6303,7 @@ Get vector stores usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -6381,7 +6335,7 @@ Get vector stores usage details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -6397,23 +6351,23 @@ Get vector stores usage details for the organization. When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. + - `num_sessions: number` + + The number of code interpreter sessions. + - `object: "organization.usage.code_interpreter_sessions.result"` - `"organization.usage.code_interpreter_sessions.result"` - - `num_sessions: optional number` - - The number of code interpreter sessions. - - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -6470,7 +6424,7 @@ curl https://api.openai.com/v1/organization/usage/vector_stores \ { "end_time": 0, "object": "bucket", - "result": [ + "results": [ { "input_tokens": 0, "num_model_requests": 0, @@ -6578,7 +6532,7 @@ Get costs details for the organization. ### Returns -- `data: array of object { end_time, object, result, start_time }` +- `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -6586,9 +6540,9 @@ Get costs details for the organization. - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -6644,7 +6598,7 @@ Get costs details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -6676,7 +6630,7 @@ Get costs details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -6708,7 +6662,7 @@ Get costs details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -6748,7 +6702,7 @@ Get costs details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -6780,7 +6734,7 @@ Get costs details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -6812,7 +6766,7 @@ Get costs details for the organization. When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -6828,23 +6782,23 @@ Get costs details for the organization. When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -6901,7 +6855,7 @@ curl https://api.openai.com/v1/organization/costs \ { "end_time": 0, "object": "bucket", - "result": [ + "results": [ { "input_tokens": 0, "num_model_requests": 0, @@ -6970,7 +6924,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `UsageAudioSpeechesResponse object { data, has_more, next_page, object }` - - `data: array of object { end_time, object, result, start_time }` + - `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -6978,9 +6932,9 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -7036,7 +6990,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -7068,7 +7022,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -7100,7 +7054,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -7140,7 +7094,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -7172,7 +7126,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -7204,7 +7158,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -7220,23 +7174,23 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -7282,7 +7236,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `UsageAudioTranscriptionsResponse object { data, has_more, next_page, object }` - - `data: array of object { end_time, object, result, start_time }` + - `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -7290,9 +7244,9 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -7348,7 +7302,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -7380,7 +7334,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -7412,7 +7366,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -7452,7 +7406,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -7484,7 +7438,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -7516,7 +7470,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -7532,23 +7486,23 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -7594,7 +7548,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `UsageCodeInterpreterSessionsResponse object { data, has_more, next_page, object }` - - `data: array of object { end_time, object, result, start_time }` + - `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -7602,9 +7556,9 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -7660,7 +7614,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -7692,7 +7646,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -7724,7 +7678,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -7764,7 +7718,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -7796,7 +7750,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -7828,7 +7782,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -7844,23 +7798,23 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -7906,7 +7860,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `UsageCompletionsResponse object { data, has_more, next_page, object }` - - `data: array of object { end_time, object, result, start_time }` + - `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -7914,9 +7868,9 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -7972,7 +7926,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -8004,7 +7958,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -8036,7 +7990,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -8076,7 +8030,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -8108,7 +8062,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -8140,7 +8094,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -8156,23 +8110,23 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -8218,7 +8172,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `UsageEmbeddingsResponse object { data, has_more, next_page, object }` - - `data: array of object { end_time, object, result, start_time }` + - `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -8226,9 +8180,9 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -8284,7 +8238,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -8316,7 +8270,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -8348,7 +8302,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -8388,7 +8342,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -8420,7 +8374,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -8452,7 +8406,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -8468,23 +8422,23 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -8530,7 +8484,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `UsageImagesResponse object { data, has_more, next_page, object }` - - `data: array of object { end_time, object, result, start_time }` + - `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -8538,9 +8492,9 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -8596,7 +8550,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -8628,7 +8582,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -8660,7 +8614,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -8700,7 +8654,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -8732,7 +8686,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -8764,7 +8718,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -8780,23 +8734,23 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -8842,7 +8796,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `UsageModerationsResponse object { data, has_more, next_page, object }` - - `data: array of object { end_time, object, result, start_time }` + - `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -8850,9 +8804,9 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -8908,7 +8862,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -8940,7 +8894,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -8972,7 +8926,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -9012,7 +8966,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -9044,7 +8998,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -9076,7 +9030,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -9092,23 +9046,23 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -9154,7 +9108,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `UsageVectorStoresResponse object { data, has_more, next_page, object }` - - `data: array of object { end_time, object, result, start_time }` + - `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -9162,9 +9116,9 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -9220,7 +9174,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -9252,7 +9206,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -9284,7 +9238,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -9324,7 +9278,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -9356,7 +9310,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -9388,7 +9342,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -9404,23 +9358,23 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -9466,7 +9420,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `UsageCostsResponse object { data, has_more, next_page, object }` - - `data: array of object { end_time, object, result, start_time }` + - `data: array of object { end_time, object, results, start_time }` - `end_time: number` @@ -9474,9 +9428,9 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 - `"bucket"` - - `result: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` + - `results: array of object { input_tokens, num_model_requests, object, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more` - - `UsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` + - `OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 more }` The aggregated completions usage details of the specific time bucket. @@ -9532,7 +9486,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated embeddings usage details of the specific time bucket. @@ -9564,7 +9518,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` + - `OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more }` The aggregated moderations usage details of the specific time bucket. @@ -9596,7 +9550,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageImagesResult object { images, num_model_requests, object, 6 more }` + - `OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more }` The aggregated images usage details of the specific time bucket. @@ -9636,7 +9590,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` + - `OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more }` The aggregated audio speeches usage details of the specific time bucket. @@ -9668,7 +9622,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` + - `OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more }` The aggregated audio transcriptions usage details of the specific time bucket. @@ -9700,7 +9654,7 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=user_id`, this field provides the user ID of the grouped usage result. - - `UsageVectorStoresResult object { object, usage_bytes, project_id }` + - `OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id }` The aggregated vector stores usage details of the specific time bucket. @@ -9716,23 +9670,23 @@ curl "https://api.openai.com/v1/organization/costs?start_time=1730419200&limit=1 When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `UsageCodeInterpreterSessionsResult object { object, num_sessions, project_id }` + - `OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id }` The aggregated code interpreter sessions usage details of the specific time bucket. - - `object: "organization.usage.code_interpreter_sessions.result"` + - `num_sessions: number` - - `"organization.usage.code_interpreter_sessions.result"` + The number of code interpreter sessions. - - `num_sessions: optional number` + - `object: "organization.usage.code_interpreter_sessions.result"` - The number of code interpreter sessions. + - `"organization.usage.code_interpreter_sessions.result"` - `project_id: optional string` When `group_by=project_id`, this field provides the project ID of the grouped usage result. - - `CostsResult object { object, amount, api_key_id, 2 more }` + - `OrganizationCostsResult object { object, amount, api_key_id, 2 more }` The aggregated costs details of the specific time bucket. @@ -9800,23 +9754,35 @@ Returns a list of invites in the organization. The identifier, which can be referenced in API endpoints + - `created_at: number` + + The Unix timestamp (in seconds) of when the invite was sent. + - `email: string` The email address of the individual to whom the invite was sent - - `expires_at: number` + - `object: "organization.invite"` - The Unix timestamp (in seconds) of when the invite expires. + The object type, which is always `organization.invite` - - `invited_at: number` + - `"organization.invite"` - The Unix timestamp (in seconds) of when the invite was sent. + - `projects: array of object { id, role }` - - `object: "organization.invite"` + The projects that were granted membership upon acceptance of the invite. - The object type, which is always `organization.invite` + - `id: string` - - `"organization.invite"` + Project's public ID + + - `role: "member" or "owner"` + + Project membership role + + - `"member"` + + - `"owner"` - `role: "owner" or "reader"` @@ -9840,21 +9806,13 @@ Returns a list of invites in the organization. The Unix timestamp (in seconds) of when the invite was accepted. - - `projects: optional array of object { id, role }` - - The projects that were granted membership upon acceptance of the invite. - - - `id: optional string` - - Project's public ID - - - `role: optional "member" or "owner"` + - `expires_at: optional number` - Project membership role + The Unix timestamp (in seconds) of when the invite expires. - - `"member"` +- `has_more: boolean` - - `"owner"` + The `has_more` property is used for pagination to indicate there are additional results. - `object: "list"` @@ -9866,10 +9824,6 @@ Returns a list of invites in the organization. The first `invite_id` in the retrieved `list` -- `has_more: optional boolean` - - The `has_more` property is used for pagination to indicate there are additional results. - - `last_id: optional string` The last `invite_id` in the retrieved `list` @@ -9888,24 +9842,24 @@ curl https://api.openai.com/v1/organization/invites \ "data": [ { "id": "id", + "created_at": 0, "email": "email", - "expires_at": 0, - "invited_at": 0, "object": "organization.invite", - "role": "owner", - "status": "accepted", - "accepted_at": 0, "projects": [ { "id": "id", "role": "member" } - ] + ], + "role": "owner", + "status": "accepted", + "accepted_at": 0, + "expires_at": 0 } ], + "has_more": true, "object": "list", "first_id": "first_id", - "has_more": true, "last_id": "last_id" } ``` @@ -9930,7 +9884,7 @@ curl https://api.openai.com/v1/organization/invites?after=invite-abc&limit=20 \ "email": "user@example.com", "role": "owner", "status": "accepted", - "invited_at": 1711471533, + "created_at": 1711471533, "expires_at": 1711471533, "accepted_at": 1711471533 } @@ -9979,7 +9933,7 @@ Create an invite for a user to the organization. The invite must be accepted by ### Returns -- `Invite object { id, email, expires_at, 6 more }` +- `Invite object { id, created_at, email, 6 more }` Represents an individual `invite` to the organization. @@ -9987,23 +9941,35 @@ Create an invite for a user to the organization. The invite must be accepted by The identifier, which can be referenced in API endpoints + - `created_at: number` + + The Unix timestamp (in seconds) of when the invite was sent. + - `email: string` The email address of the individual to whom the invite was sent - - `expires_at: number` + - `object: "organization.invite"` - The Unix timestamp (in seconds) of when the invite expires. + The object type, which is always `organization.invite` - - `invited_at: number` + - `"organization.invite"` - The Unix timestamp (in seconds) of when the invite was sent. + - `projects: array of object { id, role }` - - `object: "organization.invite"` + The projects that were granted membership upon acceptance of the invite. - The object type, which is always `organization.invite` + - `id: string` - - `"organization.invite"` + Project's public ID + + - `role: "member" or "owner"` + + Project membership role + + - `"member"` + + - `"owner"` - `role: "owner" or "reader"` @@ -10027,21 +9993,9 @@ Create an invite for a user to the organization. The invite must be accepted by The Unix timestamp (in seconds) of when the invite was accepted. - - `projects: optional array of object { id, role }` - - The projects that were granted membership upon acceptance of the invite. - - - `id: optional string` - - Project's public ID - - - `role: optional "member" or "owner"` - - Project membership role - - - `"member"` + - `expires_at: optional number` - - `"owner"` + The Unix timestamp (in seconds) of when the invite expires. ### Example @@ -10060,19 +10014,19 @@ curl https://api.openai.com/v1/organization/invites \ ```json { "id": "id", + "created_at": 0, "email": "email", - "expires_at": 0, - "invited_at": 0, "object": "organization.invite", - "role": "owner", - "status": "accepted", - "accepted_at": 0, "projects": [ { "id": "id", "role": "member" } - ] + ], + "role": "owner", + "status": "accepted", + "accepted_at": 0, + "expires_at": 0 } ``` @@ -10107,7 +10061,7 @@ curl -X POST https://api.openai.com/v1/organization/invites \ "email": "anotheruser@example.com", "role": "reader", "status": "pending", - "invited_at": 1711471533, + "created_at": 1711471533, "expires_at": 1711471533, "accepted_at": null, "projects": [ @@ -10135,7 +10089,7 @@ Retrieves an invite. ### Returns -- `Invite object { id, email, expires_at, 6 more }` +- `Invite object { id, created_at, email, 6 more }` Represents an individual `invite` to the organization. @@ -10143,23 +10097,35 @@ Retrieves an invite. The identifier, which can be referenced in API endpoints + - `created_at: number` + + The Unix timestamp (in seconds) of when the invite was sent. + - `email: string` The email address of the individual to whom the invite was sent - - `expires_at: number` + - `object: "organization.invite"` - The Unix timestamp (in seconds) of when the invite expires. + The object type, which is always `organization.invite` - - `invited_at: number` + - `"organization.invite"` - The Unix timestamp (in seconds) of when the invite was sent. + - `projects: array of object { id, role }` - - `object: "organization.invite"` + The projects that were granted membership upon acceptance of the invite. - The object type, which is always `organization.invite` + - `id: string` - - `"organization.invite"` + Project's public ID + + - `role: "member" or "owner"` + + Project membership role + + - `"member"` + + - `"owner"` - `role: "owner" or "reader"` @@ -10183,21 +10149,9 @@ Retrieves an invite. The Unix timestamp (in seconds) of when the invite was accepted. - - `projects: optional array of object { id, role }` - - The projects that were granted membership upon acceptance of the invite. - - - `id: optional string` - - Project's public ID - - - `role: optional "member" or "owner"` - - Project membership role - - - `"member"` + - `expires_at: optional number` - - `"owner"` + The Unix timestamp (in seconds) of when the invite expires. ### Example @@ -10211,19 +10165,19 @@ curl https://api.openai.com/v1/organization/invites/$INVITE_ID \ ```json { "id": "id", + "created_at": 0, "email": "email", - "expires_at": 0, - "invited_at": 0, "object": "organization.invite", - "role": "owner", - "status": "accepted", - "accepted_at": 0, "projects": [ { "id": "id", "role": "member" } - ] + ], + "role": "owner", + "status": "accepted", + "accepted_at": 0, + "expires_at": 0 } ``` @@ -10244,7 +10198,7 @@ curl https://api.openai.com/v1/organization/invites/invite-abc \ "email": "user@example.com", "role": "owner", "status": "accepted", - "invited_at": 1711471533, + "created_at": 1711471533, "expires_at": 1711471533, "accepted_at": 1711471533 } @@ -10312,7 +10266,7 @@ curl -X DELETE https://api.openai.com/v1/organization/invites/invite-abc \ ### Invite -- `Invite object { id, email, expires_at, 6 more }` +- `Invite object { id, created_at, email, 6 more }` Represents an individual `invite` to the organization. @@ -10320,23 +10274,35 @@ curl -X DELETE https://api.openai.com/v1/organization/invites/invite-abc \ The identifier, which can be referenced in API endpoints + - `created_at: number` + + The Unix timestamp (in seconds) of when the invite was sent. + - `email: string` The email address of the individual to whom the invite was sent - - `expires_at: number` + - `object: "organization.invite"` - The Unix timestamp (in seconds) of when the invite expires. + The object type, which is always `organization.invite` - - `invited_at: number` + - `"organization.invite"` - The Unix timestamp (in seconds) of when the invite was sent. + - `projects: array of object { id, role }` - - `object: "organization.invite"` + The projects that were granted membership upon acceptance of the invite. - The object type, which is always `organization.invite` + - `id: string` - - `"organization.invite"` + Project's public ID + + - `role: "member" or "owner"` + + Project membership role + + - `"member"` + + - `"owner"` - `role: "owner" or "reader"` @@ -10360,21 +10326,9 @@ curl -X DELETE https://api.openai.com/v1/organization/invites/invite-abc \ The Unix timestamp (in seconds) of when the invite was accepted. - - `projects: optional array of object { id, role }` - - The projects that were granted membership upon acceptance of the invite. - - - `id: optional string` - - Project's public ID - - - `role: optional "member" or "owner"` - - Project membership role - - - `"member"` + - `expires_at: optional number` - - `"owner"` + The Unix timestamp (in seconds) of when the invite expires. ### Invite Delete Response @@ -10424,38 +10378,104 @@ Lists all of the users in the organization. The Unix timestamp (in seconds) of when the user was added. - - `email: string` + - `object: "organization.user"` - The email address of the user + The object type, which is always `organization.user` - - `name: string` + - `"organization.user"` + + - `api_key_last_used_at: optional number` + + The Unix timestamp (in seconds) of the user's last API key usage. + + - `created: optional number` + + The Unix timestamp (in seconds) of when the user was created. + + - `developer_persona: optional string` + + The developer persona metadata for the user. + + - `email: optional string` + + The email address of the user + + - `is_default: optional boolean` + + Whether this is the organization's default user. + + - `is_scale_tier_authorized_purchaser: optional boolean` + + Whether the user is an authorized purchaser for Scale Tier. + + - `is_scim_managed: optional boolean` + + Whether the user is managed through SCIM. + + - `is_service_account: optional boolean` + + Whether the user is a service account. + + - `name: optional string` The name of the user - - `object: "organization.user"` + - `projects: optional object { data, object }` - The object type, which is always `organization.user` + Projects associated with the user, if included. - - `"organization.user"` + - `data: array of object { id, name, role }` - - `role: "owner" or "reader"` + - `id: optional string` + + - `name: optional string` + + - `role: optional string` + + - `object: "list"` + + - `"list"` + + - `role: optional string` `owner` or `reader` - - `"owner"` + - `technical_level: optional string` - - `"reader"` + The technical level metadata for the user. -- `first_id: string` + - `user: optional object { id, object, banned, 5 more }` -- `has_more: boolean` + Nested user details. -- `last_id: string` + - `id: string` + + - `object: "user"` + + - `"user"` + + - `banned: optional boolean` + + - `banned_at: optional number` + + - `email: optional string` + + - `enabled: optional boolean` + + - `name: optional string` + + - `picture: optional string` + +- `has_more: boolean` - `object: "list"` - `"list"` +- `first_id: optional string` + +- `last_id: optional string` + ### Example ```http @@ -10471,16 +10491,44 @@ curl https://api.openai.com/v1/organization/users \ { "id": "id", "added_at": 0, + "object": "organization.user", + "api_key_last_used_at": 0, + "created": 0, + "developer_persona": "developer_persona", "email": "email", + "is_default": true, + "is_scale_tier_authorized_purchaser": true, + "is_scim_managed": true, + "is_service_account": true, "name": "name", - "object": "organization.user", - "role": "owner" + "projects": { + "data": [ + { + "id": "id", + "name": "name", + "role": "role" } ], - "first_id": "first_id", - "has_more": true, - "last_id": "last_id", "object": "list" + }, + "role": "role", + "technical_level": "technical_level", + "user": { + "id": "id", + "object": "user", + "banned": true, + "banned_at": 0, + "email": "email", + "enabled": true, + "name": "name", + "picture": "picture" + } + } + ], + "has_more": true, + "object": "list", + "first_id": "first_id", + "last_id": "last_id" } ``` @@ -10525,7 +10573,7 @@ Retrieves a user by their identifier. ### Returns -- `OrganizationUser object { id, added_at, email, 3 more }` +- `OrganizationUser object { id, added_at, object, 13 more }` Represents an individual `user` within an organization. @@ -10537,27 +10585,93 @@ Retrieves a user by their identifier. The Unix timestamp (in seconds) of when the user was added. - - `email: string` + - `object: "organization.user"` + + The object type, which is always `organization.user` + + - `"organization.user"` + + - `api_key_last_used_at: optional number` + + The Unix timestamp (in seconds) of the user's last API key usage. + + - `created: optional number` + + The Unix timestamp (in seconds) of when the user was created. + + - `developer_persona: optional string` + + The developer persona metadata for the user. + + - `email: optional string` The email address of the user - - `name: string` + - `is_default: optional boolean` + + Whether this is the organization's default user. + + - `is_scale_tier_authorized_purchaser: optional boolean` + + Whether the user is an authorized purchaser for Scale Tier. + + - `is_scim_managed: optional boolean` + + Whether the user is managed through SCIM. + + - `is_service_account: optional boolean` + + Whether the user is a service account. + + - `name: optional string` The name of the user - - `object: "organization.user"` + - `projects: optional object { data, object }` - The object type, which is always `organization.user` + Projects associated with the user, if included. - - `"organization.user"` + - `data: array of object { id, name, role }` - - `role: "owner" or "reader"` + - `id: optional string` + + - `name: optional string` + + - `role: optional string` + + - `object: "list"` + + - `"list"` + + - `role: optional string` `owner` or `reader` - - `"owner"` + - `technical_level: optional string` - - `"reader"` + The technical level metadata for the user. + + - `user: optional object { id, object, banned, 5 more }` + + Nested user details. + + - `id: string` + + - `object: "user"` + + - `"user"` + + - `banned: optional boolean` + + - `banned_at: optional number` + + - `email: optional string` + + - `enabled: optional boolean` + + - `name: optional string` + + - `picture: optional string` ### Example @@ -10572,10 +10686,38 @@ curl https://api.openai.com/v1/organization/users/$USER_ID \ { "id": "id", "added_at": 0, + "object": "organization.user", + "api_key_last_used_at": 0, + "created": 0, + "developer_persona": "developer_persona", "email": "email", + "is_default": true, + "is_scale_tier_authorized_purchaser": true, + "is_scim_managed": true, + "is_service_account": true, "name": "name", - "object": "organization.user", - "role": "owner" + "projects": { + "data": [ + { + "id": "id", + "name": "name", + "role": "role" + } + ], + "object": "list" + }, + "role": "role", + "technical_level": "technical_level", + "user": { + "id": "id", + "object": "user", + "banned": true, + "banned_at": 0, + "email": "email", + "enabled": true, + "name": "name", + "picture": "picture" + } } ``` @@ -10612,17 +10754,25 @@ Modifies a user's role in the organization. ### Body Parameters -- `role: "owner" or "reader"` +- `developer_persona: optional string` + + Developer persona metadata. + +- `role: optional string` `owner` or `reader` - - `"owner"` +- `role_id: optional string` - - `"reader"` + Role ID to assign to the user. + +- `technical_level: optional string` + + Technical level metadata. ### Returns -- `OrganizationUser object { id, added_at, email, 3 more }` +- `OrganizationUser object { id, added_at, object, 13 more }` Represents an individual `user` within an organization. @@ -10634,27 +10784,93 @@ Modifies a user's role in the organization. The Unix timestamp (in seconds) of when the user was added. - - `email: string` + - `object: "organization.user"` + + The object type, which is always `organization.user` + + - `"organization.user"` + + - `api_key_last_used_at: optional number` + + The Unix timestamp (in seconds) of the user's last API key usage. + + - `created: optional number` + + The Unix timestamp (in seconds) of when the user was created. + + - `developer_persona: optional string` + + The developer persona metadata for the user. + + - `email: optional string` The email address of the user - - `name: string` + - `is_default: optional boolean` + + Whether this is the organization's default user. + + - `is_scale_tier_authorized_purchaser: optional boolean` + + Whether the user is an authorized purchaser for Scale Tier. + + - `is_scim_managed: optional boolean` + + Whether the user is managed through SCIM. + + - `is_service_account: optional boolean` + + Whether the user is a service account. + + - `name: optional string` The name of the user - - `object: "organization.user"` + - `projects: optional object { data, object }` - The object type, which is always `organization.user` + Projects associated with the user, if included. - - `"organization.user"` + - `data: array of object { id, name, role }` - - `role: "owner" or "reader"` + - `id: optional string` + + - `name: optional string` + + - `role: optional string` + + - `object: "list"` + + - `"list"` + + - `role: optional string` `owner` or `reader` - - `"owner"` + - `technical_level: optional string` - - `"reader"` + The technical level metadata for the user. + + - `user: optional object { id, object, banned, 5 more }` + + Nested user details. + + - `id: string` + + - `object: "user"` + + - `"user"` + + - `banned: optional boolean` + + - `banned_at: optional number` + + - `email: optional string` + + - `enabled: optional boolean` + + - `name: optional string` + + - `picture: optional string` ### Example @@ -10662,9 +10878,7 @@ Modifies a user's role in the organization. curl https://api.openai.com/v1/organization/users/$USER_ID \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ - -d '{ - "role": "owner" - }' + -d '{}' ``` #### Response @@ -10673,10 +10887,38 @@ curl https://api.openai.com/v1/organization/users/$USER_ID \ { "id": "id", "added_at": 0, + "object": "organization.user", + "api_key_last_used_at": 0, + "created": 0, + "developer_persona": "developer_persona", "email": "email", + "is_default": true, + "is_scale_tier_authorized_purchaser": true, + "is_scim_managed": true, + "is_service_account": true, "name": "name", - "object": "organization.user", - "role": "owner" + "projects": { + "data": [ + { + "id": "id", + "name": "name", + "role": "role" + } + ], + "object": "list" + }, + "role": "role", + "technical_level": "technical_level", + "user": { + "id": "id", + "object": "user", + "banned": true, + "banned_at": 0, + "email": "email", + "enabled": true, + "name": "name", + "picture": "picture" + } } ``` @@ -10764,7 +11006,7 @@ curl -X DELETE https://api.openai.com/v1/organization/users/user_abc \ ### Organization User -- `OrganizationUser object { id, added_at, email, 3 more }` +- `OrganizationUser object { id, added_at, object, 13 more }` Represents an individual `user` within an organization. @@ -10776,27 +11018,93 @@ curl -X DELETE https://api.openai.com/v1/organization/users/user_abc \ The Unix timestamp (in seconds) of when the user was added. - - `email: string` + - `object: "organization.user"` + + The object type, which is always `organization.user` + + - `"organization.user"` + + - `api_key_last_used_at: optional number` + + The Unix timestamp (in seconds) of the user's last API key usage. + + - `created: optional number` + + The Unix timestamp (in seconds) of when the user was created. + + - `developer_persona: optional string` + + The developer persona metadata for the user. + + - `email: optional string` The email address of the user - - `name: string` + - `is_default: optional boolean` + + Whether this is the organization's default user. + + - `is_scale_tier_authorized_purchaser: optional boolean` + + Whether the user is an authorized purchaser for Scale Tier. + + - `is_scim_managed: optional boolean` + + Whether the user is managed through SCIM. + + - `is_service_account: optional boolean` + + Whether the user is a service account. + + - `name: optional string` The name of the user - - `object: "organization.user"` + - `projects: optional object { data, object }` - The object type, which is always `organization.user` + Projects associated with the user, if included. - - `"organization.user"` + - `data: array of object { id, name, role }` - - `role: "owner" or "reader"` + - `id: optional string` + + - `name: optional string` + + - `role: optional string` + + - `object: "list"` + + - `"list"` + + - `role: optional string` `owner` or `reader` - - `"owner"` + - `technical_level: optional string` - - `"reader"` + The technical level metadata for the user. + + - `user: optional object { id, object, banned, 5 more }` + + Nested user details. + + - `id: string` + + - `object: "user"` + + - `"user"` + + - `banned: optional boolean` + + - `banned_at: optional number` + + - `email: optional string` + + - `enabled: optional boolean` + + - `name: optional string` + + - `picture: optional string` ### User Delete Response @@ -11052,27 +11360,93 @@ Assigns an organization role to a user within the organization. The Unix timestamp (in seconds) of when the user was added. - - `email: string` + - `object: "organization.user"` + + The object type, which is always `organization.user` + + - `"organization.user"` + + - `api_key_last_used_at: optional number` + + The Unix timestamp (in seconds) of the user's last API key usage. + + - `created: optional number` + + The Unix timestamp (in seconds) of when the user was created. + + - `developer_persona: optional string` + + The developer persona metadata for the user. + + - `email: optional string` The email address of the user - - `name: string` + - `is_default: optional boolean` + + Whether this is the organization's default user. + + - `is_scale_tier_authorized_purchaser: optional boolean` + + Whether the user is an authorized purchaser for Scale Tier. + + - `is_scim_managed: optional boolean` + + Whether the user is managed through SCIM. + + - `is_service_account: optional boolean` + + Whether the user is a service account. + + - `name: optional string` The name of the user - - `object: "organization.user"` + - `projects: optional object { data, object }` - The object type, which is always `organization.user` + Projects associated with the user, if included. - - `"organization.user"` + - `data: array of object { id, name, role }` - - `role: "owner" or "reader"` + - `id: optional string` + + - `name: optional string` + + - `role: optional string` + + - `object: "list"` + + - `"list"` + + - `role: optional string` `owner` or `reader` - - `"owner"` + - `technical_level: optional string` - - `"reader"` + The technical level metadata for the user. + + - `user: optional object { id, object, banned, 5 more }` + + Nested user details. + + - `id: string` + + - `object: "user"` + + - `"user"` + + - `banned: optional boolean` + + - `banned_at: optional number` + + - `email: optional string` + + - `enabled: optional boolean` + + - `name: optional string` + + - `picture: optional string` ### Example @@ -11104,10 +11478,38 @@ curl https://api.openai.com/v1/organization/users/$USER_ID/roles \ "user": { "id": "id", "added_at": 0, + "object": "organization.user", + "api_key_last_used_at": 0, + "created": 0, + "developer_persona": "developer_persona", "email": "email", + "is_default": true, + "is_scale_tier_authorized_purchaser": true, + "is_scim_managed": true, + "is_service_account": true, "name": "name", - "object": "organization.user", - "role": "owner" + "projects": { + "data": [ + { + "id": "id", + "name": "name", + "role": "role" + } + ], + "object": "list" + }, + "role": "role", + "technical_level": "technical_level", + "user": { + "id": "id", + "object": "user", + "banned": true, + "banned_at": 0, + "email": "email", + "enabled": true, + "name": "name", + "picture": "picture" + } } } ``` @@ -11317,27 +11719,93 @@ curl -X DELETE https://api.openai.com/v1/organization/users/user_abc123/roles/ro The Unix timestamp (in seconds) of when the user was added. - - `email: string` + - `object: "organization.user"` + + The object type, which is always `organization.user` + + - `"organization.user"` + + - `api_key_last_used_at: optional number` + + The Unix timestamp (in seconds) of the user's last API key usage. + + - `created: optional number` + + The Unix timestamp (in seconds) of when the user was created. + + - `developer_persona: optional string` + + The developer persona metadata for the user. + + - `email: optional string` The email address of the user - - `name: string` + - `is_default: optional boolean` + + Whether this is the organization's default user. + + - `is_scale_tier_authorized_purchaser: optional boolean` + + Whether the user is an authorized purchaser for Scale Tier. + + - `is_scim_managed: optional boolean` + + Whether the user is managed through SCIM. + + - `is_service_account: optional boolean` + + Whether the user is a service account. + + - `name: optional string` The name of the user - - `object: "organization.user"` + - `projects: optional object { data, object }` - The object type, which is always `organization.user` + Projects associated with the user, if included. - - `"organization.user"` + - `data: array of object { id, name, role }` - - `role: "owner" or "reader"` + - `id: optional string` + + - `name: optional string` + + - `role: optional string` + + - `object: "list"` + + - `"list"` + + - `role: optional string` `owner` or `reader` - - `"owner"` + - `technical_level: optional string` - - `"reader"` + The technical level metadata for the user. + + - `user: optional object { id, object, banned, 5 more }` + + Nested user details. + + - `id: string` + + - `object: "user"` + + - `"user"` + + - `banned: optional boolean` + + - `banned_at: optional number` + + - `email: optional string` + + - `enabled: optional boolean` + + - `name: optional string` + + - `picture: optional string` ### Role Delete Response @@ -11393,6 +11861,10 @@ Lists all groups in the organization. Unix timestamp (in seconds) when the group was created. + - `group_type: string` + + The type of the group. + - `is_scim_managed: boolean` Whether the group is managed through SCIM and controlled by your identity provider. @@ -11430,6 +11902,7 @@ curl https://api.openai.com/v1/organization/groups \ { "id": "id", "created_at": 0, + "group_type": "group_type", "is_scim_managed": true, "name": "name" } @@ -11481,7 +11954,7 @@ Creates a new group in the organization. ### Returns -- `Group object { id, created_at, is_scim_managed, name }` +- `Group object { id, created_at, group_type, 2 more }` Details about an organization group. @@ -11493,6 +11966,10 @@ Creates a new group in the organization. Unix timestamp (in seconds) when the group was created. + - `group_type: string` + + The type of the group. + - `is_scim_managed: boolean` Whether the group is managed through SCIM and controlled by your identity provider. @@ -11518,6 +11995,7 @@ curl https://api.openai.com/v1/organization/groups \ { "id": "id", "created_at": 0, + "group_type": "group_type", "is_scim_managed": true, "name": "name" } @@ -11690,7 +12168,7 @@ curl -X DELETE https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ ### Group -- `Group object { id, created_at, is_scim_managed, name }` +- `Group object { id, created_at, group_type, 2 more }` Details about an organization group. @@ -11702,6 +12180,10 @@ curl -X DELETE https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ Unix timestamp (in seconds) when the group was created. + - `group_type: string` + + The type of the group. + - `is_scim_managed: boolean` Whether the group is managed through SCIM and controlled by your identity provider. @@ -11784,39 +12266,21 @@ Lists the users assigned to a group. ### Returns -- `data: array of OrganizationUser` - - Users in the current page. - - - `id: string` - - The identifier, which can be referenced in API endpoints - - - `added_at: number` - - The Unix timestamp (in seconds) of when the user was added. - - - `email: string` - - The email address of the user - - - `name: string` - - The name of the user +- `data: array of OrganizationGroupUser` - - `object: "organization.user"` + Users in the current page. - The object type, which is always `organization.user` + - `id: string` - - `"organization.user"` + The identifier, which can be referenced in API endpoints - - `role: "owner" or "reader"` + - `email: string` - `owner` or `reader` + The email address of the user. - - `"owner"` + - `name: string` - - `"reader"` + The name of the user. - `has_more: boolean` @@ -11846,11 +12310,8 @@ curl https://api.openai.com/v1/organization/groups/$GROUP_ID/users \ "data": [ { "id": "id", - "added_at": 0, "email": "email", - "name": "name", - "object": "organization.user", - "role": "owner" + "name": "name" } ], "has_more": true, @@ -11874,12 +12335,9 @@ curl https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/users?lim "object": "list", "data": [ { - "object": "organization.user", "id": "user_abc123", "name": "Ada Lovelace", - "email": "ada@example.com", - "role": "owner", - "added_at": 1711471533 + "email": "ada@example.com" } ], "has_more": false, @@ -12021,6 +12479,24 @@ curl -X DELETE https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ ## Domain Types +### Organization Group User + +- `OrganizationGroupUser object { id, email, name }` + + Represents an individual user returned when inspecting group membership. + + - `id: string` + + The identifier, which can be referenced in API endpoints + + - `email: string` + + The email address of the user. + + - `name: string` + + The name of the user. + ### User Create Response - `UserCreateResponse object { group_id, object, user_id }` @@ -13105,17 +13581,17 @@ List uploaded certificates for this organization. ### Returns -- `data: array of Certificate` +- `data: array of object { id, active, certificate_details, 3 more }` - `id: string` The identifier, which can be referenced in API endpoints - - `certificate_details: object { content, expires_at, valid_at }` + - `active: boolean` - - `content: optional string` + Whether the certificate is currently active at the organization level. - The content of the certificate in PEM format. + - `certificate_details: object { expires_at, valid_at }` - `expires_at: optional number` @@ -13133,34 +13609,22 @@ List uploaded certificates for this organization. The name of the certificate. - - `object: "certificate" or "organization.certificate" or "organization.project.certificate"` - - The object type. - - - If creating, updating, or getting a specific certificate, the object type is `certificate`. - - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`. - - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`. + - `object: "organization.certificate"` - - `"certificate"` + The object type, which is always `organization.certificate`. - `"organization.certificate"` - - `"organization.project.certificate"` - - - `active: optional boolean` - - Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate. +- `first_id: string` - `has_more: boolean` +- `last_id: string` + - `object: "list"` - `"list"` -- `first_id: optional string` - -- `last_id: optional string` - ### Example ```http @@ -13175,21 +13639,20 @@ curl https://api.openai.com/v1/organization/certificates \ "data": [ { "id": "id", + "active": true, "certificate_details": { - "content": "content", "expires_at": 0, "valid_at": 0 }, "created_at": 0, "name": "name", - "object": "certificate", - "active": true + "object": "organization.certificate" } ], - "has_more": true, - "object": "list", "first_id": "cert_abc", - "last_id": "cert_abc" + "has_more": true, + "last_id": "cert_abc", + "object": "list" } ``` @@ -13234,7 +13697,7 @@ Organizations can upload up to 50 certificates. ### Body Parameters -- `content: string` +- `certificate: string` The certificate content in PEM format @@ -13299,7 +13762,7 @@ curl https://api.openai.com/v1/organization/certificates \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ -d '{ - "content": "content" + "certificate": "certificate" }' ``` @@ -13476,7 +13939,7 @@ Modify a certificate. Note that only the name can be modified. ### Body Parameters -- `name: string` +- `name: optional string` The updated name for the certificate @@ -13536,9 +13999,7 @@ Modify a certificate. Note that only the name can be modified. curl https://api.openai.com/v1/organization/certificates/$CERTIFICATE_ID \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ - -d '{ - "name": "name" - }' + -d '{}' ``` #### Response @@ -13655,17 +14116,17 @@ You can atomically and idempotently activate up to 10 certificates at a time. ### Returns -- `data: array of Certificate` +- `data: array of object { id, active, certificate_details, 3 more }` - `id: string` The identifier, which can be referenced in API endpoints - - `certificate_details: object { content, expires_at, valid_at }` + - `active: boolean` - - `content: optional string` + Whether the certificate is currently active at the organization level. - The content of the certificate in PEM format. + - `certificate_details: object { expires_at, valid_at }` - `expires_at: optional number` @@ -13683,33 +14144,17 @@ You can atomically and idempotently activate up to 10 certificates at a time. The name of the certificate. - - `object: "certificate" or "organization.certificate" or "organization.project.certificate"` - - The object type. - - - If creating, updating, or getting a specific certificate, the object type is `certificate`. - - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`. - - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`. + - `object: "organization.certificate"` - - `"certificate"` + The object type, which is always `organization.certificate`. - `"organization.certificate"` - - `"organization.project.certificate"` - - - `active: optional boolean` - - Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate. - -- `has_more: boolean` - -- `object: "list"` - - - `"list"` +- `object: "organization.certificate.activation"` -- `first_id: optional string` + The organization certificate activation result type. -- `last_id: optional string` + - `"organization.certificate.activation"` ### Example @@ -13731,21 +14176,17 @@ curl https://api.openai.com/v1/organization/certificates/activate \ "data": [ { "id": "id", + "active": true, "certificate_details": { - "content": "content", "expires_at": 0, "valid_at": 0 }, "created_at": 0, "name": "name", - "object": "certificate", - "active": true + "object": "organization.certificate" } ], - "has_more": true, - "object": "list", - "first_id": "cert_abc", - "last_id": "cert_abc" + "object": "organization.certificate.activation" } ``` @@ -13756,7 +14197,7 @@ curl https://api.openai.com/v1/organization/certificates/activate \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ -H "Content-Type: application/json" \ -d '{ - "data": ["cert_abc", "cert_def"] + "certificate_ids": ["cert_abc", "cert_def"] }' ``` @@ -13806,17 +14247,17 @@ You can atomically and idempotently deactivate up to 10 certificates at a time. ### Returns -- `data: array of Certificate` +- `data: array of object { id, active, certificate_details, 3 more }` - `id: string` The identifier, which can be referenced in API endpoints - - `certificate_details: object { content, expires_at, valid_at }` + - `active: boolean` - - `content: optional string` + Whether the certificate is currently active at the organization level. - The content of the certificate in PEM format. + - `certificate_details: object { expires_at, valid_at }` - `expires_at: optional number` @@ -13834,33 +14275,17 @@ You can atomically and idempotently deactivate up to 10 certificates at a time. The name of the certificate. - - `object: "certificate" or "organization.certificate" or "organization.project.certificate"` - - The object type. - - - If creating, updating, or getting a specific certificate, the object type is `certificate`. - - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`. - - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`. + - `object: "organization.certificate"` - - `"certificate"` + The object type, which is always `organization.certificate`. - `"organization.certificate"` - - `"organization.project.certificate"` - - - `active: optional boolean` - - Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate. - -- `has_more: boolean` - -- `object: "list"` - - - `"list"` +- `object: "organization.certificate.deactivation"` -- `first_id: optional string` + The organization certificate deactivation result type. -- `last_id: optional string` + - `"organization.certificate.deactivation"` ### Example @@ -13882,21 +14307,17 @@ curl https://api.openai.com/v1/organization/certificates/deactivate \ "data": [ { "id": "id", + "active": true, "certificate_details": { - "content": "content", "expires_at": 0, "valid_at": 0 }, "created_at": 0, "name": "name", - "object": "certificate", - "active": true + "object": "organization.certificate" } ], - "has_more": true, - "object": "list", - "first_id": "cert_abc", - "last_id": "cert_abc" + "object": "organization.certificate.deactivation" } ``` @@ -13907,7 +14328,7 @@ curl https://api.openai.com/v1/organization/certificates/deactivate \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ -H "Content-Type: application/json" \ -d '{ - "data": ["cert_abc", "cert_def"] + "certificate_ids": ["cert_abc", "cert_def"] }' ``` @@ -13955,11 +14376,151 @@ curl https://api.openai.com/v1/organization/certificates/deactivate \ The identifier, which can be referenced in API endpoints - - `certificate_details: object { content, expires_at, valid_at }` + - `certificate_details: object { content, expires_at, valid_at }` + + - `content: optional string` + + The content of the certificate in PEM format. + + - `expires_at: optional number` + + The Unix timestamp (in seconds) of when the certificate expires. + + - `valid_at: optional number` + + The Unix timestamp (in seconds) of when the certificate becomes valid. + + - `created_at: number` + + The Unix timestamp (in seconds) of when the certificate was uploaded. + + - `name: string` + + The name of the certificate. + + - `object: "certificate" or "organization.certificate" or "organization.project.certificate"` + + The object type. + + - If creating, updating, or getting a specific certificate, the object type is `certificate`. + - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`. + - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`. + + - `"certificate"` + + - `"organization.certificate"` + + - `"organization.project.certificate"` + + - `active: optional boolean` + + Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate. + +### Certificate List Response + +- `CertificateListResponse object { id, active, certificate_details, 3 more }` + + Represents an individual certificate configured at the organization level. + + - `id: string` + + The identifier, which can be referenced in API endpoints + + - `active: boolean` + + Whether the certificate is currently active at the organization level. + + - `certificate_details: object { expires_at, valid_at }` + + - `expires_at: optional number` + + The Unix timestamp (in seconds) of when the certificate expires. + + - `valid_at: optional number` + + The Unix timestamp (in seconds) of when the certificate becomes valid. + + - `created_at: number` + + The Unix timestamp (in seconds) of when the certificate was uploaded. + + - `name: string` + + The name of the certificate. + + - `object: "organization.certificate"` + + The object type, which is always `organization.certificate`. + + - `"organization.certificate"` + +### Certificate Delete Response + +- `CertificateDeleteResponse object { id, object }` + + - `id: string` + + The ID of the certificate that was deleted. + + - `object: "certificate.deleted"` + + The object type, must be `certificate.deleted`. + + - `"certificate.deleted"` + +### Certificate Activate Response + +- `CertificateActivateResponse object { id, active, certificate_details, 3 more }` + + Represents an individual certificate configured at the organization level. + + - `id: string` + + The identifier, which can be referenced in API endpoints + + - `active: boolean` + + Whether the certificate is currently active at the organization level. + + - `certificate_details: object { expires_at, valid_at }` + + - `expires_at: optional number` + + The Unix timestamp (in seconds) of when the certificate expires. + + - `valid_at: optional number` + + The Unix timestamp (in seconds) of when the certificate becomes valid. + + - `created_at: number` + + The Unix timestamp (in seconds) of when the certificate was uploaded. + + - `name: string` + + The name of the certificate. + + - `object: "organization.certificate"` + + The object type, which is always `organization.certificate`. + + - `"organization.certificate"` + +### Certificate Deactivate Response + +- `CertificateDeactivateResponse object { id, active, certificate_details, 3 more }` + + Represents an individual certificate configured at the organization level. + + - `id: string` + + The identifier, which can be referenced in API endpoints + + - `active: boolean` - - `content: optional string` + Whether the certificate is currently active at the organization level. - The content of the certificate in PEM format. + - `certificate_details: object { expires_at, valid_at }` - `expires_at: optional number` @@ -13977,38 +14538,12 @@ curl https://api.openai.com/v1/organization/certificates/deactivate \ The name of the certificate. - - `object: "certificate" or "organization.certificate" or "organization.project.certificate"` - - The object type. - - - If creating, updating, or getting a specific certificate, the object type is `certificate`. - - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`. - - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`. + - `object: "organization.certificate"` - - `"certificate"` + The object type, which is always `organization.certificate`. - `"organization.certificate"` - - `"organization.project.certificate"` - - - `active: optional boolean` - - Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate. - -### Certificate Delete Response - -- `CertificateDeleteResponse object { id, object }` - - - `id: string` - - The ID of the certificate that was deleted. - - - `object: "certificate.deleted"` - - The object type, must be `certificate.deleted`. - - - `"certificate.deleted"` - # Projects ## List projects @@ -14043,38 +14578,38 @@ Returns a list of projects. The Unix timestamp (in seconds) of when the project was created. - - `name: string` - - The name of the project. This appears in reporting. - - `object: "organization.project"` The object type, which is always `organization.project` - `"organization.project"` - - `status: "active" or "archived"` + - `archived_at: optional number` - `active` or `archived` + The Unix timestamp (in seconds) of when the project was archived or `null`. - - `"active"` + - `external_key_id: optional string` - - `"archived"` + The external key associated with the project. - - `archived_at: optional number` + - `name: optional string` - The Unix timestamp (in seconds) of when the project was archived or `null`. + The name of the project. This appears in reporting. -- `first_id: string` + - `status: optional string` -- `has_more: boolean` + `active` or `archived` -- `last_id: string` +- `has_more: boolean` - `object: "list"` - `"list"` +- `first_id: optional string` + +- `last_id: optional string` + ### Example ```http @@ -14090,16 +14625,17 @@ curl https://api.openai.com/v1/organization/projects \ { "id": "id", "created_at": 0, - "name": "name", "object": "organization.project", - "status": "active", - "archived_at": 0 + "archived_at": 0, + "external_key_id": "external_key_id", + "name": "name", + "status": "status" } ], - "first_id": "first_id", "has_more": true, - "last_id": "last_id", - "object": "list" + "object": "list", + "first_id": "first_id", + "last_id": "last_id" } ``` @@ -14144,29 +14680,17 @@ Create a new project in the organization. Projects can be created and archived, The friendly name of the project, this name appears in reports. -- `geography: optional "US" or "EU" or "JP" or 5 more` - - Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field. - - - `"US"` - - - `"EU"` - - - `"JP"` - - - `"IN"` +- `external_key_id: optional string` - - `"KR"` + External key ID to associate with the project. - - `"CA"` +- `geography: optional string` - - `"AU"` - - - `"SG"` + Create the project with the specified data residency region. Your organization must have access to Data residency functionality in order to use. See [data residency controls](/docs/guides/your-data#data-residency-controls) to review the functionality and limitations of setting this field. ### Returns -- `Project object { id, created_at, name, 3 more }` +- `Project object { id, created_at, object, 4 more }` Represents an individual project. @@ -14178,27 +14702,27 @@ Create a new project in the organization. Projects can be created and archived, The Unix timestamp (in seconds) of when the project was created. - - `name: string` - - The name of the project. This appears in reporting. - - `object: "organization.project"` The object type, which is always `organization.project` - `"organization.project"` - - `status: "active" or "archived"` + - `archived_at: optional number` - `active` or `archived` + The Unix timestamp (in seconds) of when the project was archived or `null`. - - `"active"` + - `external_key_id: optional string` - - `"archived"` + The external key associated with the project. - - `archived_at: optional number` + - `name: optional string` - The Unix timestamp (in seconds) of when the project was archived or `null`. + The name of the project. This appears in reporting. + + - `status: optional string` + + `active` or `archived` ### Example @@ -14217,10 +14741,11 @@ curl https://api.openai.com/v1/organization/projects \ { "id": "id", "created_at": 0, - "name": "name", "object": "organization.project", - "status": "active", - "archived_at": 0 + "archived_at": 0, + "external_key_id": "external_key_id", + "name": "name", + "status": "status" } ``` @@ -14260,7 +14785,7 @@ Retrieves a project. ### Returns -- `Project object { id, created_at, name, 3 more }` +- `Project object { id, created_at, object, 4 more }` Represents an individual project. @@ -14272,27 +14797,27 @@ Retrieves a project. The Unix timestamp (in seconds) of when the project was created. - - `name: string` - - The name of the project. This appears in reporting. - - `object: "organization.project"` The object type, which is always `organization.project` - `"organization.project"` - - `status: "active" or "archived"` + - `archived_at: optional number` - `active` or `archived` + The Unix timestamp (in seconds) of when the project was archived or `null`. - - `"active"` + - `external_key_id: optional string` - - `"archived"` + The external key associated with the project. - - `archived_at: optional number` + - `name: optional string` - The Unix timestamp (in seconds) of when the project was archived or `null`. + The name of the project. This appears in reporting. + + - `status: optional string` + + `active` or `archived` ### Example @@ -14307,10 +14832,11 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \ { "id": "id", "created_at": 0, - "name": "name", "object": "organization.project", - "status": "active", - "archived_at": 0 + "archived_at": 0, + "external_key_id": "external_key_id", + "name": "name", + "status": "status" } ``` @@ -14347,13 +14873,21 @@ Modifies a project in the organization. ### Body Parameters -- `name: string` +- `external_key_id: optional string` + + External key ID to associate with the project. + +- `geography: optional string` + + Geography for the project. + +- `name: optional string` The updated name of the project, this name appears in reports. ### Returns -- `Project object { id, created_at, name, 3 more }` +- `Project object { id, created_at, object, 4 more }` Represents an individual project. @@ -14365,27 +14899,27 @@ Modifies a project in the organization. The Unix timestamp (in seconds) of when the project was created. - - `name: string` - - The name of the project. This appears in reporting. - - `object: "organization.project"` The object type, which is always `organization.project` - `"organization.project"` - - `status: "active" or "archived"` + - `archived_at: optional number` - `active` or `archived` + The Unix timestamp (in seconds) of when the project was archived or `null`. - - `"active"` + - `external_key_id: optional string` - - `"archived"` + The external key associated with the project. - - `archived_at: optional number` + - `name: optional string` - The Unix timestamp (in seconds) of when the project was archived or `null`. + The name of the project. This appears in reporting. + + - `status: optional string` + + `active` or `archived` ### Example @@ -14393,9 +14927,7 @@ Modifies a project in the organization. curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ - -d '{ - "name": "name" - }' + -d '{}' ``` #### Response @@ -14404,10 +14936,11 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID \ { "id": "id", "created_at": 0, - "name": "name", "object": "organization.project", - "status": "active", - "archived_at": 0 + "archived_at": 0, + "external_key_id": "external_key_id", + "name": "name", + "status": "status" } ``` @@ -14434,7 +14967,7 @@ Archives a project in the organization. Archived projects cannot be used or upda ### Returns -- `Project object { id, created_at, name, 3 more }` +- `Project object { id, created_at, object, 4 more }` Represents an individual project. @@ -14446,27 +14979,27 @@ Archives a project in the organization. Archived projects cannot be used or upda The Unix timestamp (in seconds) of when the project was created. - - `name: string` - - The name of the project. This appears in reporting. - - `object: "organization.project"` The object type, which is always `organization.project` - `"organization.project"` - - `status: "active" or "archived"` + - `archived_at: optional number` - `active` or `archived` + The Unix timestamp (in seconds) of when the project was archived or `null`. - - `"active"` + - `external_key_id: optional string` - - `"archived"` + The external key associated with the project. - - `archived_at: optional number` + - `name: optional string` - The Unix timestamp (in seconds) of when the project was archived or `null`. + The name of the project. This appears in reporting. + + - `status: optional string` + + `active` or `archived` ### Example @@ -14482,10 +15015,11 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/archive \ { "id": "id", "created_at": 0, - "name": "name", "object": "organization.project", - "status": "active", - "archived_at": 0 + "archived_at": 0, + "external_key_id": "external_key_id", + "name": "name", + "status": "status" } ``` @@ -14514,7 +15048,7 @@ curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/archive \ ### Project -- `Project object { id, created_at, name, 3 more }` +- `Project object { id, created_at, object, 4 more }` Represents an individual project. @@ -14526,27 +15060,27 @@ curl -X POST https://api.openai.com/v1/organization/projects/proj_abc/archive \ The Unix timestamp (in seconds) of when the project was created. - - `name: string` - - The name of the project. This appears in reporting. - - `object: "organization.project"` The object type, which is always `organization.project` - `"organization.project"` - - `status: "active" or "archived"` + - `archived_at: optional number` - `active` or `archived` + The Unix timestamp (in seconds) of when the project was archived or `null`. - - `"active"` + - `external_key_id: optional string` - - `"archived"` + The external key associated with the project. - - `archived_at: optional number` + - `name: optional string` - The Unix timestamp (in seconds) of when the project was archived or `null`. + The name of the project. This appears in reporting. + + - `status: optional string` + + `active` or `archived` # Users @@ -14582,36 +15116,32 @@ Returns a list of users in the project. The Unix timestamp (in seconds) of when the project was added. - - `email: string` - - The email address of the user - - - `name: string` - - The name of the user - - `object: "organization.project.user"` The object type, which is always `organization.project.user` - `"organization.project.user"` - - `role: "owner" or "member"` + - `role: string` `owner` or `member` - - `"owner"` + - `email: optional string` - - `"member"` + The email address of the user -- `first_id: string` + - `name: optional string` -- `has_more: boolean` + The name of the user -- `last_id: string` +- `has_more: boolean` - `object: string` +- `first_id: optional string` + +- `last_id: optional string` + ### Example ```http @@ -14627,16 +15157,16 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \ { "id": "id", "added_at": 0, - "email": "email", - "name": "name", "object": "organization.project.user", - "role": "owner" + "role": "role", + "email": "email", + "name": "name" } ], - "first_id": "first_id", "has_more": true, - "last_id": "last_id", - "object": "object" + "object": "object", + "first_id": "first_id", + "last_id": "last_id" } ``` @@ -14681,21 +15211,21 @@ Adds a user to the project. Users must already be members of the organization to ### Body Parameters -- `role: "owner" or "member"` +- `role: string` `owner` or `member` - - `"owner"` +- `email: optional string` - - `"member"` + Email of the user to add. -- `user_id: string` +- `user_id: optional string` The ID of the user. ### Returns -- `ProjectUser object { id, added_at, email, 3 more }` +- `ProjectUser object { id, added_at, object, 3 more }` Represents an individual user in a project. @@ -14707,27 +15237,23 @@ Adds a user to the project. Users must already be members of the organization to The Unix timestamp (in seconds) of when the project was added. - - `email: string` - - The email address of the user - - - `name: string` - - The name of the user - - `object: "organization.project.user"` The object type, which is always `organization.project.user` - `"organization.project.user"` - - `role: "owner" or "member"` + - `role: string` `owner` or `member` - - `"owner"` + - `email: optional string` - - `"member"` + The email address of the user + + - `name: optional string` + + The name of the user ### Example @@ -14736,8 +15262,7 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ -d '{ - "role": "owner", - "user_id": "user_id" + "role": "role" }' ``` @@ -14747,10 +15272,10 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users \ { "id": "id", "added_at": 0, - "email": "email", - "name": "name", "object": "organization.project.user", - "role": "owner" + "role": "role", + "email": "email", + "name": "name" } ``` @@ -14792,7 +15317,7 @@ Retrieves a user in the project. ### Returns -- `ProjectUser object { id, added_at, email, 3 more }` +- `ProjectUser object { id, added_at, object, 3 more }` Represents an individual user in a project. @@ -14804,27 +15329,23 @@ Retrieves a user in the project. The Unix timestamp (in seconds) of when the project was added. - - `email: string` - - The email address of the user - - - `name: string` - - The name of the user - - `object: "organization.project.user"` The object type, which is always `organization.project.user` - `"organization.project.user"` - - `role: "owner" or "member"` + - `role: string` `owner` or `member` - - `"owner"` + - `email: optional string` - - `"member"` + The email address of the user + + - `name: optional string` + + The name of the user ### Example @@ -14839,10 +15360,10 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID { "id": "id", "added_at": 0, - "email": "email", - "name": "name", "object": "organization.project.user", - "role": "owner" + "role": "role", + "email": "email", + "name": "name" } ``` @@ -14881,17 +15402,13 @@ Modifies a user's role in the project. ### Body Parameters -- `role: "owner" or "member"` +- `role: optional string` `owner` or `member` - - `"owner"` - - - `"member"` - ### Returns -- `ProjectUser object { id, added_at, email, 3 more }` +- `ProjectUser object { id, added_at, object, 3 more }` Represents an individual user in a project. @@ -14903,27 +15420,23 @@ Modifies a user's role in the project. The Unix timestamp (in seconds) of when the project was added. - - `email: string` - - The email address of the user - - - `name: string` - - The name of the user - - `object: "organization.project.user"` The object type, which is always `organization.project.user` - `"organization.project.user"` - - `role: "owner" or "member"` + - `role: string` `owner` or `member` - - `"owner"` + - `email: optional string` + + The email address of the user + + - `name: optional string` - - `"member"` + The name of the user ### Example @@ -14931,9 +15444,7 @@ Modifies a user's role in the project. curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ - -d '{ - "role": "owner" - }' + -d '{}' ``` #### Response @@ -14942,10 +15453,10 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/users/$USER_ID { "id": "id", "added_at": 0, - "email": "email", - "name": "name", "object": "organization.project.user", - "role": "owner" + "role": "role", + "email": "email", + "name": "name" } ``` @@ -15038,7 +15549,7 @@ curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/users/us ### Project User -- `ProjectUser object { id, added_at, email, 3 more }` +- `ProjectUser object { id, added_at, object, 3 more }` Represents an individual user in a project. @@ -15050,27 +15561,23 @@ curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/users/us The Unix timestamp (in seconds) of when the project was added. - - `email: string` - - The email address of the user - - - `name: string` - - The name of the user - - `object: "organization.project.user"` The object type, which is always `organization.project.user` - `"organization.project.user"` - - `role: "owner" or "member"` + - `role: string` `owner` or `member` - - `"owner"` + - `email: optional string` - - `"member"` + The email address of the user + + - `name: optional string` + + The name of the user ### User Delete Response @@ -15330,27 +15837,93 @@ Assigns a project role to a user within a project. The Unix timestamp (in seconds) of when the user was added. - - `email: string` + - `object: "organization.user"` + + The object type, which is always `organization.user` + + - `"organization.user"` + + - `api_key_last_used_at: optional number` + + The Unix timestamp (in seconds) of the user's last API key usage. + + - `created: optional number` + + The Unix timestamp (in seconds) of when the user was created. + + - `developer_persona: optional string` + + The developer persona metadata for the user. + + - `email: optional string` The email address of the user - - `name: string` + - `is_default: optional boolean` + + Whether this is the organization's default user. + + - `is_scale_tier_authorized_purchaser: optional boolean` + + Whether the user is an authorized purchaser for Scale Tier. + + - `is_scim_managed: optional boolean` + + Whether the user is managed through SCIM. + + - `is_service_account: optional boolean` + + Whether the user is a service account. + + - `name: optional string` The name of the user - - `object: "organization.user"` + - `projects: optional object { data, object }` - The object type, which is always `organization.user` + Projects associated with the user, if included. - - `"organization.user"` + - `data: array of object { id, name, role }` - - `role: "owner" or "reader"` + - `id: optional string` + + - `name: optional string` + + - `role: optional string` + + - `object: "list"` + + - `"list"` + + - `role: optional string` `owner` or `reader` - - `"owner"` + - `technical_level: optional string` - - `"reader"` + The technical level metadata for the user. + + - `user: optional object { id, object, banned, 5 more }` + + Nested user details. + + - `id: string` + + - `object: "user"` + + - `"user"` + + - `banned: optional boolean` + + - `banned_at: optional number` + + - `email: optional string` + + - `enabled: optional boolean` + + - `name: optional string` + + - `picture: optional string` ### Example @@ -15382,10 +15955,38 @@ curl https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles \ "user": { "id": "id", "added_at": 0, + "object": "organization.user", + "api_key_last_used_at": 0, + "created": 0, + "developer_persona": "developer_persona", "email": "email", + "is_default": true, + "is_scale_tier_authorized_purchaser": true, + "is_scim_managed": true, + "is_service_account": true, "name": "name", - "object": "organization.user", - "role": "owner" + "projects": { + "data": [ + { + "id": "id", + "name": "name", + "role": "role" + } + ], + "object": "list" + }, + "role": "role", + "technical_level": "technical_level", + "user": { + "id": "id", + "object": "user", + "banned": true, + "banned_at": 0, + "email": "email", + "enabled": true, + "name": "name", + "picture": "picture" + } } } ``` @@ -15597,27 +16198,93 @@ curl -X DELETE https://api.openai.com/v1/projects/proj_abc123/users/user_abc123/ The Unix timestamp (in seconds) of when the user was added. - - `email: string` + - `object: "organization.user"` + + The object type, which is always `organization.user` + + - `"organization.user"` + + - `api_key_last_used_at: optional number` + + The Unix timestamp (in seconds) of the user's last API key usage. + + - `created: optional number` + + The Unix timestamp (in seconds) of when the user was created. + + - `developer_persona: optional string` + + The developer persona metadata for the user. + + - `email: optional string` The email address of the user - - `name: string` + - `is_default: optional boolean` + + Whether this is the organization's default user. + + - `is_scale_tier_authorized_purchaser: optional boolean` + + Whether the user is an authorized purchaser for Scale Tier. + + - `is_scim_managed: optional boolean` + + Whether the user is managed through SCIM. + + - `is_service_account: optional boolean` + + Whether the user is a service account. + + - `name: optional string` The name of the user - - `object: "organization.user"` + - `projects: optional object { data, object }` - The object type, which is always `organization.user` + Projects associated with the user, if included. - - `"organization.user"` + - `data: array of object { id, name, role }` - - `role: "owner" or "reader"` + - `id: optional string` + + - `name: optional string` + + - `role: optional string` + + - `object: "list"` + + - `"list"` + + - `role: optional string` `owner` or `reader` - - `"owner"` + - `technical_level: optional string` - - `"reader"` + The technical level metadata for the user. + + - `user: optional object { id, object, banned, 5 more }` + + Nested user details. + + - `id: string` + + - `object: "user"` + + - `"user"` + + - `banned: optional boolean` + + - `banned_at: optional number` + + - `email: optional string` + + - `enabled: optional boolean` + + - `name: optional string` + + - `picture: optional string` ### Role Delete Response @@ -15685,16 +16352,16 @@ Returns a list of service accounts in the project. - `"member"` -- `first_id: string` - - `has_more: boolean` -- `last_id: string` - - `object: "list"` - `"list"` +- `first_id: optional string` + +- `last_id: optional string` + ### Example ```http @@ -15715,10 +16382,10 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/service_account "role": "owner" } ], - "first_id": "first_id", "has_more": true, - "last_id": "last_id", - "object": "list" + "object": "list", + "first_id": "first_id", + "last_id": "last_id" } ``` @@ -16136,9 +16803,9 @@ Returns a list of API keys in the project. - `owner: object { service_account, type, user }` - - `service_account: optional ProjectServiceAccount` + - `service_account: optional object { id, created_at, name, role }` - Represents an individual service account in a project. + The service account that owns a project API key. - `id: string` @@ -16146,25 +16813,15 @@ Returns a list of API keys in the project. - `created_at: number` - The Unix timestamp (in seconds) of when the service account was created + The Unix timestamp (in seconds) of when the service account was created. - `name: string` - The name of the service account - - - `object: "organization.project.service_account"` - - The object type, which is always `organization.project.service_account` - - - `"organization.project.service_account"` - - - `role: "owner" or "member"` - - `owner` or `member` + The name of the service account. - - `"owner"` + - `role: string` - - `"member"` + The service account's project role. - `type: optional "user" or "service_account"` @@ -16174,54 +16831,44 @@ Returns a list of API keys in the project. - `"service_account"` - - `user: optional ProjectUser` + - `user: optional object { id, created_at, email, 2 more }` - Represents an individual user in a project. + The user that owns a project API key. - `id: string` The identifier, which can be referenced in API endpoints - - `added_at: number` + - `created_at: number` - The Unix timestamp (in seconds) of when the project was added. + The Unix timestamp (in seconds) of when the user was created. - `email: string` - The email address of the user + The email address of the user. - `name: string` - The name of the user - - - `object: "organization.project.user"` - - The object type, which is always `organization.project.user` - - - `"organization.project.user"` - - - `role: "owner" or "member"` - - `owner` or `member` + The name of the user. - - `"owner"` + - `role: string` - - `"member"` + The user's project role. - `redacted_value: string` The redacted value of the API key -- `first_id: string` - - `has_more: boolean` -- `last_id: string` - - `object: "list"` - `"list"` +- `first_id: optional string` + +- `last_id: optional string` + ### Example ```http @@ -16245,26 +16892,24 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys \ "id": "id", "created_at": 0, "name": "name", - "object": "organization.project.service_account", - "role": "owner" + "role": "role" }, "type": "user", "user": { "id": "id", - "added_at": 0, + "created_at": 0, "email": "email", "name": "name", - "object": "organization.project.user", - "role": "owner" + "role": "role" } }, "redacted_value": "redacted_value" } ], - "first_id": "first_id", "has_more": true, - "last_id": "last_id", - "object": "list" + "object": "list", + "first_id": "first_id", + "last_id": "last_id" } ``` @@ -16292,12 +16937,11 @@ curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key "owner": { "type": "user", "user": { - "object": "organization.project.user", "id": "user_abc", "name": "First Last", "email": "user@example.com", "role": "owner", - "added_at": 1711471533 + "created_at": 1711471533 } } } @@ -16310,7 +16954,7 @@ curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys?after=key ## Retrieve project API key -**get** `/organization/projects/{project_id}/api_keys/{key_id}` +**get** `/organization/projects/{project_id}/api_keys/{api_key_id}` Retrieves an API key in the project. @@ -16318,7 +16962,7 @@ Retrieves an API key in the project. - `project_id: string` -- `key_id: string` +- `api_key_id: string` ### Returns @@ -16350,9 +16994,9 @@ Retrieves an API key in the project. - `owner: object { service_account, type, user }` - - `service_account: optional ProjectServiceAccount` + - `service_account: optional object { id, created_at, name, role }` - Represents an individual service account in a project. + The service account that owns a project API key. - `id: string` @@ -16360,25 +17004,15 @@ Retrieves an API key in the project. - `created_at: number` - The Unix timestamp (in seconds) of when the service account was created + The Unix timestamp (in seconds) of when the service account was created. - `name: string` - The name of the service account - - - `object: "organization.project.service_account"` - - The object type, which is always `organization.project.service_account` - - - `"organization.project.service_account"` - - - `role: "owner" or "member"` - - `owner` or `member` + The name of the service account. - - `"owner"` + - `role: string` - - `"member"` + The service account's project role. - `type: optional "user" or "service_account"` @@ -16388,39 +17022,29 @@ Retrieves an API key in the project. - `"service_account"` - - `user: optional ProjectUser` + - `user: optional object { id, created_at, email, 2 more }` - Represents an individual user in a project. + The user that owns a project API key. - `id: string` The identifier, which can be referenced in API endpoints - - `added_at: number` + - `created_at: number` - The Unix timestamp (in seconds) of when the project was added. + The Unix timestamp (in seconds) of when the user was created. - `email: string` - The email address of the user - - - `name: string` - - The name of the user - - - `object: "organization.project.user"` - - The object type, which is always `organization.project.user` - - - `"organization.project.user"` + The email address of the user. - - `role: "owner" or "member"` + - `name: string` - `owner` or `member` + The name of the user. - - `"owner"` + - `role: string` - - `"member"` + The user's project role. - `redacted_value: string` @@ -16429,7 +17053,7 @@ Retrieves an API key in the project. ### Example ```http -curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \ +curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$API_KEY_ID \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" ``` @@ -16447,17 +17071,15 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_I "id": "id", "created_at": 0, "name": "name", - "object": "organization.project.service_account", - "role": "owner" + "role": "role" }, "type": "user", "user": { "id": "id", - "added_at": 0, + "created_at": 0, "email": "email", "name": "name", - "object": "organization.project.user", - "role": "owner" + "role": "role" } }, "redacted_value": "redacted_value" @@ -16485,12 +17107,11 @@ curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys/key_abc \ "owner": { "type": "user", "user": { - "object": "organization.project.user", "id": "user_abc", "name": "First Last", "email": "user@example.com", "role": "owner", - "added_at": 1711471533 + "created_at": 1711471533 } } } @@ -16498,7 +17119,7 @@ curl https://api.openai.com/v1/organization/projects/proj_abc/api_keys/key_abc \ ## Delete project API key -**delete** `/organization/projects/{project_id}/api_keys/{key_id}` +**delete** `/organization/projects/{project_id}/api_keys/{api_key_id}` Deletes an API key from the project. @@ -16509,7 +17130,7 @@ a service account. - `project_id: string` -- `key_id: string` +- `api_key_id: string` ### Returns @@ -16524,7 +17145,7 @@ a service account. ### Example ```http -curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$KEY_ID \ +curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$API_KEY_ID \ -X DELETE \ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" ``` @@ -16589,9 +17210,9 @@ curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/api_keys - `owner: object { service_account, type, user }` - - `service_account: optional ProjectServiceAccount` + - `service_account: optional object { id, created_at, name, role }` - Represents an individual service account in a project. + The service account that owns a project API key. - `id: string` @@ -16599,25 +17220,15 @@ curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/api_keys - `created_at: number` - The Unix timestamp (in seconds) of when the service account was created + The Unix timestamp (in seconds) of when the service account was created. - `name: string` - The name of the service account - - - `object: "organization.project.service_account"` - - The object type, which is always `organization.project.service_account` - - - `"organization.project.service_account"` - - - `role: "owner" or "member"` - - `owner` or `member` + The name of the service account. - - `"owner"` + - `role: string` - - `"member"` + The service account's project role. - `type: optional "user" or "service_account"` @@ -16627,39 +17238,29 @@ curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc/api_keys - `"service_account"` - - `user: optional ProjectUser` + - `user: optional object { id, created_at, email, 2 more }` - Represents an individual user in a project. + The user that owns a project API key. - `id: string` The identifier, which can be referenced in API endpoints - - `added_at: number` + - `created_at: number` - The Unix timestamp (in seconds) of when the project was added. + The Unix timestamp (in seconds) of when the user was created. - `email: string` - The email address of the user + The email address of the user. - `name: string` - The name of the user - - - `object: "organization.project.user"` - - The object type, which is always `organization.project.user` - - - `"organization.project.user"` - - - `role: "owner" or "member"` - - `owner` or `member` + The name of the user. - - `"owner"` + - `role: string` - - `"member"` + The user's project role. - `redacted_value: string` @@ -16745,16 +17346,16 @@ Returns the rate limits per model for a project. The maximum requests per day. Only present for relevant models. -- `first_id: string` - - `has_more: boolean` -- `last_id: string` - - `object: "list"` - `"list"` +- `first_id: optional string` + +- `last_id: optional string` + ### Example ```http @@ -16779,10 +17380,10 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/rate_limits \ "max_requests_per_1_day": 0 } ], - "first_id": "first_id", "has_more": true, - "last_id": "last_id", - "object": "list" + "object": "list", + "first_id": "first_id", + "last_id": "last_id" } ``` @@ -17040,6 +17641,10 @@ Lists the groups that have access to a project. Display name of the group. + - `group_type: string` + + The type of the group. + - `object: "project.group"` Always `project.group`. @@ -17080,6 +17685,7 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups \ "created_at": 0, "group_id": "group_id", "group_name": "group_name", + "group_type": "group_type", "object": "project.group", "project_id": "project_id" } @@ -17139,7 +17745,7 @@ Grants a group access to a project. ### Returns -- `ProjectGroup object { created_at, group_id, group_name, 2 more }` +- `ProjectGroup object { created_at, group_id, group_name, 3 more }` Details about a group's membership in a project. @@ -17155,6 +17761,10 @@ Grants a group access to a project. Display name of the group. + - `group_type: string` + + The type of the group. + - `object: "project.group"` Always `project.group`. @@ -17184,6 +17794,7 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/groups \ "created_at": 0, "group_id": "group_id", "group_name": "group_name", + "group_type": "group_type", "object": "project.group", "project_id": "project_id" } @@ -17275,7 +17886,7 @@ curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc123/group ### Project Group -- `ProjectGroup object { created_at, group_id, group_name, 2 more }` +- `ProjectGroup object { created_at, group_id, group_name, 3 more }` Details about a group's membership in a project. @@ -17291,6 +17902,10 @@ curl -X DELETE https://api.openai.com/v1/organization/projects/proj_abc123/group Display name of the group. + - `group_type: string` + + The type of the group. + - `object: "project.group"` Always `project.group`. @@ -18351,17 +18966,17 @@ List certificates for this project. ### Returns -- `data: array of Certificate` +- `data: array of object { id, active, certificate_details, 3 more }` - `id: string` The identifier, which can be referenced in API endpoints - - `certificate_details: object { content, expires_at, valid_at }` + - `active: boolean` - - `content: optional string` + Whether the certificate is currently active at the project level. - The content of the certificate in PEM format. + - `certificate_details: object { expires_at, valid_at }` - `expires_at: optional number` @@ -18379,34 +18994,22 @@ List certificates for this project. The name of the certificate. - - `object: "certificate" or "organization.certificate" or "organization.project.certificate"` - - The object type. - - - If creating, updating, or getting a specific certificate, the object type is `certificate`. - - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`. - - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`. - - - `"certificate"` + - `object: "organization.project.certificate"` - - `"organization.certificate"` + The object type, which is always `organization.project.certificate`. - `"organization.project.certificate"` - - `active: optional boolean` - - Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate. +- `first_id: string` - `has_more: boolean` +- `last_id: string` + - `object: "list"` - `"list"` -- `first_id: optional string` - -- `last_id: optional string` - ### Example ```http @@ -18421,21 +19024,20 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/certificates \ "data": [ { "id": "id", + "active": true, "certificate_details": { - "content": "content", "expires_at": 0, "valid_at": 0 }, "created_at": 0, "name": "name", - "object": "certificate", - "active": true + "object": "organization.project.certificate" } ], - "has_more": true, - "object": "list", "first_id": "cert_abc", - "last_id": "cert_abc" + "has_more": true, + "last_id": "cert_abc", + "object": "list" } ``` @@ -18488,17 +19090,17 @@ You can atomically and idempotently activate up to 10 certificates at a time. ### Returns -- `data: array of Certificate` +- `data: array of object { id, active, certificate_details, 3 more }` - `id: string` The identifier, which can be referenced in API endpoints - - `certificate_details: object { content, expires_at, valid_at }` + - `active: boolean` - - `content: optional string` + Whether the certificate is currently active at the project level. - The content of the certificate in PEM format. + - `certificate_details: object { expires_at, valid_at }` - `expires_at: optional number` @@ -18516,33 +19118,17 @@ You can atomically and idempotently activate up to 10 certificates at a time. The name of the certificate. - - `object: "certificate" or "organization.certificate" or "organization.project.certificate"` - - The object type. - - - If creating, updating, or getting a specific certificate, the object type is `certificate`. - - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`. - - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`. - - - `"certificate"` + - `object: "organization.project.certificate"` - - `"organization.certificate"` + The object type, which is always `organization.project.certificate`. - `"organization.project.certificate"` - - `active: optional boolean` - - Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate. - -- `has_more: boolean` - -- `object: "list"` - - - `"list"` +- `object: "organization.project.certificate.activation"` -- `first_id: optional string` + The project certificate activation result type. -- `last_id: optional string` + - `"organization.project.certificate.activation"` ### Example @@ -18564,21 +19150,17 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/certificates/ac "data": [ { "id": "id", + "active": true, "certificate_details": { - "content": "content", "expires_at": 0, "valid_at": 0 }, "created_at": 0, "name": "name", - "object": "certificate", - "active": true + "object": "organization.project.certificate" } ], - "has_more": true, - "object": "list", - "first_id": "cert_abc", - "last_id": "cert_abc" + "object": "organization.project.certificate.activation" } ``` @@ -18589,7 +19171,7 @@ curl https://api.openai.com/v1/organization/projects/proj_abc/certificates/activ -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ -H "Content-Type: application/json" \ -d '{ - "data": ["cert_abc", "cert_def"] + "certificate_ids": ["cert_abc", "cert_def"] }' ``` @@ -18642,17 +19224,17 @@ idempotently deactivate up to 10 certificates at a time. ### Returns -- `data: array of Certificate` +- `data: array of object { id, active, certificate_details, 3 more }` - `id: string` The identifier, which can be referenced in API endpoints - - `certificate_details: object { content, expires_at, valid_at }` + - `active: boolean` - - `content: optional string` + Whether the certificate is currently active at the project level. - The content of the certificate in PEM format. + - `certificate_details: object { expires_at, valid_at }` - `expires_at: optional number` @@ -18670,33 +19252,17 @@ idempotently deactivate up to 10 certificates at a time. The name of the certificate. - - `object: "certificate" or "organization.certificate" or "organization.project.certificate"` - - The object type. - - - If creating, updating, or getting a specific certificate, the object type is `certificate`. - - If listing, activating, or deactivating certificates for the organization, the object type is `organization.certificate`. - - If listing, activating, or deactivating certificates for a project, the object type is `organization.project.certificate`. - - - `"certificate"` + - `object: "organization.project.certificate"` - - `"organization.certificate"` + The object type, which is always `organization.project.certificate`. - `"organization.project.certificate"` - - `active: optional boolean` - - Whether the certificate is currently active at the specified scope. Not returned when getting details for a specific certificate. - -- `has_more: boolean` - -- `object: "list"` - - - `"list"` +- `object: "organization.project.certificate.deactivation"` -- `first_id: optional string` + The project certificate deactivation result type. -- `last_id: optional string` + - `"organization.project.certificate.deactivation"` ### Example @@ -18718,21 +19284,17 @@ curl https://api.openai.com/v1/organization/projects/$PROJECT_ID/certificates/de "data": [ { "id": "id", + "active": true, "certificate_details": { - "content": "content", "expires_at": 0, "valid_at": 0 }, "created_at": 0, "name": "name", - "object": "certificate", - "active": true + "object": "organization.project.certificate" } ], - "has_more": true, - "object": "list", - "first_id": "cert_abc", - "last_id": "cert_abc" + "object": "organization.project.certificate.deactivation" } ``` @@ -18743,7 +19305,7 @@ curl https://api.openai.com/v1/organization/projects/proj_abc/certificates/deact -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \ -H "Content-Type: application/json" \ -d '{ - "data": ["cert_abc", "cert_def"] + "certificate_ids": ["cert_abc", "cert_def"] }' ``` @@ -18778,3 +19340,119 @@ curl https://api.openai.com/v1/organization/projects/proj_abc/certificates/deact ], } ``` + +## Domain Types + +### Certificate List Response + +- `CertificateListResponse object { id, active, certificate_details, 3 more }` + + Represents an individual certificate configured at the project level. + + - `id: string` + + The identifier, which can be referenced in API endpoints + + - `active: boolean` + + Whether the certificate is currently active at the project level. + + - `certificate_details: object { expires_at, valid_at }` + + - `expires_at: optional number` + + The Unix timestamp (in seconds) of when the certificate expires. + + - `valid_at: optional number` + + The Unix timestamp (in seconds) of when the certificate becomes valid. + + - `created_at: number` + + The Unix timestamp (in seconds) of when the certificate was uploaded. + + - `name: string` + + The name of the certificate. + + - `object: "organization.project.certificate"` + + The object type, which is always `organization.project.certificate`. + + - `"organization.project.certificate"` + +### Certificate Activate Response + +- `CertificateActivateResponse object { id, active, certificate_details, 3 more }` + + Represents an individual certificate configured at the project level. + + - `id: string` + + The identifier, which can be referenced in API endpoints + + - `active: boolean` + + Whether the certificate is currently active at the project level. + + - `certificate_details: object { expires_at, valid_at }` + + - `expires_at: optional number` + + The Unix timestamp (in seconds) of when the certificate expires. + + - `valid_at: optional number` + + The Unix timestamp (in seconds) of when the certificate becomes valid. + + - `created_at: number` + + The Unix timestamp (in seconds) of when the certificate was uploaded. + + - `name: string` + + The name of the certificate. + + - `object: "organization.project.certificate"` + + The object type, which is always `organization.project.certificate`. + + - `"organization.project.certificate"` + +### Certificate Deactivate Response + +- `CertificateDeactivateResponse object { id, active, certificate_details, 3 more }` + + Represents an individual certificate configured at the project level. + + - `id: string` + + The identifier, which can be referenced in API endpoints + + - `active: boolean` + + Whether the certificate is currently active at the project level. + + - `certificate_details: object { expires_at, valid_at }` + + - `expires_at: optional number` + + The Unix timestamp (in seconds) of when the certificate expires. + + - `valid_at: optional number` + + The Unix timestamp (in seconds) of when the certificate becomes valid. + + - `created_at: number` + + The Unix timestamp (in seconds) of when the certificate was uploaded. + + - `name: string` + + The name of the certificate. + + - `object: "organization.project.certificate"` + + The object type, which is always `organization.project.certificate`. + + - `"organization.project.certificate"`