Organization
OrganizationAdmin API Keys
Create admin API key
POST
/organization/admin_api_keysDelete admin API key
DELETE
/organization/admin_api_keys/{key_id}List all organization and project API keys.
GET
/organization/admin_api_keysRetrieve admin API key
GET
/organization/admin_api_keys/{key_id}Models
AdminAPIKey object { id, created_at, expires_at, 5 more } Represents an individual Admin API key in an org.
AdminAPIKey object { id, created_at, expires_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: integer The Unix timestamp (in seconds) of when the API key was created formatunixtime expires_at: integer or null The Unix timestamp (in seconds) of when the API key expires formatunixtime object: "organization.admin_api_key" The object type, which is always organization.admin_api_key owner: { id, created_at, name, 3 more } id: optional string The identifier, which can be referenced in API endpoints created_at: optional integer The Unix timestamp (in seconds) of when the user was created formatunixtime 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 last_used_at: optional integer or null The Unix timestamp (in seconds) of when the API key was last used formatunixtime name: optional string or null The name of the API key
OrganizationAudit Logs
List user actions and configuration changes within this organization.
List audit logs
GET
/organization/audit_logsModels
AuditLogListResponse object { id, effective_at, type, 59 more } A log of a user action or configuration change within this organization.
AuditLogListResponse object { id, effective_at, type, 59 more }
A log of a user action or configuration change within this organization.
id: string The ID of this log. effective_at: integer The Unix timestamp (in seconds) of the event. formatunixtime type: "api_key.created" or "api_key.updated" or "api_key.deleted" or 146 more The event type. One of the following: "api_key.created" "api_key.updated" "api_key.deleted" "certificate.created" "certificate.updated" "certificate.deleted" "certificates.activated" "certificates.deactivated" "checkpoint.permission.created" "checkpoint.permission.deleted" "external_key.registered" "external_key.removed" "external_storage.registered" "external_storage.removed" "group.created" "group.updated" "group.deleted" "invite.sent" "invite.accepted" "invite.deleted" "ip_allowlist.created" "ip_allowlist.updated" "ip_allowlist.deleted" "ip_allowlist.config.activated" "ip_allowlist.config.deactivated" "login.succeeded" "login.failed" "logout.succeeded" "logout.failed" "organization.updated" "project.created" "project.updated" "project.archived" "project.deleted" "rate_limit.updated" "rate_limit.deleted" "resource.deleted" "tunnel.created" "tunnel.updated" "tunnel.deleted" "workload_identity_provider.created" "workload_identity_provider.updated" "workload_identity_provider.deleted" "workload_identity_provider_mapping.created" "workload_identity_provider_mapping.updated" "workload_identity_provider_mapping.deleted" "role.created" "role.updated" "role.deleted" "role.assignment.created" "role.assignment.deleted" "role.bound_to_resource" "role.unbound_from_resource" "scim.enabled" "scim.disabled" "service_account.created" "service_account.updated" "service_account.deleted" "user.added" "user.updated" "user.deleted" "tenant.metadata.updated" "tenant.microsoft_entra_mapping.upserted" "tenant.microsoft_entra_mapping.deleted" "tenant.workload_identity.provider.created" "tenant.workload_identity.provider.updated" "tenant.workload_identity.provider.archived" "tenant.workload_identity.mapping.created" "tenant.workload_identity.mapping.updated" "tenant.workload_identity.mapping.archived" "tenant.workload_identity.binding.created" "tenant.workload_identity.principal.provisioned" "tenant.workload_identity.access_token.issued" "tenant.admin_api_key.created" "tenant.admin_api_key.updated" "tenant.admin_api_key.deleted" "tenant.project_api_key.created" "tenant.trusted_access.business_verification.started" "tenant.trusted_access.application.submitted" "tenant.chatgpt_access_token.revoked" "tenant.migration.completed" "tenant.sso.migrated" "tenant.domains.migrated" "tenant.sso_connection.created" "tenant.sso_connection.updated" "tenant.sso_connection.deleted" "tenant.sso_connection.setup.started" "tenant.policy.created" "tenant.policy.updated" "tenant.policy.deleted" "tenant.policy.attached" "tenant.policy.detached" "tenant.principal_authentication_policy.resolved" "tenant.scim.setup.started" "tenant.scim.deletion.requested" "tenant.scim.directory.created" "tenant.product_access_policy.updated" "tenant.resource_share_grant.created" "tenant.resource_share_grant.updated" "tenant.resource_share_grant.accepted" "tenant.resource_share_grant.declined" "tenant.resource_share_grant.revoked" "tenant.resource_share_grant.deleted" "tenant.service_account.updated" "tenant.service_account.deleted" "tenant.service_account.token.revoked" "tenant.billing.overage_limit.updated" "tenant.billing.alerts.updated" "tenant.billing.info.updated" "tenant.usage_limit.workspace.updated" "tenant.usage_limit.group.updated" "tenant.usage_limit.user.updated" "tenant.usage_limit.increase_request.updated" "tenant.usage_limit.increase_request.resolved" "tenant.group.created" "tenant.group.updated" "tenant.group.deleted" "tenant.group.member.added" "tenant.group.member.removed" "tenant.migration_rollout.status.updated" "tenant.migration_rollout.tier.updated" "tenant.role.metadata.updated" "tenant.custom_role.created" "tenant.custom_role.updated" "tenant.custom_role.deleted" "tenant.role_assignment.created" "tenant.role_assignment.deleted" "tenant.resource_role_assignment.created" "tenant.resource_role_assignment.deleted" "tenant.resource_access.updated" "tenant.resource_access.deleted" "tenant.ads_account.onboarding.redemption" "tenant.session_policy.created" "tenant.session_policy.updated" "tenant.session_policy.deleted" "tenant.session_revocation.started" "tenant.third_party_app_policy.updated" "tenant.user.added" "tenant.user.updated" "tenant.user.removed" "tenant.user.looked_up" "tenant.user.invited" "tenant.membership.revoked" "tenant.api_organization_invite.upserted" "tenant.api_organization_invite.deleted" "tenant.chatgpt_workspace_invite.upserted" "tenant.membership.accepted" "tenant.membership.declined" "tenant.workspace_invite_email_settings.updated" actor: optional object or null The actor who performed the audit logged action. api_key: optional { 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 { 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. One of the following: "user" "service_account" user: optional { id, email } The user who performed the audit logged action. id: optional string The user id. email: optional string The user email. session: optional { 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 { 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. One of the following: "session" "api_key" "api_key.created": optional { id, data } The details for events with this type. id: optional string The tracking ID of the API key. data: optional { 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 { id } The details for events with this type. id: optional string The tracking ID of the API key. "api_key.updated": optional { id, changes_requested } The details for events with this type. id: optional string The tracking ID of the API key. changes_requested: optional { 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 { id, name } The details for events with this type. id: optional string The certificate ID. name: optional string The name of the certificate. "certificate.deleted": optional { id, certificate, name } The details for events with this type. id: optional string The certificate ID. certificate: optional string The certificate content in PEM format. name: optional string The name of the certificate. "certificate.updated": optional { id, name } The details for events with this type. id: optional string The certificate ID. name: optional string The name of the certificate. "certificates.activated": optional { certificates } The details for events with this type. certificates: optional array of { id, name } id: optional string The certificate ID. name: optional string The name of the certificate. "certificates.deactivated": optional { certificates } The details for events with this type. certificates: optional array of { id, name } id: optional string The certificate ID. name: optional string The name of the certificate. "checkpoint.permission.created": optional { id, data } The project and fine-tuned model checkpoint that the checkpoint permission was created for. id: optional string The ID of the checkpoint permission. data: optional { fine_tuned_model_checkpoint, project_id } The payload used to create the checkpoint permission. fine_tuned_model_checkpoint: optional string The ID of the fine-tuned model checkpoint. project_id: optional string The ID of the project that the checkpoint permission was created for. "checkpoint.permission.deleted": optional { id } The details for events with this type. id: optional string The ID of the checkpoint permission. "external_key.registered": optional { id, data } The details for events with this type. id: optional string The ID of the external key configuration. data: optional unknown The configuration for the external key. "external_key.removed": optional { id } The details for events with this type. id: optional string The ID of the external key configuration. "external_storage.registered": optional { id, data } The details for events with this type. id: optional string The ID of the external storage configuration. data: optional { geography, provider } The configuration for the external storage. geography: optional string The OpenAI geography derived from the storage region. provider: optional AwsExternalStorageProvider or AzureExternalStorageProvider or GcpExternalStorageProvider or OciExternalStorageProvider The external storage provider configuration. One of the following: AwsExternalStorageProvider { account_id, bucket, external_id, 3 more } account_id: string bucket: string external_id: string region: string role_arn: string type: "aws" (default: "aws") AzureExternalStorageProvider { account_name, container, region, 4 more } account_name: string container: string region: string resource_group: string subscription_id: string tenant_id: string type: "azure" (default: "azure") GcpExternalStorageProvider { audience, bucket, region, 4 more } audience: string bucket: string region: string type: "gcp" (default: "gcp") workload_identity_pool_id: string workload_identity_project_number: string workload_identity_provider_id: string OciExternalStorageProvider { bucket, region, tenancy_ocid, type } bucket: string region: string tenancy_ocid: string type: "oci" (default: "oci") "external_storage.removed": optional { id } The details for events with this type. id: optional string The ID of the external storage configuration. "group.created": optional { id, data } The details for events with this type. id: optional string The ID of the group. data: optional { group_name } Information about the created group. group_name: optional string The group name. "group.deleted": optional { id } The details for events with this type. id: optional string The ID of the group. "group.updated": optional { id, changes_requested } The details for events with this type. id: optional string The ID of the group. changes_requested: optional { group_name } The payload used to update the group. group_name: optional string The updated group name. "invite.accepted": optional { id } The details for events with this type. id: optional string The ID of the invite. "invite.deleted": optional { id } The details for events with this type. id: optional string The ID of the invite. "invite.sent": optional { id, data } The details for events with this type. id: optional string The ID of the invite. data: optional { email, role } The payload used to create the invite. email: optional string The email invited to the organization. role: optional string The role the email was invited to be. Is either owner or member. "ip_allowlist.config.activated": optional { configs } The details for events with this type. configs: optional array of { id, name } The configurations that were activated. id: optional string The ID of the IP allowlist configuration. name: optional string The name of the IP allowlist configuration. "ip_allowlist.config.deactivated": optional { configs } The details for events with this type. configs: optional array of { id, name } The configurations that were deactivated. id: optional string The ID of the IP allowlist configuration. name: optional string The name of the IP allowlist configuration. "ip_allowlist.created": optional { id, allowed_ips, name } The details for events with this type. id: optional string The ID of the IP allowlist configuration. allowed_ips: optional array of string The IP addresses or CIDR ranges included in the configuration. name: optional string The name of the IP allowlist configuration. "ip_allowlist.deleted": optional { id, allowed_ips, name } The details for events with this type. id: optional string The ID of the IP allowlist configuration. allowed_ips: optional array of string The IP addresses or CIDR ranges that were in the configuration. name: optional string The name of the IP allowlist configuration. "ip_allowlist.updated": optional { id, allowed_ips } The details for events with this type. id: optional string The ID of the IP allowlist configuration. allowed_ips: optional array of string The updated set of IP addresses or CIDR ranges in the configuration. "login.failed": optional { error_code, error_message } The details for events with this type. error_code: optional string The error code of the failure. error_message: optional string The error message of the failure. "login.succeeded": optional unknown This event has no additional fields beyond the standard audit log attributes. "logout.failed": optional { error_code, error_message } The details for events with this type. error_code: optional string The error code of the failure. error_message: optional string The error message of the failure. "logout.succeeded": optional unknown This event has no additional fields beyond the standard audit log attributes. "organization.updated": optional { id, changes_requested } The details for events with this type. id: optional string The organization ID. changes_requested: optional { api_call_logging, api_call_logging_project_ids, description, 4 more } The payload used to update the organization settings. api_call_logging: optional string How your organization logs data from supported API calls. One of disabled, enabled_per_call, enabled_for_all_projects, or enabled_for_selected_projects api_call_logging_project_ids: optional string The list of project ids if api_call_logging is set to enabled_for_selected_projects description: optional string The organization description. name: optional string The organization name. threads_ui_visibility: optional string Visibility of the threads page which shows messages created with the Assistants API and Playground. One of ANY_ROLE, OWNERS, or NONE. title: optional string The organization title. usage_dashboard_visibility: optional string Visibility of the usage dashboard which shows activity and costs for your organization. One of ANY_ROLE or OWNERS. project: optional { id, name } The project that the action was scoped to. Absent for actions not scoped to projects. Note that any admin actions taken via Admin API keys are associated with the default project. id: optional string The project ID. name: optional string The project title. "project.archived": optional { id } The details for events with this type. id: optional string The project ID. "project.created": optional { id, data } The details for events with this type. id: optional string The project ID. data: optional { name, title } The payload used to create the project. name: optional string The project name. title: optional string The title of the project as seen on the dashboard. "project.deleted": optional { id } The details for events with this type. id: optional string The project ID. "project.updated": optional { id, changes_requested } The details for events with this type. id: optional string The project ID. changes_requested: optional { title } The payload used to update the project. title: optional string The title of the project as seen on the dashboard. "rate_limit.deleted": optional { id } The details for events with this type. id: optional string The rate limit ID "rate_limit.updated": optional { id, changes_requested } The details for events with this type. id: optional string The rate limit ID changes_requested: optional { batch_1_day_max_input_tokens, max_audio_megabytes_per_1_minute, max_images_per_1_minute, 3 more } The payload used to update the rate limits. batch_1_day_max_input_tokens: optional integer The maximum batch input tokens per day. Only relevant for certain models. max_audio_megabytes_per_1_minute: optional integer The maximum audio megabytes per minute. Only relevant for certain models. max_images_per_1_minute: optional integer The maximum images per minute. Only relevant for certain models. max_requests_per_1_day: optional integer The maximum requests per day. Only relevant for certain models. max_requests_per_1_minute: optional integer The maximum requests per minute. max_tokens_per_1_minute: optional integer The maximum tokens per minute. "role.assignment.created": optional { id, principal_id, principal_type, 2 more } The details for events with this type. id: optional string The identifier of the role assignment. principal_id: optional string The principal (user or group) that received the role. principal_type: optional string The type of principal (user or group) that received the role. resource_id: optional string The resource the role assignment is scoped to. resource_type: optional string The type of resource the role assignment is scoped to. "role.assignment.deleted": optional { id, principal_id, principal_type, 2 more } The details for events with this type. id: optional string The identifier of the role assignment. principal_id: optional string The principal (user or group) that had the role removed. principal_type: optional string The type of principal (user or group) that had the role removed. resource_id: optional string The resource the role assignment was scoped to. resource_type: optional string The type of resource the role assignment was scoped to. "role.bound_to_resource": optional { id, connector_id, connector_name, 7 more } The details for events with this type. id: optional string The ID of the resource the role was bound to. ChatGPT workspace connector resources use <workspace_id>__<connector_id>. connector_id: optional string The connector ID for a ChatGPT workspace connector resource. connector_name: optional string The connector display name for a ChatGPT workspace connector resource, or the connector ID when the display name could not be resolved. enabled: optional boolean Whether the connector is enabled for the role. permissions: optional array of string The permissions granted to the role for the resource. resource_id: optional string The ID of the resource the role was bound to. resource_type: optional string The type of resource the role was bound to. role_id: optional string The ID of the role that was bound to the resource. source: optional "role_toggle" or "role_connector_update" or "role_delete" or 2 more The connector role mutation path that produced the event. One of the following: "role_toggle" "role_connector_update" "role_delete" "workspace_permissions" "connector_publish" workspace_id: optional string The workspace ID for a ChatGPT workspace connector resource. "role.created": optional { id, permissions, resource_id, 2 more } The details for events with this type. id: optional string The role ID. permissions: optional array of string The permissions granted by the role. resource_id: optional string The resource the role is scoped to. resource_type: optional string The type of resource the role belongs to. role_name: optional string The name of the role. "role.deleted": optional { id } The details for events with this type. id: optional string The role ID. "role.unbound_from_resource": optional { id, connector_id, connector_name, 7 more } The details for events with this type. id: optional string The ID of the resource the role was unbound from. ChatGPT workspace connector resources use <workspace_id>__<connector_id>. connector_id: optional string The connector ID for a ChatGPT workspace connector resource. connector_name: optional string The connector display name for a ChatGPT workspace connector resource, or the connector ID when the display name could not be resolved. enabled: optional boolean Whether the connector is enabled for the role. permissions: optional array of string The permissions remaining for the role after the change. resource_id: optional string The ID of the resource the role was unbound from. resource_type: optional string The type of resource the role was unbound from. role_id: optional string The ID of the role that was unbound from the resource. source: optional "role_toggle" or "role_connector_update" or "role_delete" or 2 more The connector role mutation path that produced the event. One of the following: "role_toggle" "role_connector_update" "role_delete" "workspace_permissions" "connector_publish" workspace_id: optional string The workspace ID for a ChatGPT workspace connector resource. "role.updated": optional { id, changes_requested } The details for events with this type. id: optional string The role ID. changes_requested: optional { description, metadata, permissions_added, 4 more } The payload used to update the role. description: optional string The updated role description, when provided. metadata: optional unknown Additional metadata stored on the role. permissions_added: optional array of string The permissions added to the role. permissions_removed: optional array of string The permissions removed from the role. resource_id: optional string The resource the role is scoped to. resource_type: optional string The type of resource the role belongs to. role_name: optional string The updated role name, when provided. "scim.disabled": optional { id } The details for events with this type. id: optional string The ID of the SCIM was disabled for. "scim.enabled": optional { id } The details for events with this type. id: optional string The ID of the SCIM was enabled for. "service_account.created": optional { id, data } The details for events with this type. id: optional string The service account ID. data: optional { role } The payload used to create the service account. role: optional string The role of the service account. Is either owner or member. "service_account.deleted": optional { id } The details for events with this type. id: optional string The service account ID. "service_account.updated": optional { id, changes_requested } The details for events with this type. id: optional string The service account ID. changes_requested: optional { role } The payload used to updated the service account. role: optional string The role of the service account. Is either owner or member. "user.added": optional { id, data } The details for events with this type. id: optional string The user ID. data: optional { role } The payload used to add the user to the project. role: optional string The role of the user. Is either owner or member. "user.deleted": optional { id } The details for events with this type. id: optional string The user ID. "user.updated": optional { id, changes_requested } The details for events with this type. id: optional string The project ID. changes_requested: optional { role } The payload used to update the user. role: optional string The role of the user. Is either owner or member. "workload_identity_provider_mapping.created": optional { id, data, identity_provider_id } The details for events with this type. id: optional string The workload identity provider mapping ID. data: optional unknown The payload used to create the workload identity provider mapping. identity_provider_id: optional string The workload identity provider ID. "workload_identity_provider_mapping.deleted": optional { id, identity_provider_id, project_id, service_account_id } The details for events with this type. id: optional string The workload identity provider mapping ID. identity_provider_id: optional string The workload identity provider ID. project_id: optional string The project ID. service_account_id: optional string The mapped service account ID. "workload_identity_provider_mapping.updated": optional { id, changes_requested, identity_provider_id } The details for events with this type. id: optional string The workload identity provider mapping ID. changes_requested: optional unknown The payload used to update the workload identity provider mapping. identity_provider_id: optional string The workload identity provider ID. "workload_identity_provider.created": optional { id, data } The details for events with this type. id: optional string The workload identity provider ID. data: optional unknown The payload used to create the workload identity provider. "workload_identity_provider.deleted": optional { id, name } The details for events with this type. id: optional string The workload identity provider ID. name: optional string The workload identity provider name. "workload_identity_provider.updated": optional { id, changes_requested } The details for events with this type. id: optional string The workload identity provider ID. changes_requested: optional unknown The payload used to update the workload identity provider.
OrganizationCertificates
Activate certificates for organization
POST
/organization/certificates/activateUpload certificate
POST
/organization/certificatesDeactivate certificates for organization
POST
/organization/certificates/deactivateDelete certificate
DELETE
/organization/certificates/{certificate_id}List organization certificates
GET
/organization/certificatesGet certificate
GET
/organization/certificates/{certificate_id}Modify certificate
POST
/organization/certificates/{certificate_id}Models
Certificate object { id, certificate_details, created_at, 3 more } Represents an individual certificate uploaded to the organization.
Certificate object { id, certificate_details, created_at, 3 more }
Represents an individual certificate uploaded to the organization.
id: string The identifier, which can be referenced in API endpoints certificate_details: { content, expires_at, valid_at } content: optional string The content of the certificate in PEM format. expires_at: optional integer The Unix timestamp (in seconds) of when the certificate expires. formatunixtime valid_at: optional integer The Unix timestamp (in seconds) of when the certificate becomes valid. formatunixtime created_at: integer The Unix timestamp (in seconds) of when the certificate was uploaded. formatunixtime name: string or null 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. One of the following: "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.
CertificateActivateResponse object { id, active, certificate_details, 3 more } Represents an individual certificate configured at the organization level.
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: { expires_at, valid_at } expires_at: optional integer The Unix timestamp (in seconds) of when the certificate expires. formatunixtime valid_at: optional integer The Unix timestamp (in seconds) of when the certificate becomes valid. formatunixtime created_at: integer The Unix timestamp (in seconds) of when the certificate was uploaded. formatunixtime name: string or null The name of the certificate. object: "organization.certificate" The object type, which is always organization.certificate.
CertificateDeactivateResponse object { id, active, certificate_details, 3 more } Represents an individual certificate configured at the organization level.
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 Whether the certificate is currently active at the organization level. certificate_details: { expires_at, valid_at } expires_at: optional integer The Unix timestamp (in seconds) of when the certificate expires. formatunixtime valid_at: optional integer The Unix timestamp (in seconds) of when the certificate becomes valid. formatunixtime created_at: integer The Unix timestamp (in seconds) of when the certificate was uploaded. formatunixtime name: string or null The name of the certificate. object: "organization.certificate" The object type, which is always organization.certificate.
CertificateListResponse object { id, active, certificate_details, 3 more } Represents an individual certificate configured at the organization level.
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: { expires_at, valid_at } expires_at: optional integer The Unix timestamp (in seconds) of when the certificate expires. formatunixtime valid_at: optional integer The Unix timestamp (in seconds) of when the certificate becomes valid. formatunixtime created_at: integer The Unix timestamp (in seconds) of when the certificate was uploaded. formatunixtime name: string or null The name of the certificate. object: "organization.certificate" The object type, which is always organization.certificate.
OrganizationData Retention
Retrieve organization data retention
GET
/organization/data_retentionUpdate organization data retention
POST
/organization/data_retentionModels
OrganizationDataRetention object { object, type } Represents the organization’s data retention control setting.
OrganizationDataRetention object { object, type }
Represents the organization’s data retention control setting.
object: "organization.data_retention" The object type, which is always organization.data_retention. type: "zero_data_retention" or "modified_abuse_monitoring" or "enhanced_zero_data_retention" or "enhanced_modified_abuse_monitoring" The configured organization data retention type. One of the following: "zero_data_retention" "modified_abuse_monitoring" "enhanced_zero_data_retention" "enhanced_modified_abuse_monitoring"
OrganizationExternal Keys
Add an external key config for an organization
POST
/organization/external_keysDelete an external key config for the user's organization
DELETE
/organization/external_keys/{external_key_id}List the external key configs registered on the user's organization
GET
/organization/external_keysRetrieve an external key registration
GET
/organization/external_keys/{external_key_id}Validate an external key config for the user's organization
POST
/organization/external_keys/{external_key_id}/validateModels
ExternalKey object { id, api_project_ids, created_at, 25 more }
ExternalKey object { id, api_project_ids, created_at, 25 more }
id: string api_project_ids: array of string created_at: integer name: string object: string type: string workspace_id: string audience: optional string external_id: optional string key_name: optional string key_ocid: optional string key_version: optional string key_version_ocid: optional string kms_arn: optional string kms_key_location: optional string kms_key_name: optional string kms_key_ring_name: optional string kms_key_version: optional string kms_project_id: optional string purpose: optional "ekm" or "psp_decryption" One of the following: "ekm" "psp_decryption" region: optional string role_arn: optional string tenant_id: optional string vault_ocid: optional string vault_uri: optional string workload_identity_pool_id: optional string workload_identity_project_number: optional string workload_identity_provider_id: optional string
OrganizationExternal Storage
Create an external storage configuration
POST
/organization/external_storageDelete an external storage configuration
DELETE
/organization/external_storage/{external_storage_id}List external storage configurations
GET
/organization/external_storageGet an external storage configuration
GET
/organization/external_storage/{external_storage_id}Validate an external storage configuration
POST
/organization/external_storage/{external_storage_id}/validateModels
ExternalStorageConfiguration object { id, created_at, geography, 4 more }
ExternalStorageConfiguration object { id, created_at, geography, 4 more }
id: string created_at: integer formatunixtime geography: string object: "organization.external_storage" (default: "organization.external_storage") project_id: string provider: AwsExternalStorageProvider or AzureExternalStorageProvider or GcpExternalStorageProvider or OciExternalStorageProvider One of the following: AwsExternalStorageProvider { account_id, bucket, external_id, 3 more } account_id: string bucket: string external_id: string region: string role_arn: string type: "aws" (default: "aws") AzureExternalStorageProvider { account_name, container, region, 4 more } account_name: string container: string region: string resource_group: string subscription_id: string tenant_id: string type: "azure" (default: "azure") GcpExternalStorageProvider { audience, bucket, region, 4 more } audience: string bucket: string region: string type: "gcp" (default: "gcp") workload_identity_pool_id: string workload_identity_project_number: string workload_identity_provider_id: string OciExternalStorageProvider { bucket, region, tenancy_ocid, type } bucket: string region: string tenancy_ocid: string type: "oci" (default: "oci") status: "pending" or "validated" or "degraded" or "unhealthy" One of the following: "pending" "validated" "degraded" "unhealthy"
OrganizationGroups
Create group
POST
/organization/groupsDelete group
DELETE
/organization/groups/{group_id}List groups
GET
/organization/groupsRetrieve group
GET
/organization/groups/{group_id}Update group
POST
/organization/groups/{group_id}Models
Group object { id, created_at, group_type, 2 more } Details about an organization group.
Group object { id, created_at, group_type, 2 more }
Details about an organization group.
id: string Identifier for the group. created_at: integer Unix timestamp (in seconds) when the group was created. formatunixtime group_type: "group" or "tenant_group" The type of the group. One of the following: "group" "tenant_group" is_scim_managed: boolean Whether the group is managed through SCIM and controlled by your identity provider. name: string Display name of the group.
GroupUpdateResponse object { id, created_at, is_scim_managed, name } Response returned after updating a group.
GroupUpdateResponse object { id, created_at, is_scim_managed, name }
Response returned after updating a group.
id: string Identifier for the group. created_at: integer Unix timestamp (in seconds) when the group was created. formatunixtime is_scim_managed: boolean Whether the group is managed through SCIM and controlled by your identity provider. name: string Updated display name for the group.
OrganizationGroupsRoles
Assign organization role to group
POST
/organization/groups/{group_id}/rolesUnassign organization role from group
DELETE
/organization/groups/{group_id}/roles/{role_id}List group organization role assignments
GET
/organization/groups/{group_id}/rolesRetrieve group organization role
GET
/organization/groups/{group_id}/roles/{role_id}Models
RoleCreateResponse object { group, object, role } Role assignment linking a group to a role.
RoleCreateResponse object { group, object, role }
Role assignment linking a group to a role.
group: { id, created_at, name, 2 more } Summary information about a group returned in role assignment responses. id: string Identifier for the group. created_at: integer Unix timestamp (in seconds) when the group was created. formatunixtime name: string Display name of the group. object: "group" Always group. scim_managed: boolean Whether the group is managed through SCIM. object: "group.role" Always group.role. role: Role { id, description, name, 4 more } Details about a role that can be assigned through the public Roles API.
RoleListResponse object { id, assignment_sources, created_at, 9 more } Detailed information about a role assignment entry returned when listing assignments.
RoleListResponse object { id, assignment_sources, created_at, 9 more }
Detailed information about a role assignment entry returned when listing assignments.
id: string Identifier for the role. assignment_sources: array of object or null Principals from which the role assignment is inherited, when available. principal_id: string principal_type: string created_at: integer or null When the role was created. formatunixtime created_by: string or null Identifier of the actor who created the role. created_by_user_obj: map[unknown] or null User details for the actor that created the role, when available. description: string or null Description of the role. metadata: map[unknown] or null Arbitrary metadata stored on the role. name: string Name of the role. permissions: array of string Permissions associated with the role. predefined_role: boolean Whether the role is predefined by OpenAI. resource_type: string Resource type the role applies to. updated_at: integer or null When the role was last updated. formatunixtime
RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more } Detailed information about a role assignment entry returned when listing assignments.
RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more }
Detailed information about a role assignment entry returned when listing assignments.
id: string Identifier for the role. assignment_sources: array of object or null Principals from which the role assignment is inherited, when available. principal_id: string principal_type: string created_at: integer or null When the role was created. formatunixtime created_by: string or null Identifier of the actor who created the role. created_by_user_obj: map[unknown] or null User details for the actor that created the role, when available. description: string or null Description of the role. metadata: map[unknown] or null Arbitrary metadata stored on the role. name: string Name of the role. permissions: array of string Permissions associated with the role. predefined_role: boolean Whether the role is predefined by OpenAI. resource_type: string Resource type the role applies to. updated_at: integer or null When the role was last updated. formatunixtime
OrganizationGroupsUsers
Add group user
POST
/organization/groups/{group_id}/usersRemove group user
DELETE
/organization/groups/{group_id}/users/{user_id}List group users
GET
/organization/groups/{group_id}/usersRetrieve group user
GET
/organization/groups/{group_id}/users/{user_id}Models
UserRetrieveResponse object { id, email, is_service_account, 3 more } Details about a user returned from an organization group membership lookup.
UserRetrieveResponse object { id, email, is_service_account, 3 more }
Details about a user returned from an organization group membership lookup.
id: string Identifier for the user. email: string or null Email address of the user, or null for users without an email. is_service_account: boolean or null Whether the user is a service account. name: string Display name of the user. picture: string or null URL of the user’s profile picture, if available. user_type: "user" or "tenant_user" The type of user. One of the following: "user" "tenant_user"
OrganizationInvites
Create invite
POST
/organization/invitesDelete invite
DELETE
/organization/invites/{invite_id}List invites
GET
/organization/invitesRetrieve invite
GET
/organization/invites/{invite_id}Models
Invite object { id, created_at, email, 6 more } Represents an individual invite to the organization.
Invite object { id, created_at, email, 6 more }
Represents an individual invite to the organization.
id: string The identifier, which can be referenced in API endpoints created_at: integer The Unix timestamp (in seconds) of when the invite was sent. formatunixtime email: string The email address of the individual to whom the invite was sent object: "organization.invite" The object type, which is always organization.invite projects: array of { id, role } The projects that were granted membership upon acceptance of the invite. id: string Project’s public ID role: "member" or "owner" Project membership role One of the following: "member" "owner" role: "owner" or "reader" owner or reader One of the following: "owner" "reader" status: "accepted" or "expired" or "pending" accepted,expired, or pending One of the following: "accepted" "expired" "pending" accepted_at: optional integer or null The Unix timestamp (in seconds) of when the invite was accepted. formatunixtime expires_at: optional integer or null The Unix timestamp (in seconds) of when the invite expires. formatunixtime
OrganizationProjects
Archive project
POST
/organization/projects/{project_id}/archiveCreate project
POST
/organization/projectsList projects
GET
/organization/projectsRetrieve project
GET
/organization/projects/{project_id}Modify project
POST
/organization/projects/{project_id}Models
Project object { id, created_at, object, 5 more } Represents an individual project.
Project object { id, created_at, object, 5 more }
Represents an individual project.
id: string The identifier, which can be referenced in API endpoints created_at: integer The Unix timestamp (in seconds) of when the project was created. formatunixtime object: "organization.project" The object type, which is always organization.project archived_at: optional integer or null The Unix timestamp (in seconds) of when the project was archived or null. formatunixtime external_key_id: optional string or null The external key associated with the project. name: optional string or null The name of the project. This appears in reporting. residency: optional ProjectResidency The residency configuration for the project. status: optional string or null active or archived
ProjectResidency = "GLOBAL" or "US_STORAGE_PROCESSING" or "EU_STORAGE_PROCESSING" or 12 more
ProjectResidency = "GLOBAL" or "US_STORAGE_PROCESSING" or "EU_STORAGE_PROCESSING" or 12 more
One of the following: "GLOBAL" "US_STORAGE_PROCESSING" "EU_STORAGE_PROCESSING" "JP_STORAGE" "JP_STORAGE_PROCESSING" "KR_STORAGE" "CA_STORAGE" "SG_STORAGE" "IN_STORAGE" "IN_STORAGE_PROCESSING" "AU_STORAGE" "AU_STORAGE_PROCESSING" "GB_STORAGE" "AE_STORAGE" "AE_STORAGE_PROCESSING"
OrganizationProjectsAPI Keys
Delete project API key
DELETE
/organization/projects/{project_id}/api_keys/{api_key_id}List project API keys
GET
/organization/projects/{project_id}/api_keysRetrieve project API key
GET
/organization/projects/{project_id}/api_keys/{api_key_id}Update project API key
POST
/organization/projects/{project_id}/api_keys/{api_key_id}Models
ProjectAPIKey object { id, created_at, last_used_at, 6 more } Represents an individual API key in a project.
ProjectAPIKey object { id, created_at, last_used_at, 6 more }
Represents an individual API key in a project.
id: string The identifier, which can be referenced in API endpoints created_at: integer The Unix timestamp (in seconds) of when the API key was created formatunixtime last_used_at: integer or null The Unix timestamp (in seconds) of when the API key was last used. formatunixtime name: string The name of the API key object: "organization.project.api_key" The object type, which is always organization.project.api_key owner: { service_account, type, user } service_account: optional { id, created_at, name, role } The service account that owns a project API key. id: string The identifier, which can be referenced in API endpoints created_at: integer The Unix timestamp (in seconds) of when the service account was created. formatunixtime name: string The name of the service account. role: string The service account’s project role. type: optional "user" or "service_account" user or service_account One of the following: "user" "service_account" user: optional { id, created_at, email, 2 more } The user that owns a project API key. id: string The identifier, which can be referenced in API endpoints created_at: integer The Unix timestamp (in seconds) of when the user was created. formatunixtime email: string The email address of the user. name: string The name of the user. role: string The user’s project role. owner_project_access: "active" or "inactive" Whether the API key’s owner currently has effective access to the project. One of the following: "active" "inactive" redacted_value: string The redacted value of the API key expires_at: optional integer or null The Unix timestamp (in seconds) when the API key expires, or null if it does not expire. formatunixtime
OrganizationProjectsCertificates
Activate certificates for project
POST
/organization/projects/{project_id}/certificates/activateDeactivate certificates for project
POST
/organization/projects/{project_id}/certificates/deactivateList project certificates
GET
/organization/projects/{project_id}/certificatesModels
CertificateActivateResponse object { id, active, certificate_details, 3 more } Represents an individual certificate configured at the project level.
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: { expires_at, valid_at } expires_at: optional integer The Unix timestamp (in seconds) of when the certificate expires. formatunixtime valid_at: optional integer The Unix timestamp (in seconds) of when the certificate becomes valid. formatunixtime created_at: integer The Unix timestamp (in seconds) of when the certificate was uploaded. formatunixtime name: string or null The name of the certificate. object: "organization.project.certificate" The object type, which is always organization.project.certificate.
CertificateDeactivateResponse object { id, active, certificate_details, 3 more } Represents an individual certificate configured at the project level.
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: { expires_at, valid_at } expires_at: optional integer The Unix timestamp (in seconds) of when the certificate expires. formatunixtime valid_at: optional integer The Unix timestamp (in seconds) of when the certificate becomes valid. formatunixtime created_at: integer The Unix timestamp (in seconds) of when the certificate was uploaded. formatunixtime name: string or null The name of the certificate. object: "organization.project.certificate" The object type, which is always organization.project.certificate.
CertificateListResponse object { id, active, certificate_details, 3 more } Represents an individual certificate configured at the project level.
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: { expires_at, valid_at } expires_at: optional integer The Unix timestamp (in seconds) of when the certificate expires. formatunixtime valid_at: optional integer The Unix timestamp (in seconds) of when the certificate becomes valid. formatunixtime created_at: integer The Unix timestamp (in seconds) of when the certificate was uploaded. formatunixtime name: string or null The name of the certificate. object: "organization.project.certificate" The object type, which is always organization.project.certificate.
OrganizationProjectsData Retention
Retrieve project data retention
GET
/organization/projects/{project_id}/data_retentionUpdate project data retention
POST
/organization/projects/{project_id}/data_retentionModels
ProjectDataRetention object { object, type } Represents a project’s data retention control setting.
ProjectDataRetention object { object, type }
Represents a project’s data retention control setting.
object: "project.data_retention" The object type, which is always project.data_retention. type: "organization_default" or "none" or "zero_data_retention" or 3 more The configured project data retention type. One of the following: "organization_default" "none" "zero_data_retention" "modified_abuse_monitoring" "enhanced_zero_data_retention" "enhanced_modified_abuse_monitoring"
OrganizationProjectsGroups
Add project group
POST
/organization/projects/{project_id}/groupsRemove project group
DELETE
/organization/projects/{project_id}/groups/{group_id}List project groups
GET
/organization/projects/{project_id}/groupsRetrieve project group
GET
/organization/projects/{project_id}/groups/{group_id}Models
ProjectGroup object { created_at, group_id, group_name, 3 more } Details about a group’s membership in a project.
ProjectGroup object { created_at, group_id, group_name, 3 more }
Details about a group’s membership in a project.
created_at: integer Unix timestamp (in seconds) when the group was granted project access. formatunixtime group_id: string Identifier of the group that has access to the project. group_name: string Display name of the group. group_type: "group" or "tenant_group" The type of the group. One of the following: "group" "tenant_group" object: "project.group" Always project.group. project_id: string Identifier of the project.
OrganizationProjectsGroupsRoles
Assign project role to group
POST
/projects/{project_id}/groups/{group_id}/rolesUnassign project role from group
DELETE
/projects/{project_id}/groups/{group_id}/roles/{role_id}List project group role assignments
GET
/projects/{project_id}/groups/{group_id}/rolesRetrieve project group role
GET
/projects/{project_id}/groups/{group_id}/roles/{role_id}Models
RoleCreateResponse object { group, object, role } Role assignment linking a group to a role.
RoleCreateResponse object { group, object, role }
Role assignment linking a group to a role.
group: { id, created_at, name, 2 more } Summary information about a group returned in role assignment responses. id: string Identifier for the group. created_at: integer Unix timestamp (in seconds) when the group was created. formatunixtime name: string Display name of the group. object: "group" Always group. scim_managed: boolean Whether the group is managed through SCIM. object: "group.role" Always group.role. role: Role { id, description, name, 4 more } Details about a role that can be assigned through the public Roles API.
RoleListResponse object { id, assignment_sources, created_at, 9 more } Detailed information about a role assignment entry returned when listing assignments.
RoleListResponse object { id, assignment_sources, created_at, 9 more }
Detailed information about a role assignment entry returned when listing assignments.
id: string Identifier for the role. assignment_sources: array of object or null Principals from which the role assignment is inherited, when available. principal_id: string principal_type: string created_at: integer or null When the role was created. formatunixtime created_by: string or null Identifier of the actor who created the role. created_by_user_obj: map[unknown] or null User details for the actor that created the role, when available. description: string or null Description of the role. metadata: map[unknown] or null Arbitrary metadata stored on the role. name: string Name of the role. permissions: array of string Permissions associated with the role. predefined_role: boolean Whether the role is predefined by OpenAI. resource_type: string Resource type the role applies to. updated_at: integer or null When the role was last updated. formatunixtime
RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more } Detailed information about a role assignment entry returned when listing assignments.
RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more }
Detailed information about a role assignment entry returned when listing assignments.
id: string Identifier for the role. assignment_sources: array of object or null Principals from which the role assignment is inherited, when available. principal_id: string principal_type: string created_at: integer or null When the role was created. formatunixtime created_by: string or null Identifier of the actor who created the role. created_by_user_obj: map[unknown] or null User details for the actor that created the role, when available. description: string or null Description of the role. metadata: map[unknown] or null Arbitrary metadata stored on the role. name: string Name of the role. permissions: array of string Permissions associated with the role. predefined_role: boolean Whether the role is predefined by OpenAI. resource_type: string Resource type the role applies to. updated_at: integer or null When the role was last updated. formatunixtime
OrganizationProjectsHosted Tool Permissions
Retrieve project hosted tool permissions
GET
/organization/projects/{project_id}/hosted_tool_permissionsModify project hosted tool permissions
POST
/organization/projects/{project_id}/hosted_tool_permissionsModels
ProjectHostedToolPermissions object { code_interpreter, file_search, image_generation, 2 more } Represents hosted tool permissions for a project.
ProjectHostedToolPermissions object { code_interpreter, file_search, image_generation, 2 more }
Represents hosted tool permissions for a project.
code_interpreter: { enabled } Permission state for a single hosted tool on a project. enabled: boolean Whether the hosted tool is enabled for the project. file_search: { enabled } Permission state for a single hosted tool on a project. enabled: boolean Whether the hosted tool is enabled for the project. image_generation: { enabled } Permission state for a single hosted tool on a project. enabled: boolean Whether the hosted tool is enabled for the project. mcp: { enabled } Permission state for a single hosted tool on a project. enabled: boolean Whether the hosted tool is enabled for the project. web_search: { enabled } Permission state for a single hosted tool on a project. enabled: boolean Whether the hosted tool is enabled for the project.
OrganizationProjectsModel Permissions
Delete project model permissions
DELETE
/organization/projects/{project_id}/model_permissionsRetrieve project model permissions
GET
/organization/projects/{project_id}/model_permissionsModify project model permissions
POST
/organization/projects/{project_id}/model_permissionsModels
ProjectModelPermissions object { mode, model_ids, object } Represents the model allowlist or denylist policy for a project.
ProjectModelPermissions object { mode, model_ids, object }
Represents the model allowlist or denylist policy for a project.
mode: "allow_list" or "deny_list" Whether the project uses an allowlist or a denylist. One of the following: "allow_list" "deny_list" model_ids: array of string The model IDs included in the model permissions policy. object: "project.model_permissions" The object type, which is always project.model_permissions.
OrganizationProjectsRate Limits
List project rate limits
GET
/organization/projects/{project_id}/rate_limitsModify project rate limit
POST
/organization/projects/{project_id}/rate_limits/{rate_limit_id}Models
ProjectRateLimit object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more } Represents a project rate limit config.
ProjectRateLimit object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more }
Represents a project rate limit config.
id: string The identifier, which can be referenced in API endpoints. max_requests_per_1_minute: integer The maximum requests per minute. max_tokens_per_1_minute: integer The maximum tokens per minute. model: string The model this rate limit applies to. object: "project.rate_limit" The object type, which is always project.rate_limit batch_1_day_max_input_tokens: optional integer The maximum batch input tokens per day. Only present for relevant models. max_audio_megabytes_per_1_minute: optional integer The maximum audio megabytes per minute. Only present for relevant models. max_images_per_1_minute: optional integer The maximum images per minute. Only present for relevant models. max_requests_per_1_day: optional integer The maximum requests per day. Only present for relevant models.
OrganizationProjectsRoles
Create project role
POST
/projects/{project_id}/rolesDelete project role
DELETE
/projects/{project_id}/roles/{role_id}List project roles
GET
/projects/{project_id}/rolesRetrieve project role
GET
/projects/{project_id}/roles/{role_id}Update project role
POST
/projects/{project_id}/roles/{role_id}OrganizationProjectsService Accounts
Create project service account
POST
/organization/projects/{project_id}/service_accountsDelete project service account
DELETE
/organization/projects/{project_id}/service_accounts/{service_account_id}List project service accounts
GET
/organization/projects/{project_id}/service_accountsRetrieve project service account
GET
/organization/projects/{project_id}/service_accounts/{service_account_id}Update project service account
POST
/organization/projects/{project_id}/service_accounts/{service_account_id}Models
ProjectServiceAccount object { id, created_at, name, 2 more } Represents an individual service account in a project.
ProjectServiceAccount object { id, created_at, name, 2 more }
Represents an individual service account in a project.
id: string The identifier, which can be referenced in API endpoints created_at: integer The Unix timestamp (in seconds) of when the service account was created formatunixtime name: string The name of the service account object: "organization.project.service_account" The object type, which is always organization.project.service_account role: "owner" or "member" or "none" owner, member, or none One of the following: "owner" "member" "none"
ServiceAccountCreateResponse object { id, api_key, created_at, 3 more }
ServiceAccountCreateResponse object { id, api_key, created_at, 3 more }
id: string api_key: object or null id: string created_at: integer formatunixtime name: string object: "organization.project.service_account.api_key" The object type, which is always organization.project.service_account.api_key value: string expires_at: optional integer or null The Unix timestamp (in seconds) when the API key expires, or null if it does not expire. formatunixtime created_at: integer formatunixtime name: string object: "organization.project.service_account" role: "member" or "none" Service accounts created with default project membership have role member. Accounts created with create_service_account_only have role none. One of the following: "member" "none"
OrganizationProjectsService AccountsAPI Keys
Create an API key for a service account
POST
/organization/projects/{project_id}/service_accounts/{service_account_id}/api_keysModels
APIKeyCreateResponse object { id, created_at, name, 3 more }
APIKeyCreateResponse object { id, created_at, name, 3 more }
id: string The identifier of the API key. created_at: integer The Unix timestamp (in seconds) when the API key was created. formatunixtime name: string The name of the API key. object: "organization.project.service_account.api_key" (default: "organization.project.service_account.api_key") The object type, which is always organization.project.service_account.api_key value: string The unredacted API key value. expires_at: optional integer or null The Unix timestamp (in seconds) when the API key expires, or null if it does not expire. formatunixtime
OrganizationProjectsService Tier Settings
Retrieve project service tier settings
GET
/organization/projects/{project_id}/service_tier_settingsUpdate project service tier settings
POST
/organization/projects/{project_id}/service_tier_settingsModels
ProjectServiceTierSettings object { default, enabled_tiers, object }
ProjectServiceTierSettings object { default, enabled_tiers, object }
default: "standard" or "fast" or "scale" Default tier for requests that omit service_tier or use auto. One of the following: "standard" "fast" "scale" enabled_tiers: "all" or array of ProjectOptionalServiceTier Additional service tiers enabled for this project. “all” includes future tiers. An empty array allows only Standard. Organization policy and eligibility still apply. One of the following: "all" array of ProjectOptionalServiceTier One of the following: "flex" "fast" "ultrafast" object: "project.service_tier_settings" (default: "project.service_tier_settings")
OrganizationProjectsSpend Alerts
Create project spend alert
POST
/organization/projects/{project_id}/spend_alertsDelete project spend alert
DELETE
/organization/projects/{project_id}/spend_alerts/{alert_id}List project spend alerts
GET
/organization/projects/{project_id}/spend_alertsRetrieve project spend alert
GET
/organization/projects/{project_id}/spend_alerts/{alert_id}Update project spend alert
POST
/organization/projects/{project_id}/spend_alerts/{alert_id}Models
ProjectSpendAlert object { id, currency, interval, 3 more } Represents a spend alert configured at the project level.
ProjectSpendAlert object { id, currency, interval, 3 more }
Represents a spend alert configured at the project level.
id: string The identifier, which can be referenced in API endpoints. currency: "USD" The currency for the threshold amount. interval: "month" The time interval for evaluating spend against the threshold. notification_channel: { recipients, type, subject_prefix } Email notification settings for a spend alert. recipients: array of string Email addresses that receive the spend alert notification. type: "email" The notification channel type. Currently only email is supported. subject_prefix: optional string or null Optional subject prefix for alert emails. object: "project.spend_alert" The object type, which is always project.spend_alert. threshold_amount: integer The alert threshold amount, in cents.
OrganizationProjectsSpend Limit
Delete project spend limit
DELETE
/organization/projects/{project_id}/spend_limitGet project spend limit
GET
/organization/projects/{project_id}/spend_limitUpdate project spend limit
POST
/organization/projects/{project_id}/spend_limitModels
ProjectSpendLimit object { currency, enforcement, interval, 2 more } Represents a hard spend limit configured at the project level.
ProjectSpendLimit object { currency, enforcement, interval, 2 more }
Represents a hard spend limit configured at the project level.
currency: string or "USD" The currency for the threshold amount. Currently, only USD is supported. One of the following: string "USD" The currency for the threshold amount. Currently, only USD is supported. enforcement: { status } The current enforcement state of the hard spend limit. status: string or "inactive" or "enforcing" Whether the hard spend limit is currently enforcing. One of the following: string "inactive" or "enforcing" Whether the hard spend limit is currently enforcing. One of the following: "inactive" "enforcing" interval: string or "month" The time interval for evaluating spend against the threshold. Currently, only month is supported. One of the following: string "month" The time interval for evaluating spend against the threshold. Currently, only month is supported. object: "project.spend_limit" (default: "project.spend_limit") The object type, which is always project.spend_limit. threshold_amount: integer The hard spend limit amount, in cents.
OrganizationProjectsUsers
Create project user
POST
/organization/projects/{project_id}/usersDelete project user
DELETE
/organization/projects/{project_id}/users/{user_id}List project users
GET
/organization/projects/{project_id}/usersRetrieve project user
GET
/organization/projects/{project_id}/users/{user_id}Modify project user
POST
/organization/projects/{project_id}/users/{user_id}Models
ProjectUser object { id, added_at, object, 3 more } Represents an individual user in a project.
ProjectUser object { id, added_at, object, 3 more }
Represents an individual user in a project.
id: string The identifier, which can be referenced in API endpoints added_at: integer The Unix timestamp (in seconds) of when the project was added. formatunixtime object: "organization.project.user" The object type, which is always organization.project.user role: string owner or member email: optional string or null The email address of the user name: optional string or null The name of the user
OrganizationProjectsUsersRoles
Assign project role to user
POST
/projects/{project_id}/users/{user_id}/rolesUnassign project role from user
DELETE
/projects/{project_id}/users/{user_id}/roles/{role_id}List project user role assignments
GET
/projects/{project_id}/users/{user_id}/rolesRetrieve project user role
GET
/projects/{project_id}/users/{user_id}/roles/{role_id}Models
RoleCreateResponse object { object, role, user } Role assignment linking a user to a role.
RoleCreateResponse object { object, role, user }
Role assignment linking a user to a role.
object: "user.role" Always user.role. role: Role { id, description, name, 4 more } Details about a role that can be assigned through the public Roles API. user: OrganizationUser { id, added_at, object, 13 more } Represents an individual user within an organization.
RoleListResponse object { id, assignment_sources, created_at, 9 more } Detailed information about a role assignment entry returned when listing assignments.
RoleListResponse object { id, assignment_sources, created_at, 9 more }
Detailed information about a role assignment entry returned when listing assignments.
id: string Identifier for the role. assignment_sources: array of object or null Principals from which the role assignment is inherited, when available. principal_id: string principal_type: string created_at: integer or null When the role was created. formatunixtime created_by: string or null Identifier of the actor who created the role. created_by_user_obj: map[unknown] or null User details for the actor that created the role, when available. description: string or null Description of the role. metadata: map[unknown] or null Arbitrary metadata stored on the role. name: string Name of the role. permissions: array of string Permissions associated with the role. predefined_role: boolean Whether the role is predefined by OpenAI. resource_type: string Resource type the role applies to. updated_at: integer or null When the role was last updated. formatunixtime
RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more } Detailed information about a role assignment entry returned when listing assignments.
RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more }
Detailed information about a role assignment entry returned when listing assignments.
id: string Identifier for the role. assignment_sources: array of object or null Principals from which the role assignment is inherited, when available. principal_id: string principal_type: string created_at: integer or null When the role was created. formatunixtime created_by: string or null Identifier of the actor who created the role. created_by_user_obj: map[unknown] or null User details for the actor that created the role, when available. description: string or null Description of the role. metadata: map[unknown] or null Arbitrary metadata stored on the role. name: string Name of the role. permissions: array of string Permissions associated with the role. predefined_role: boolean Whether the role is predefined by OpenAI. resource_type: string Resource type the role applies to. updated_at: integer or null When the role was last updated. formatunixtime
OrganizationRoles
Create organization role
POST
/organization/rolesDelete organization role
DELETE
/organization/roles/{role_id}List organization roles
GET
/organization/rolesRetrieve organization role
GET
/organization/roles/{role_id}Update organization role
POST
/organization/roles/{role_id}Models
Role object { id, description, name, 4 more } Details about a role that can be assigned through the public Roles API.
Role object { id, description, name, 4 more }
Details about a role that can be assigned through the public Roles API.
id: string Identifier for the role. description: string or null Optional description of the role. name: string Unique name for the role. object: "role" Always role. permissions: array of string Permissions granted by the role. predefined_role: boolean Whether the role is predefined and managed by OpenAI. resource_type: string Resource type the role is bound to (for example api.organization or api.project).
OrganizationSpend Alerts
Create organization spend alert
POST
/organization/spend_alertsDelete organization spend alert
DELETE
/organization/spend_alerts/{alert_id}List organization spend alerts
GET
/organization/spend_alertsRetrieve organization spend alert
GET
/organization/spend_alerts/{alert_id}Update organization spend alert
POST
/organization/spend_alerts/{alert_id}Models
OrganizationSpendAlert object { id, currency, interval, 3 more } Represents a spend alert configured at the organization level.
OrganizationSpendAlert object { id, currency, interval, 3 more }
Represents a spend alert configured at the organization level.
id: string The identifier, which can be referenced in API endpoints. currency: "USD" The currency for the threshold amount. interval: "month" The time interval for evaluating spend against the threshold. notification_channel: { recipients, type, subject_prefix } Email notification settings for a spend alert. recipients: array of string Email addresses that receive the spend alert notification. type: "email" The notification channel type. Currently only email is supported. subject_prefix: optional string or null Optional subject prefix for alert emails. object: "organization.spend_alert" The object type, which is always organization.spend_alert. threshold_amount: integer The alert threshold amount, in cents.
OrganizationSpend Limit
Delete organization spend limit
DELETE
/organization/spend_limitGet organization spend limit
GET
/organization/spend_limitUpdate organization spend limit
POST
/organization/spend_limitModels
OrganizationSpendLimit object { currency, enforcement, interval, 2 more } Represents a hard spend limit configured at the organization level.
OrganizationSpendLimit object { currency, enforcement, interval, 2 more }
Represents a hard spend limit configured at the organization level.
currency: string or "USD" The currency for the threshold amount. Currently, only USD is supported. One of the following: string "USD" The currency for the threshold amount. Currently, only USD is supported. enforcement: { status } The current enforcement state of the hard spend limit. status: string or "inactive" or "enforcing" Whether the hard spend limit is currently enforcing. One of the following: string "inactive" or "enforcing" Whether the hard spend limit is currently enforcing. One of the following: "inactive" "enforcing" interval: string or "month" The time interval for evaluating spend against the threshold. Currently, only month is supported. One of the following: string "month" The time interval for evaluating spend against the threshold. Currently, only month is supported. object: "organization.spend_limit" (default: "organization.spend_limit") The object type, which is always organization.spend_limit. threshold_amount: integer The hard spend limit amount, in cents.
OrganizationUsage
Audio speeches
GET
/organization/usage/audio_speechesAudio transcriptions
GET
/organization/usage/audio_transcriptionsCode interpreter sessions
GET
/organization/usage/code_interpreter_sessionsCompletions
GET
/organization/usage/completionsCosts
GET
/organization/costsDecisions
GET
/organization/usage/decisionsEmbeddings
GET
/organization/usage/embeddingsFile search calls
GET
/organization/usage/file_search_callsImages
GET
/organization/usage/imagesModerations
GET
/organization/usage/moderationsVector stores
GET
/organization/usage/vector_storesWeb search calls
GET
/organization/usage/web_search_callsModels
CostQuantityUnit = string or "tokens" or "1000_tokens" or "duration_seconds" or 5 moreThe unit of the quantity value. If no single supported unit applies to the result, this field is null.
CostQuantityUnit = string or "tokens" or "1000_tokens" or "duration_seconds" or 5 more
The unit of the quantity value. If no single supported unit applies to the result, this field is null.
One of the following: string "tokens" or "1000_tokens" or "duration_seconds" or 5 more The unit of the quantity value. If no single supported unit applies to the result, this field is null. One of the following: "tokens" "1000_tokens" "duration_seconds" "duration_minutes" "duration_hours" "gibibyte_hours" "images" "characters"
UsageAudioSpeechesResponse object { data, has_more, next_page, object }
UsageAudioSpeechesResponse object { data, has_more, next_page, object }
data: array of { end_time, object, results, start_time } end_time: integer object: "bucket" results: array of OrganizationUsageCompletionsResult or OrganizationUsageEmbeddingsResult or OrganizationUsageModerationsResult or 8 more One of the following: OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens. num_model_requests: integer The count of requests made to the model. object: "organization.usage.completions.result" output_tokens: integer The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" batch: optional boolean or null When group_by=batch, this field tells whether the grouped usage result is batch or not. input_audio_tokens: optional integer The aggregated number of uncached audio input tokens used. input_cache_write_12h_tokens: optional integer The aggregated number of input tokens written to the cache with a 12-hour retention period. input_cache_write_30m_tokens: optional integer or null The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses. input_cache_write_tokens: optional integer The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods. input_cached_audio_tokens: optional integer The aggregated number of cached audio input tokens used. input_cached_image_tokens: optional integer The aggregated number of cached image input tokens used. input_cached_text_tokens: optional integer The aggregated number of cached text input tokens used. input_cached_tokens: optional integer The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. input_image_tokens: optional integer The aggregated number of uncached image input tokens used. input_text_tokens: optional integer The aggregated number of uncached text input tokens used, excluding cache-write tokens. input_uncached_tokens: optional integer The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. output_audio_tokens: optional integer The aggregated number of audio output tokens used. output_image_tokens: optional integer The aggregated number of image output tokens used. output_text_tokens: optional integer The aggregated number of text output tokens used. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. service_tier: optional string or null When group_by=service_tier, this field provides the service tier of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.embeddings.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.moderations.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageImagesResult { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket. images: integer The number of images processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.images.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. size: optional string or null When group_by=size, this field provides the image size of the grouped usage result. source: optional string or null When group_by=source, this field provides the source of the grouped usage result, possible values are image.generation, image.edit, image.variation. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioSpeechesResult { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket. characters: integer The number of characters processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_speeches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioTranscriptionsResult { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_transcriptions.result" seconds: integer The number of seconds processed. formatint64 api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageVectorStoresResult { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket. object: "organization.usage.vector_stores.result" usage_bytes: integer The vector stores usage in bytes. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageCodeInterpreterSessionsResult { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket. num_sessions: integer The number of code interpreter sessions. object: "organization.usage.code_interpreter_sessions.result" project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageFileSearchesResult { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket. num_requests: integer The count of file search calls. object: "organization.usage.file_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. vector_store_id: optional string or null When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result. OrganizationUsageWebSearchesResult { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket. num_model_requests: integer The count of model requests. num_requests: integer The count of web search calls. object: "organization.usage.web_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" context_level: optional string or null When group_by=context_level, this field provides the search context size of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationCostsResult { object, amount, api_key_id, 6 more } The aggregated costs details of the specific time bucket. object: "organization.costs.result" amount: optional { currency, value } The monetary value in its associated currency. currency: optional string Lowercase ISO-4217 currency e.g. “usd” value: optional number The numeric value of the cost. api_key_id: optional string or null When group_by=api_key_id, this field provides the API Key ID of the grouped costs result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" line_item: optional string or null When group_by=line_item, this field provides the line item of the grouped costs result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped costs result. quantity: optional number or null When group_by=line_item, this field provides the quantity of the grouped costs result. quantity_unit: optional CostQuantityUnit or null The unit of the quantity value. If no single supported unit applies to the result, this field is null. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped costs result. start_time: integer has_more: boolean next_page: string or null object: "page"
UsageAudioTranscriptionsResponse object { data, has_more, next_page, object }
UsageAudioTranscriptionsResponse object { data, has_more, next_page, object }
data: array of { end_time, object, results, start_time } end_time: integer object: "bucket" results: array of OrganizationUsageCompletionsResult or OrganizationUsageEmbeddingsResult or OrganizationUsageModerationsResult or 8 more One of the following: OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens. num_model_requests: integer The count of requests made to the model. object: "organization.usage.completions.result" output_tokens: integer The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" batch: optional boolean or null When group_by=batch, this field tells whether the grouped usage result is batch or not. input_audio_tokens: optional integer The aggregated number of uncached audio input tokens used. input_cache_write_12h_tokens: optional integer The aggregated number of input tokens written to the cache with a 12-hour retention period. input_cache_write_30m_tokens: optional integer or null The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses. input_cache_write_tokens: optional integer The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods. input_cached_audio_tokens: optional integer The aggregated number of cached audio input tokens used. input_cached_image_tokens: optional integer The aggregated number of cached image input tokens used. input_cached_text_tokens: optional integer The aggregated number of cached text input tokens used. input_cached_tokens: optional integer The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. input_image_tokens: optional integer The aggregated number of uncached image input tokens used. input_text_tokens: optional integer The aggregated number of uncached text input tokens used, excluding cache-write tokens. input_uncached_tokens: optional integer The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. output_audio_tokens: optional integer The aggregated number of audio output tokens used. output_image_tokens: optional integer The aggregated number of image output tokens used. output_text_tokens: optional integer The aggregated number of text output tokens used. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. service_tier: optional string or null When group_by=service_tier, this field provides the service tier of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.embeddings.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.moderations.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageImagesResult { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket. images: integer The number of images processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.images.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. size: optional string or null When group_by=size, this field provides the image size of the grouped usage result. source: optional string or null When group_by=source, this field provides the source of the grouped usage result, possible values are image.generation, image.edit, image.variation. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioSpeechesResult { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket. characters: integer The number of characters processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_speeches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioTranscriptionsResult { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_transcriptions.result" seconds: integer The number of seconds processed. formatint64 api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageVectorStoresResult { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket. object: "organization.usage.vector_stores.result" usage_bytes: integer The vector stores usage in bytes. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageCodeInterpreterSessionsResult { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket. num_sessions: integer The number of code interpreter sessions. object: "organization.usage.code_interpreter_sessions.result" project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageFileSearchesResult { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket. num_requests: integer The count of file search calls. object: "organization.usage.file_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. vector_store_id: optional string or null When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result. OrganizationUsageWebSearchesResult { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket. num_model_requests: integer The count of model requests. num_requests: integer The count of web search calls. object: "organization.usage.web_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" context_level: optional string or null When group_by=context_level, this field provides the search context size of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationCostsResult { object, amount, api_key_id, 6 more } The aggregated costs details of the specific time bucket. object: "organization.costs.result" amount: optional { currency, value } The monetary value in its associated currency. currency: optional string Lowercase ISO-4217 currency e.g. “usd” value: optional number The numeric value of the cost. api_key_id: optional string or null When group_by=api_key_id, this field provides the API Key ID of the grouped costs result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" line_item: optional string or null When group_by=line_item, this field provides the line item of the grouped costs result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped costs result. quantity: optional number or null When group_by=line_item, this field provides the quantity of the grouped costs result. quantity_unit: optional CostQuantityUnit or null The unit of the quantity value. If no single supported unit applies to the result, this field is null. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped costs result. start_time: integer has_more: boolean next_page: string or null object: "page"
UsageCodeInterpreterSessionsResponse object { data, has_more, next_page, object }
UsageCodeInterpreterSessionsResponse object { data, has_more, next_page, object }
data: array of { end_time, object, results, start_time } end_time: integer object: "bucket" results: array of OrganizationUsageCompletionsResult or OrganizationUsageEmbeddingsResult or OrganizationUsageModerationsResult or 8 more One of the following: OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens. num_model_requests: integer The count of requests made to the model. object: "organization.usage.completions.result" output_tokens: integer The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" batch: optional boolean or null When group_by=batch, this field tells whether the grouped usage result is batch or not. input_audio_tokens: optional integer The aggregated number of uncached audio input tokens used. input_cache_write_12h_tokens: optional integer The aggregated number of input tokens written to the cache with a 12-hour retention period. input_cache_write_30m_tokens: optional integer or null The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses. input_cache_write_tokens: optional integer The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods. input_cached_audio_tokens: optional integer The aggregated number of cached audio input tokens used. input_cached_image_tokens: optional integer The aggregated number of cached image input tokens used. input_cached_text_tokens: optional integer The aggregated number of cached text input tokens used. input_cached_tokens: optional integer The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. input_image_tokens: optional integer The aggregated number of uncached image input tokens used. input_text_tokens: optional integer The aggregated number of uncached text input tokens used, excluding cache-write tokens. input_uncached_tokens: optional integer The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. output_audio_tokens: optional integer The aggregated number of audio output tokens used. output_image_tokens: optional integer The aggregated number of image output tokens used. output_text_tokens: optional integer The aggregated number of text output tokens used. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. service_tier: optional string or null When group_by=service_tier, this field provides the service tier of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.embeddings.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.moderations.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageImagesResult { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket. images: integer The number of images processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.images.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. size: optional string or null When group_by=size, this field provides the image size of the grouped usage result. source: optional string or null When group_by=source, this field provides the source of the grouped usage result, possible values are image.generation, image.edit, image.variation. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioSpeechesResult { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket. characters: integer The number of characters processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_speeches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioTranscriptionsResult { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_transcriptions.result" seconds: integer The number of seconds processed. formatint64 api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageVectorStoresResult { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket. object: "organization.usage.vector_stores.result" usage_bytes: integer The vector stores usage in bytes. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageCodeInterpreterSessionsResult { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket. num_sessions: integer The number of code interpreter sessions. object: "organization.usage.code_interpreter_sessions.result" project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageFileSearchesResult { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket. num_requests: integer The count of file search calls. object: "organization.usage.file_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. vector_store_id: optional string or null When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result. OrganizationUsageWebSearchesResult { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket. num_model_requests: integer The count of model requests. num_requests: integer The count of web search calls. object: "organization.usage.web_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" context_level: optional string or null When group_by=context_level, this field provides the search context size of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationCostsResult { object, amount, api_key_id, 6 more } The aggregated costs details of the specific time bucket. object: "organization.costs.result" amount: optional { currency, value } The monetary value in its associated currency. currency: optional string Lowercase ISO-4217 currency e.g. “usd” value: optional number The numeric value of the cost. api_key_id: optional string or null When group_by=api_key_id, this field provides the API Key ID of the grouped costs result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" line_item: optional string or null When group_by=line_item, this field provides the line item of the grouped costs result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped costs result. quantity: optional number or null When group_by=line_item, this field provides the quantity of the grouped costs result. quantity_unit: optional CostQuantityUnit or null The unit of the quantity value. If no single supported unit applies to the result, this field is null. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped costs result. start_time: integer has_more: boolean next_page: string or null object: "page"
UsageCompletionsResponse object { data, has_more, next_page, object }
UsageCompletionsResponse object { data, has_more, next_page, object }
data: array of { end_time, object, results, start_time } end_time: integer object: "bucket" results: array of OrganizationUsageCompletionsResult or OrganizationUsageEmbeddingsResult or OrganizationUsageModerationsResult or 8 more One of the following: OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens. num_model_requests: integer The count of requests made to the model. object: "organization.usage.completions.result" output_tokens: integer The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" batch: optional boolean or null When group_by=batch, this field tells whether the grouped usage result is batch or not. input_audio_tokens: optional integer The aggregated number of uncached audio input tokens used. input_cache_write_12h_tokens: optional integer The aggregated number of input tokens written to the cache with a 12-hour retention period. input_cache_write_30m_tokens: optional integer or null The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses. input_cache_write_tokens: optional integer The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods. input_cached_audio_tokens: optional integer The aggregated number of cached audio input tokens used. input_cached_image_tokens: optional integer The aggregated number of cached image input tokens used. input_cached_text_tokens: optional integer The aggregated number of cached text input tokens used. input_cached_tokens: optional integer The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. input_image_tokens: optional integer The aggregated number of uncached image input tokens used. input_text_tokens: optional integer The aggregated number of uncached text input tokens used, excluding cache-write tokens. input_uncached_tokens: optional integer The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. output_audio_tokens: optional integer The aggregated number of audio output tokens used. output_image_tokens: optional integer The aggregated number of image output tokens used. output_text_tokens: optional integer The aggregated number of text output tokens used. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. service_tier: optional string or null When group_by=service_tier, this field provides the service tier of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.embeddings.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.moderations.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageImagesResult { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket. images: integer The number of images processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.images.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. size: optional string or null When group_by=size, this field provides the image size of the grouped usage result. source: optional string or null When group_by=source, this field provides the source of the grouped usage result, possible values are image.generation, image.edit, image.variation. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioSpeechesResult { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket. characters: integer The number of characters processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_speeches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioTranscriptionsResult { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_transcriptions.result" seconds: integer The number of seconds processed. formatint64 api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageVectorStoresResult { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket. object: "organization.usage.vector_stores.result" usage_bytes: integer The vector stores usage in bytes. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageCodeInterpreterSessionsResult { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket. num_sessions: integer The number of code interpreter sessions. object: "organization.usage.code_interpreter_sessions.result" project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageFileSearchesResult { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket. num_requests: integer The count of file search calls. object: "organization.usage.file_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. vector_store_id: optional string or null When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result. OrganizationUsageWebSearchesResult { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket. num_model_requests: integer The count of model requests. num_requests: integer The count of web search calls. object: "organization.usage.web_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" context_level: optional string or null When group_by=context_level, this field provides the search context size of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationCostsResult { object, amount, api_key_id, 6 more } The aggregated costs details of the specific time bucket. object: "organization.costs.result" amount: optional { currency, value } The monetary value in its associated currency. currency: optional string Lowercase ISO-4217 currency e.g. “usd” value: optional number The numeric value of the cost. api_key_id: optional string or null When group_by=api_key_id, this field provides the API Key ID of the grouped costs result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" line_item: optional string or null When group_by=line_item, this field provides the line item of the grouped costs result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped costs result. quantity: optional number or null When group_by=line_item, this field provides the quantity of the grouped costs result. quantity_unit: optional CostQuantityUnit or null The unit of the quantity value. If no single supported unit applies to the result, this field is null. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped costs result. start_time: integer has_more: boolean next_page: string or null object: "page"
UsageCostsResponse object { data, has_more, next_page, object }
UsageCostsResponse object { data, has_more, next_page, object }
data: array of { end_time, object, results, start_time } end_time: integer object: "bucket" results: array of OrganizationUsageCompletionsResult or OrganizationUsageEmbeddingsResult or OrganizationUsageModerationsResult or 8 more One of the following: OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens. num_model_requests: integer The count of requests made to the model. object: "organization.usage.completions.result" output_tokens: integer The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" batch: optional boolean or null When group_by=batch, this field tells whether the grouped usage result is batch or not. input_audio_tokens: optional integer The aggregated number of uncached audio input tokens used. input_cache_write_12h_tokens: optional integer The aggregated number of input tokens written to the cache with a 12-hour retention period. input_cache_write_30m_tokens: optional integer or null The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses. input_cache_write_tokens: optional integer The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods. input_cached_audio_tokens: optional integer The aggregated number of cached audio input tokens used. input_cached_image_tokens: optional integer The aggregated number of cached image input tokens used. input_cached_text_tokens: optional integer The aggregated number of cached text input tokens used. input_cached_tokens: optional integer The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. input_image_tokens: optional integer The aggregated number of uncached image input tokens used. input_text_tokens: optional integer The aggregated number of uncached text input tokens used, excluding cache-write tokens. input_uncached_tokens: optional integer The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. output_audio_tokens: optional integer The aggregated number of audio output tokens used. output_image_tokens: optional integer The aggregated number of image output tokens used. output_text_tokens: optional integer The aggregated number of text output tokens used. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. service_tier: optional string or null When group_by=service_tier, this field provides the service tier of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.embeddings.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.moderations.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageImagesResult { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket. images: integer The number of images processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.images.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. size: optional string or null When group_by=size, this field provides the image size of the grouped usage result. source: optional string or null When group_by=source, this field provides the source of the grouped usage result, possible values are image.generation, image.edit, image.variation. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioSpeechesResult { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket. characters: integer The number of characters processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_speeches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioTranscriptionsResult { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_transcriptions.result" seconds: integer The number of seconds processed. formatint64 api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageVectorStoresResult { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket. object: "organization.usage.vector_stores.result" usage_bytes: integer The vector stores usage in bytes. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageCodeInterpreterSessionsResult { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket. num_sessions: integer The number of code interpreter sessions. object: "organization.usage.code_interpreter_sessions.result" project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageFileSearchesResult { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket. num_requests: integer The count of file search calls. object: "organization.usage.file_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. vector_store_id: optional string or null When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result. OrganizationUsageWebSearchesResult { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket. num_model_requests: integer The count of model requests. num_requests: integer The count of web search calls. object: "organization.usage.web_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" context_level: optional string or null When group_by=context_level, this field provides the search context size of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationCostsResult { object, amount, api_key_id, 6 more } The aggregated costs details of the specific time bucket. object: "organization.costs.result" amount: optional { currency, value } The monetary value in its associated currency. currency: optional string Lowercase ISO-4217 currency e.g. “usd” value: optional number The numeric value of the cost. api_key_id: optional string or null When group_by=api_key_id, this field provides the API Key ID of the grouped costs result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" line_item: optional string or null When group_by=line_item, this field provides the line item of the grouped costs result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped costs result. quantity: optional number or null When group_by=line_item, this field provides the quantity of the grouped costs result. quantity_unit: optional CostQuantityUnit or null The unit of the quantity value. If no single supported unit applies to the result, this field is null. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped costs result. start_time: integer has_more: boolean next_page: string or null object: "page"
UsageDecisionsResponse object { data, has_more, next_page, object }
UsageDecisionsResponse object { data, has_more, next_page, object }
data: array of { end_time, object, results, start_time } end_time: integer object: "bucket" (default: "bucket") results: array of { input_tokens, num_model_requests, object, 22 more } input_tokens: integer The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens. num_model_requests: integer The count of requests made to the model. object: "organization.usage.decisions.result" (default: "organization.usage.decisions.result") output_tokens: integer The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" batch: optional boolean or null When group_by=batch, this field tells whether the grouped usage result is batch or not. input_audio_tokens: optional integer or null The aggregated number of uncached audio input tokens used. input_cache_write_12h_tokens: optional integer or null The aggregated number of input tokens written to the cache with a 12-hour retention period. input_cache_write_30m_tokens: optional integer or null The aggregated number of input tokens written to the cache with a 30-minute retention period. input_cache_write_tokens: optional integer or null The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods. input_cached_audio_tokens: optional integer or null The aggregated number of cached audio input tokens used. input_cached_image_tokens: optional integer or null The aggregated number of cached image input tokens used. input_cached_text_tokens: optional integer or null The aggregated number of cached text input tokens used. input_cached_tokens: optional integer or null The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. input_image_tokens: optional integer or null The aggregated number of uncached image input tokens used. input_text_tokens: optional integer or null The aggregated number of uncached text input tokens used, excluding cache-write tokens. input_uncached_tokens: optional integer or null The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. output_audio_tokens: optional integer or null The aggregated number of audio output tokens used. output_image_tokens: optional integer or null The aggregated number of image output tokens used. output_text_tokens: optional integer or null The aggregated number of text output tokens used. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. service_tier: optional string or null When group_by=service_tier, this field provides the service tier of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. start_time: integer has_more: boolean next_page: string or null object: "page" (default: "page")
UsageEmbeddingsResponse object { data, has_more, next_page, object }
UsageEmbeddingsResponse object { data, has_more, next_page, object }
data: array of { end_time, object, results, start_time } end_time: integer object: "bucket" results: array of OrganizationUsageCompletionsResult or OrganizationUsageEmbeddingsResult or OrganizationUsageModerationsResult or 8 more One of the following: OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens. num_model_requests: integer The count of requests made to the model. object: "organization.usage.completions.result" output_tokens: integer The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" batch: optional boolean or null When group_by=batch, this field tells whether the grouped usage result is batch or not. input_audio_tokens: optional integer The aggregated number of uncached audio input tokens used. input_cache_write_12h_tokens: optional integer The aggregated number of input tokens written to the cache with a 12-hour retention period. input_cache_write_30m_tokens: optional integer or null The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses. input_cache_write_tokens: optional integer The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods. input_cached_audio_tokens: optional integer The aggregated number of cached audio input tokens used. input_cached_image_tokens: optional integer The aggregated number of cached image input tokens used. input_cached_text_tokens: optional integer The aggregated number of cached text input tokens used. input_cached_tokens: optional integer The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. input_image_tokens: optional integer The aggregated number of uncached image input tokens used. input_text_tokens: optional integer The aggregated number of uncached text input tokens used, excluding cache-write tokens. input_uncached_tokens: optional integer The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. output_audio_tokens: optional integer The aggregated number of audio output tokens used. output_image_tokens: optional integer The aggregated number of image output tokens used. output_text_tokens: optional integer The aggregated number of text output tokens used. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. service_tier: optional string or null When group_by=service_tier, this field provides the service tier of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.embeddings.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.moderations.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageImagesResult { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket. images: integer The number of images processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.images.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. size: optional string or null When group_by=size, this field provides the image size of the grouped usage result. source: optional string or null When group_by=source, this field provides the source of the grouped usage result, possible values are image.generation, image.edit, image.variation. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioSpeechesResult { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket. characters: integer The number of characters processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_speeches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioTranscriptionsResult { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_transcriptions.result" seconds: integer The number of seconds processed. formatint64 api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageVectorStoresResult { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket. object: "organization.usage.vector_stores.result" usage_bytes: integer The vector stores usage in bytes. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageCodeInterpreterSessionsResult { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket. num_sessions: integer The number of code interpreter sessions. object: "organization.usage.code_interpreter_sessions.result" project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageFileSearchesResult { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket. num_requests: integer The count of file search calls. object: "organization.usage.file_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. vector_store_id: optional string or null When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result. OrganizationUsageWebSearchesResult { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket. num_model_requests: integer The count of model requests. num_requests: integer The count of web search calls. object: "organization.usage.web_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" context_level: optional string or null When group_by=context_level, this field provides the search context size of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationCostsResult { object, amount, api_key_id, 6 more } The aggregated costs details of the specific time bucket. object: "organization.costs.result" amount: optional { currency, value } The monetary value in its associated currency. currency: optional string Lowercase ISO-4217 currency e.g. “usd” value: optional number The numeric value of the cost. api_key_id: optional string or null When group_by=api_key_id, this field provides the API Key ID of the grouped costs result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" line_item: optional string or null When group_by=line_item, this field provides the line item of the grouped costs result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped costs result. quantity: optional number or null When group_by=line_item, this field provides the quantity of the grouped costs result. quantity_unit: optional CostQuantityUnit or null The unit of the quantity value. If no single supported unit applies to the result, this field is null. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped costs result. start_time: integer has_more: boolean next_page: string or null object: "page"
UsageFileSearchCallsResponse object { data, has_more, next_page, object }
UsageFileSearchCallsResponse object { data, has_more, next_page, object }
data: array of { end_time, object, results, start_time } end_time: integer object: "bucket" results: array of OrganizationUsageCompletionsResult or OrganizationUsageEmbeddingsResult or OrganizationUsageModerationsResult or 8 more One of the following: OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens. num_model_requests: integer The count of requests made to the model. object: "organization.usage.completions.result" output_tokens: integer The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" batch: optional boolean or null When group_by=batch, this field tells whether the grouped usage result is batch or not. input_audio_tokens: optional integer The aggregated number of uncached audio input tokens used. input_cache_write_12h_tokens: optional integer The aggregated number of input tokens written to the cache with a 12-hour retention period. input_cache_write_30m_tokens: optional integer or null The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses. input_cache_write_tokens: optional integer The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods. input_cached_audio_tokens: optional integer The aggregated number of cached audio input tokens used. input_cached_image_tokens: optional integer The aggregated number of cached image input tokens used. input_cached_text_tokens: optional integer The aggregated number of cached text input tokens used. input_cached_tokens: optional integer The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. input_image_tokens: optional integer The aggregated number of uncached image input tokens used. input_text_tokens: optional integer The aggregated number of uncached text input tokens used, excluding cache-write tokens. input_uncached_tokens: optional integer The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. output_audio_tokens: optional integer The aggregated number of audio output tokens used. output_image_tokens: optional integer The aggregated number of image output tokens used. output_text_tokens: optional integer The aggregated number of text output tokens used. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. service_tier: optional string or null When group_by=service_tier, this field provides the service tier of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.embeddings.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.moderations.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageImagesResult { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket. images: integer The number of images processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.images.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. size: optional string or null When group_by=size, this field provides the image size of the grouped usage result. source: optional string or null When group_by=source, this field provides the source of the grouped usage result, possible values are image.generation, image.edit, image.variation. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioSpeechesResult { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket. characters: integer The number of characters processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_speeches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioTranscriptionsResult { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_transcriptions.result" seconds: integer The number of seconds processed. formatint64 api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageVectorStoresResult { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket. object: "organization.usage.vector_stores.result" usage_bytes: integer The vector stores usage in bytes. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageCodeInterpreterSessionsResult { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket. num_sessions: integer The number of code interpreter sessions. object: "organization.usage.code_interpreter_sessions.result" project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageFileSearchesResult { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket. num_requests: integer The count of file search calls. object: "organization.usage.file_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. vector_store_id: optional string or null When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result. OrganizationUsageWebSearchesResult { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket. num_model_requests: integer The count of model requests. num_requests: integer The count of web search calls. object: "organization.usage.web_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" context_level: optional string or null When group_by=context_level, this field provides the search context size of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationCostsResult { object, amount, api_key_id, 6 more } The aggregated costs details of the specific time bucket. object: "organization.costs.result" amount: optional { currency, value } The monetary value in its associated currency. currency: optional string Lowercase ISO-4217 currency e.g. “usd” value: optional number The numeric value of the cost. api_key_id: optional string or null When group_by=api_key_id, this field provides the API Key ID of the grouped costs result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" line_item: optional string or null When group_by=line_item, this field provides the line item of the grouped costs result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped costs result. quantity: optional number or null When group_by=line_item, this field provides the quantity of the grouped costs result. quantity_unit: optional CostQuantityUnit or null The unit of the quantity value. If no single supported unit applies to the result, this field is null. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped costs result. start_time: integer has_more: boolean next_page: string or null object: "page"
UsageImagesResponse object { data, has_more, next_page, object }
UsageImagesResponse object { data, has_more, next_page, object }
data: array of { end_time, object, results, start_time } end_time: integer object: "bucket" results: array of OrganizationUsageCompletionsResult or OrganizationUsageEmbeddingsResult or OrganizationUsageModerationsResult or 8 more One of the following: OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens. num_model_requests: integer The count of requests made to the model. object: "organization.usage.completions.result" output_tokens: integer The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" batch: optional boolean or null When group_by=batch, this field tells whether the grouped usage result is batch or not. input_audio_tokens: optional integer The aggregated number of uncached audio input tokens used. input_cache_write_12h_tokens: optional integer The aggregated number of input tokens written to the cache with a 12-hour retention period. input_cache_write_30m_tokens: optional integer or null The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses. input_cache_write_tokens: optional integer The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods. input_cached_audio_tokens: optional integer The aggregated number of cached audio input tokens used. input_cached_image_tokens: optional integer The aggregated number of cached image input tokens used. input_cached_text_tokens: optional integer The aggregated number of cached text input tokens used. input_cached_tokens: optional integer The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. input_image_tokens: optional integer The aggregated number of uncached image input tokens used. input_text_tokens: optional integer The aggregated number of uncached text input tokens used, excluding cache-write tokens. input_uncached_tokens: optional integer The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. output_audio_tokens: optional integer The aggregated number of audio output tokens used. output_image_tokens: optional integer The aggregated number of image output tokens used. output_text_tokens: optional integer The aggregated number of text output tokens used. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. service_tier: optional string or null When group_by=service_tier, this field provides the service tier of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.embeddings.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.moderations.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageImagesResult { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket. images: integer The number of images processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.images.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. size: optional string or null When group_by=size, this field provides the image size of the grouped usage result. source: optional string or null When group_by=source, this field provides the source of the grouped usage result, possible values are image.generation, image.edit, image.variation. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioSpeechesResult { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket. characters: integer The number of characters processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_speeches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioTranscriptionsResult { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_transcriptions.result" seconds: integer The number of seconds processed. formatint64 api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageVectorStoresResult { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket. object: "organization.usage.vector_stores.result" usage_bytes: integer The vector stores usage in bytes. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageCodeInterpreterSessionsResult { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket. num_sessions: integer The number of code interpreter sessions. object: "organization.usage.code_interpreter_sessions.result" project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageFileSearchesResult { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket. num_requests: integer The count of file search calls. object: "organization.usage.file_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. vector_store_id: optional string or null When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result. OrganizationUsageWebSearchesResult { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket. num_model_requests: integer The count of model requests. num_requests: integer The count of web search calls. object: "organization.usage.web_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" context_level: optional string or null When group_by=context_level, this field provides the search context size of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationCostsResult { object, amount, api_key_id, 6 more } The aggregated costs details of the specific time bucket. object: "organization.costs.result" amount: optional { currency, value } The monetary value in its associated currency. currency: optional string Lowercase ISO-4217 currency e.g. “usd” value: optional number The numeric value of the cost. api_key_id: optional string or null When group_by=api_key_id, this field provides the API Key ID of the grouped costs result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" line_item: optional string or null When group_by=line_item, this field provides the line item of the grouped costs result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped costs result. quantity: optional number or null When group_by=line_item, this field provides the quantity of the grouped costs result. quantity_unit: optional CostQuantityUnit or null The unit of the quantity value. If no single supported unit applies to the result, this field is null. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped costs result. start_time: integer has_more: boolean next_page: string or null object: "page"
UsageModerationsResponse object { data, has_more, next_page, object }
UsageModerationsResponse object { data, has_more, next_page, object }
data: array of { end_time, object, results, start_time } end_time: integer object: "bucket" results: array of OrganizationUsageCompletionsResult or OrganizationUsageEmbeddingsResult or OrganizationUsageModerationsResult or 8 more One of the following: OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens. num_model_requests: integer The count of requests made to the model. object: "organization.usage.completions.result" output_tokens: integer The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" batch: optional boolean or null When group_by=batch, this field tells whether the grouped usage result is batch or not. input_audio_tokens: optional integer The aggregated number of uncached audio input tokens used. input_cache_write_12h_tokens: optional integer The aggregated number of input tokens written to the cache with a 12-hour retention period. input_cache_write_30m_tokens: optional integer or null The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses. input_cache_write_tokens: optional integer The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods. input_cached_audio_tokens: optional integer The aggregated number of cached audio input tokens used. input_cached_image_tokens: optional integer The aggregated number of cached image input tokens used. input_cached_text_tokens: optional integer The aggregated number of cached text input tokens used. input_cached_tokens: optional integer The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. input_image_tokens: optional integer The aggregated number of uncached image input tokens used. input_text_tokens: optional integer The aggregated number of uncached text input tokens used, excluding cache-write tokens. input_uncached_tokens: optional integer The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. output_audio_tokens: optional integer The aggregated number of audio output tokens used. output_image_tokens: optional integer The aggregated number of image output tokens used. output_text_tokens: optional integer The aggregated number of text output tokens used. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. service_tier: optional string or null When group_by=service_tier, this field provides the service tier of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.embeddings.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.moderations.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageImagesResult { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket. images: integer The number of images processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.images.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. size: optional string or null When group_by=size, this field provides the image size of the grouped usage result. source: optional string or null When group_by=source, this field provides the source of the grouped usage result, possible values are image.generation, image.edit, image.variation. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioSpeechesResult { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket. characters: integer The number of characters processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_speeches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioTranscriptionsResult { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_transcriptions.result" seconds: integer The number of seconds processed. formatint64 api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageVectorStoresResult { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket. object: "organization.usage.vector_stores.result" usage_bytes: integer The vector stores usage in bytes. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageCodeInterpreterSessionsResult { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket. num_sessions: integer The number of code interpreter sessions. object: "organization.usage.code_interpreter_sessions.result" project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageFileSearchesResult { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket. num_requests: integer The count of file search calls. object: "organization.usage.file_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. vector_store_id: optional string or null When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result. OrganizationUsageWebSearchesResult { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket. num_model_requests: integer The count of model requests. num_requests: integer The count of web search calls. object: "organization.usage.web_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" context_level: optional string or null When group_by=context_level, this field provides the search context size of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationCostsResult { object, amount, api_key_id, 6 more } The aggregated costs details of the specific time bucket. object: "organization.costs.result" amount: optional { currency, value } The monetary value in its associated currency. currency: optional string Lowercase ISO-4217 currency e.g. “usd” value: optional number The numeric value of the cost. api_key_id: optional string or null When group_by=api_key_id, this field provides the API Key ID of the grouped costs result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" line_item: optional string or null When group_by=line_item, this field provides the line item of the grouped costs result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped costs result. quantity: optional number or null When group_by=line_item, this field provides the quantity of the grouped costs result. quantity_unit: optional CostQuantityUnit or null The unit of the quantity value. If no single supported unit applies to the result, this field is null. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped costs result. start_time: integer has_more: boolean next_page: string or null object: "page"
UsageVectorStoresResponse object { data, has_more, next_page, object }
UsageVectorStoresResponse object { data, has_more, next_page, object }
data: array of { end_time, object, results, start_time } end_time: integer object: "bucket" results: array of OrganizationUsageCompletionsResult or OrganizationUsageEmbeddingsResult or OrganizationUsageModerationsResult or 8 more One of the following: OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens. num_model_requests: integer The count of requests made to the model. object: "organization.usage.completions.result" output_tokens: integer The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" batch: optional boolean or null When group_by=batch, this field tells whether the grouped usage result is batch or not. input_audio_tokens: optional integer The aggregated number of uncached audio input tokens used. input_cache_write_12h_tokens: optional integer The aggregated number of input tokens written to the cache with a 12-hour retention period. input_cache_write_30m_tokens: optional integer or null The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses. input_cache_write_tokens: optional integer The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods. input_cached_audio_tokens: optional integer The aggregated number of cached audio input tokens used. input_cached_image_tokens: optional integer The aggregated number of cached image input tokens used. input_cached_text_tokens: optional integer The aggregated number of cached text input tokens used. input_cached_tokens: optional integer The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. input_image_tokens: optional integer The aggregated number of uncached image input tokens used. input_text_tokens: optional integer The aggregated number of uncached text input tokens used, excluding cache-write tokens. input_uncached_tokens: optional integer The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. output_audio_tokens: optional integer The aggregated number of audio output tokens used. output_image_tokens: optional integer The aggregated number of image output tokens used. output_text_tokens: optional integer The aggregated number of text output tokens used. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. service_tier: optional string or null When group_by=service_tier, this field provides the service tier of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.embeddings.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.moderations.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageImagesResult { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket. images: integer The number of images processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.images.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. size: optional string or null When group_by=size, this field provides the image size of the grouped usage result. source: optional string or null When group_by=source, this field provides the source of the grouped usage result, possible values are image.generation, image.edit, image.variation. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioSpeechesResult { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket. characters: integer The number of characters processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_speeches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioTranscriptionsResult { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_transcriptions.result" seconds: integer The number of seconds processed. formatint64 api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageVectorStoresResult { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket. object: "organization.usage.vector_stores.result" usage_bytes: integer The vector stores usage in bytes. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageCodeInterpreterSessionsResult { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket. num_sessions: integer The number of code interpreter sessions. object: "organization.usage.code_interpreter_sessions.result" project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageFileSearchesResult { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket. num_requests: integer The count of file search calls. object: "organization.usage.file_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. vector_store_id: optional string or null When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result. OrganizationUsageWebSearchesResult { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket. num_model_requests: integer The count of model requests. num_requests: integer The count of web search calls. object: "organization.usage.web_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" context_level: optional string or null When group_by=context_level, this field provides the search context size of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationCostsResult { object, amount, api_key_id, 6 more } The aggregated costs details of the specific time bucket. object: "organization.costs.result" amount: optional { currency, value } The monetary value in its associated currency. currency: optional string Lowercase ISO-4217 currency e.g. “usd” value: optional number The numeric value of the cost. api_key_id: optional string or null When group_by=api_key_id, this field provides the API Key ID of the grouped costs result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" line_item: optional string or null When group_by=line_item, this field provides the line item of the grouped costs result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped costs result. quantity: optional number or null When group_by=line_item, this field provides the quantity of the grouped costs result. quantity_unit: optional CostQuantityUnit or null The unit of the quantity value. If no single supported unit applies to the result, this field is null. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped costs result. start_time: integer has_more: boolean next_page: string or null object: "page"
UsageWebSearchCallsResponse object { data, has_more, next_page, object }
UsageWebSearchCallsResponse object { data, has_more, next_page, object }
data: array of { end_time, object, results, start_time } end_time: integer object: "bucket" results: array of OrganizationUsageCompletionsResult or OrganizationUsageEmbeddingsResult or OrganizationUsageModerationsResult or 8 more One of the following: OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens. num_model_requests: integer The count of requests made to the model. object: "organization.usage.completions.result" output_tokens: integer The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" batch: optional boolean or null When group_by=batch, this field tells whether the grouped usage result is batch or not. input_audio_tokens: optional integer The aggregated number of uncached audio input tokens used. input_cache_write_12h_tokens: optional integer The aggregated number of input tokens written to the cache with a 12-hour retention period. input_cache_write_30m_tokens: optional integer or null The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses. input_cache_write_tokens: optional integer The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods. input_cached_audio_tokens: optional integer The aggregated number of cached audio input tokens used. input_cached_image_tokens: optional integer The aggregated number of cached image input tokens used. input_cached_text_tokens: optional integer The aggregated number of cached text input tokens used. input_cached_tokens: optional integer The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens. input_image_tokens: optional integer The aggregated number of uncached image input tokens used. input_text_tokens: optional integer The aggregated number of uncached text input tokens used, excluding cache-write tokens. input_uncached_tokens: optional integer The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. output_audio_tokens: optional integer The aggregated number of audio output tokens used. output_image_tokens: optional integer The aggregated number of image output tokens used. output_text_tokens: optional integer The aggregated number of text output tokens used. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. service_tier: optional string or null When group_by=service_tier, this field provides the service tier of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.embeddings.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket. input_tokens: integer The aggregated number of input tokens used. num_model_requests: integer The count of requests made to the model. object: "organization.usage.moderations.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageImagesResult { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket. images: integer The number of images processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.images.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. size: optional string or null When group_by=size, this field provides the image size of the grouped usage result. source: optional string or null When group_by=source, this field provides the source of the grouped usage result, possible values are image.generation, image.edit, image.variation. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioSpeechesResult { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket. characters: integer The number of characters processed. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_speeches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageAudioTranscriptionsResult { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket. num_model_requests: integer The count of requests made to the model. object: "organization.usage.audio_transcriptions.result" seconds: integer The number of seconds processed. formatint64 api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationUsageVectorStoresResult { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket. object: "organization.usage.vector_stores.result" usage_bytes: integer The vector stores usage in bytes. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageCodeInterpreterSessionsResult { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket. num_sessions: integer The number of code interpreter sessions. object: "organization.usage.code_interpreter_sessions.result" project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. OrganizationUsageFileSearchesResult { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket. num_requests: integer The count of file search calls. object: "organization.usage.file_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. vector_store_id: optional string or null When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result. OrganizationUsageWebSearchesResult { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket. num_model_requests: integer The count of model requests. num_requests: integer The count of web search calls. object: "organization.usage.web_searches.result" api_key_id: optional string or null When group_by=api_key_id, this field provides the API key ID of the grouped usage result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" context_level: optional string or null When group_by=context_level, this field provides the search context size of the grouped usage result. model: optional string or null When group_by=model, this field provides the model name of the grouped usage result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped usage result. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped usage result. OrganizationCostsResult { object, amount, api_key_id, 6 more } The aggregated costs details of the specific time bucket. object: "organization.costs.result" amount: optional { currency, value } The monetary value in its associated currency. currency: optional string Lowercase ISO-4217 currency e.g. “usd” value: optional number The numeric value of the cost. api_key_id: optional string or null When group_by=api_key_id, this field provides the API Key ID of the grouped costs result. api_source: optional "agents_api" or "unlabeled" or null When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null. One of the following: "agents_api" "unlabeled" line_item: optional string or null When group_by=line_item, this field provides the line item of the grouped costs result. project_id: optional string or null When group_by=project_id, this field provides the project ID of the grouped costs result. quantity: optional number or null When group_by=line_item, this field provides the quantity of the grouped costs result. quantity_unit: optional CostQuantityUnit or null The unit of the quantity value. If no single supported unit applies to the result, this field is null. user_id: optional string or null When group_by=user_id, this field provides the user ID of the grouped costs result. start_time: integer has_more: boolean next_page: string or null object: "page"
OrganizationUsers
Delete user
DELETE
/organization/users/{user_id}List users
GET
/organization/usersRetrieve user
GET
/organization/users/{user_id}Modify user
POST
/organization/users/{user_id}Models
OrganizationUser object { id, added_at, object, 13 more } Represents an individual user within an organization.
OrganizationUser object { id, added_at, object, 13 more }
Represents an individual user within an organization.
id: string The identifier, which can be referenced in API endpoints added_at: integer The Unix timestamp (in seconds) of when the user was added. formatunixtime object: "organization.user" The object type, which is always organization.user api_key_last_used_at: optional integer or null The Unix timestamp (in seconds) of the user’s last API key usage. formatunixtime created: optional integer The Unix timestamp (in seconds) of when the user was created. formatunixtime developer_persona: optional string or null The developer persona metadata for the user. email: optional string or null 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 or null 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 or null The name of the user projects: optional object or null Projects associated with the user, if included. data: array of { id, name, role } id: optional string or null name: optional string or null role: optional string or null object: "list" role: optional string or null owner or reader technical_level: optional string or null The technical level metadata for the user. user: optional { id, object, banned, 5 more } Nested user details. id: string object: "user" banned: optional boolean or null banned_at: optional integer or null formatunixtime email: optional string or null enabled: optional boolean or null name: optional string or null picture: optional string or null
OrganizationUsersRoles
Assign organization role to user
POST
/organization/users/{user_id}/rolesUnassign organization role from user
DELETE
/organization/users/{user_id}/roles/{role_id}List user organization role assignments
GET
/organization/users/{user_id}/rolesRetrieve user organization role
GET
/organization/users/{user_id}/roles/{role_id}Models
RoleCreateResponse object { object, role, user } Role assignment linking a user to a role.
RoleCreateResponse object { object, role, user }
Role assignment linking a user to a role.
object: "user.role" Always user.role. role: Role { id, description, name, 4 more } Details about a role that can be assigned through the public Roles API. user: OrganizationUser { id, added_at, object, 13 more } Represents an individual user within an organization.
RoleListResponse object { id, assignment_sources, created_at, 9 more } Detailed information about a role assignment entry returned when listing assignments.
RoleListResponse object { id, assignment_sources, created_at, 9 more }
Detailed information about a role assignment entry returned when listing assignments.
id: string Identifier for the role. assignment_sources: array of object or null Principals from which the role assignment is inherited, when available. principal_id: string principal_type: string created_at: integer or null When the role was created. formatunixtime created_by: string or null Identifier of the actor who created the role. created_by_user_obj: map[unknown] or null User details for the actor that created the role, when available. description: string or null Description of the role. metadata: map[unknown] or null Arbitrary metadata stored on the role. name: string Name of the role. permissions: array of string Permissions associated with the role. predefined_role: boolean Whether the role is predefined by OpenAI. resource_type: string Resource type the role applies to. updated_at: integer or null When the role was last updated. formatunixtime
RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more } Detailed information about a role assignment entry returned when listing assignments.
RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more }
Detailed information about a role assignment entry returned when listing assignments.
id: string Identifier for the role. assignment_sources: array of object or null Principals from which the role assignment is inherited, when available. principal_id: string principal_type: string created_at: integer or null When the role was created. formatunixtime created_by: string or null Identifier of the actor who created the role. created_by_user_obj: map[unknown] or null User details for the actor that created the role, when available. description: string or null Description of the role. metadata: map[unknown] or null Arbitrary metadata stored on the role. name: string Name of the role. permissions: array of string Permissions associated with the role. predefined_role: boolean Whether the role is predefined by OpenAI. resource_type: string Resource type the role applies to. updated_at: integer or null When the role was last updated. formatunixtime
OrganizationWorkload Identity Providers
Create Platform workload identity provider
POST
/organization/workload_identity_providersDelete Platform workload identity provider
DELETE
/organization/workload_identity_providers/{workload_identity_provider_id}List Platform workload identity providers
GET
/organization/workload_identity_providersRetrieve Platform workload identity provider
GET
/organization/workload_identity_providers/{workload_identity_provider_id}Update Platform workload identity provider
POST
/organization/workload_identity_providers/{workload_identity_provider_id}Models
WorkloadIdentityProvider object { id, attribute_transformations, audience, 9 more }
WorkloadIdentityProvider object { id, attribute_transformations, audience, 9 more }
id: string attribute_transformations: array of { attribute, expression } attribute: string expression: string audience: string created_at: integer description: string or null enabled: boolean issuer: string name: string object: "organization.workload_identity_provider" (default: "organization.workload_identity_provider") type: "oidc" (default: "oidc") updated_at: integer verification: DiscoveryVerification or UploadedJwksVerification One of the following: DiscoveryVerification { discovery_url, type } discovery_url: string or null type: "discovery" (default: "discovery") UploadedJwksVerification { jwks, type } jwks: map[unknown] type: "uploaded_jwks" (default: "uploaded_jwks")
OrganizationWorkload Identity ProvidersFederation Rules
Create Platform workload identity federation rule
POST
/organization/workload_identity_providers/{workload_identity_provider_id}/federation_rulesDelete Platform workload identity federation rule
DELETE
/organization/workload_identity_providers/{workload_identity_provider_id}/federation_rules/{workload_identity_federation_rule_id}List Platform workload identity federation rules
GET
/organization/workload_identity_providers/{workload_identity_provider_id}/federation_rulesRetrieve Platform workload identity federation rule
GET
/organization/workload_identity_providers/{workload_identity_provider_id}/federation_rules/{workload_identity_federation_rule_id}Update Platform workload identity federation rule
POST
/organization/workload_identity_providers/{workload_identity_provider_id}/federation_rules/{workload_identity_federation_rule_id}Models
FederationRule object { id, attribute_matchers, created_at, 9 more }
FederationRule object { id, attribute_matchers, created_at, 9 more }
id: string attribute_matchers: map[string or boolean or number or number] One of the following: string boolean number or number One of the following: number number created_at: integer description: string or null enabled: boolean name: string or null object: "organization.workload_identity_federation_rule" (default: "organization.workload_identity_federation_rule") permissions: DefaultPermissions or RestrictedPermissions One of the following: DefaultPermissions { type } type: "service_account_default" (default: "service_account_default") RestrictedPermissions { scopes, type } scopes: array of string type: "restricted" (default: "restricted") project_id: string service_account_id: string updated_at: integer workload_identity_provider_id: string