Organization

Audit Logs

List audit logs

admin.organization.audit_logs.list(AuditLogListParams**kwargs) -> SyncConversationCursorPage[AuditLogListResponse]

get /organization/audit_logs

List user actions and configuration changes within this organization.

Parameters

• actor_emails: Optional[Sequence[str]]

  Return only events performed by users with these emails.

• actor_ids: Optional[Sequence[str]]

  Return only events performed by these actors. Can be a user ID, a service account ID, or an api key tracking ID.

• after: Optional[str]

  A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

• before: Optional[str]

  A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

• effective_at: Optional[EffectiveAt]

  Return only events whose effective_at (Unix seconds) is in this range.

  • gt: Optional[int]

    Return only events whose effective_at (Unix seconds) is greater than this value.

  • gte: Optional[int]

    Return only events whose effective_at (Unix seconds) is greater than or equal to this value.

  • lt: Optional[int]

    Return only events whose effective_at (Unix seconds) is less than this value.

  • lte: Optional[int]

    Return only events whose effective_at (Unix seconds) is less than or equal to this value.

• event_types: Optional[List[Literal["api_key.created", "api_key.updated", "api_key.deleted", 56 more]]]

  Return only events with a type in one of these values. For example, project.created. For all options, see the documentation for the audit log object.

  • "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"

  • "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"

• limit: Optional[int]

  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

• project_ids: Optional[Sequence[str]]

  Return only events for these projects.

• resource_ids: Optional[Sequence[str]]

  Return only events performed on these targets. For example, a project ID updated. For ChatGPT connector role events, use the workspace connector resource ID shown in details.id, such as <workspace_id>__<connector_id>.

• tenant_only: Optional[bool]

  Return only tenant-scoped events associated with this organization. Required for tenant-scoped events such as role.bound_to_resource and role.unbound_from_resource. When true, all supplied event types must be tenant-scoped.

Returns

• class AuditLogListResponse: …

  A log of a user action or configuration change within this organization.

  • id: str

    The ID of this log.

  • effective_at: int

    The Unix timestamp (in seconds) of the event.

  • type: Literal["api_key.created", "api_key.updated", "api_key.deleted", 56 more]

    The event type.

    • "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"

    • "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"

  • actor: Optional[Actor]

    The actor who performed the audit logged action.

    • api_key: Optional[ActorAPIKey]

      The API Key used to perform the audit logged action.

      • id: Optional[str]

        The tracking id of the API key.

      • service_account: Optional[ActorAPIKeyServiceAccount]

        The service account that performed the audit logged action.

        • id: Optional[str]

          The service account id.

      • type: Optional[Literal["user", "service_account"]]

        The type of API key. Can be either user or service_account.

        • "user"

        • "service_account"

      • user: Optional[ActorAPIKeyUser]

        The user who performed the audit logged action.

        • id: Optional[str]

          The user id.

        • email: Optional[str]

          The user email.

    • session: Optional[ActorSession]

      The session in which the audit logged action was performed.

      • ip_address: Optional[str]

        The IP address from which the action was performed.

      • user: Optional[ActorSessionUser]

        The user who performed the audit logged action.

        • id: Optional[str]

          The user id.

        • email: Optional[str]

          The user email.

    • type: Optional[Literal["session", "api_key"]]

      The type of actor. Is either session or api_key.

      • "session"

      • "api_key"

  • api_key_created: Optional[APIKeyCreated]

    The details for events with this type.

    • id: Optional[str]

      The tracking ID of the API key.

    • data: Optional[APIKeyCreatedData]

      The payload used to create the API key.

      • scopes: Optional[List[str]]

        A list of scopes allowed for the API key, e.g. ["api.model.request"]

  • api_key_deleted: Optional[APIKeyDeleted]

    The details for events with this type.

    • id: Optional[str]

      The tracking ID of the API key.

  • api_key_updated: Optional[APIKeyUpdated]

    The details for events with this type.

    • id: Optional[str]

      The tracking ID of the API key.

    • changes_requested: Optional[APIKeyUpdatedChangesRequested]

      The payload used to update the API key.

      • scopes: Optional[List[str]]

        A list of scopes allowed for the API key, e.g. ["api.model.request"]

  • certificate_created: Optional[CertificateCreated]

    The details for events with this type.

    • id: Optional[str]

      The certificate ID.

    • name: Optional[str]

      The name of the certificate.

  • certificate_deleted: Optional[CertificateDeleted]

    The details for events with this type.

    • id: Optional[str]

      The certificate ID.

    • certificate: Optional[str]

      The certificate content in PEM format.

    • name: Optional[str]

      The name of the certificate.

  • certificate_updated: Optional[CertificateUpdated]

    The details for events with this type.

    • id: Optional[str]

      The certificate ID.

    • name: Optional[str]

      The name of the certificate.

  • certificates_activated: Optional[CertificatesActivated]

    The details for events with this type.

    • certificates: Optional[List[CertificatesActivatedCertificate]]

      • id: Optional[str]

        The certificate ID.

      • name: Optional[str]

        The name of the certificate.

  • certificates_deactivated: Optional[CertificatesDeactivated]

    The details for events with this type.

    • certificates: Optional[List[CertificatesDeactivatedCertificate]]

      • id: Optional[str]

        The certificate ID.

      • name: Optional[str]

        The name of the certificate.

  • checkpoint_permission_created: Optional[CheckpointPermissionCreated]

    The project and fine-tuned model checkpoint that the checkpoint permission was created for.

    • id: Optional[str]

      The ID of the checkpoint permission.

    • data: Optional[CheckpointPermissionCreatedData]

      The payload used to create the checkpoint permission.

      • fine_tuned_model_checkpoint: Optional[str]

        The ID of the fine-tuned model checkpoint.

      • project_id: Optional[str]

        The ID of the project that the checkpoint permission was created for.

  • checkpoint_permission_deleted: Optional[CheckpointPermissionDeleted]

    The details for events with this type.

    • id: Optional[str]

      The ID of the checkpoint permission.

  • external_key_registered: Optional[ExternalKeyRegistered]

    The details for events with this type.

    • id: Optional[str]

      The ID of the external key configuration.

    • data: Optional[object]

      The configuration for the external key.

  • external_key_removed: Optional[ExternalKeyRemoved]

    The details for events with this type.

    • id: Optional[str]

      The ID of the external key configuration.

  • group_created: Optional[GroupCreated]

    The details for events with this type.

    • id: Optional[str]

      The ID of the group.

    • data: Optional[GroupCreatedData]

      Information about the created group.

      • group_name: Optional[str]

        The group name.

  • group_deleted: Optional[GroupDeleted]

    The details for events with this type.

    • id: Optional[str]

      The ID of the group.

  • group_updated: Optional[GroupUpdated]

    The details for events with this type.

    • id: Optional[str]

      The ID of the group.

    • changes_requested: Optional[GroupUpdatedChangesRequested]

      The payload used to update the group.

      • group_name: Optional[str]

        The updated group name.

  • invite_accepted: Optional[InviteAccepted]

    The details for events with this type.

    • id: Optional[str]

      The ID of the invite.

  • invite_deleted: Optional[InviteDeleted]

    The details for events with this type.

    • id: Optional[str]

      The ID of the invite.

  • invite_sent: Optional[InviteSent]

    The details for events with this type.

    • id: Optional[str]

      The ID of the invite.

    • data: Optional[InviteSentData]

      The payload used to create the invite.

      • email: Optional[str]

        The email invited to the organization.

      • role: Optional[str]

        The role the email was invited to be. Is either owner or member.

  • ip_allowlist_config_activated: Optional[IPAllowlistConfigActivated]

    The details for events with this type.

    • configs: Optional[List[IPAllowlistConfigActivatedConfig]]

      The configurations that were activated.

      • id: Optional[str]

        The ID of the IP allowlist configuration.

      • name: Optional[str]

        The name of the IP allowlist configuration.

  • ip_allowlist_config_deactivated: Optional[IPAllowlistConfigDeactivated]

    The details for events with this type.

    • configs: Optional[List[IPAllowlistConfigDeactivatedConfig]]

      The configurations that were deactivated.

      • id: Optional[str]

        The ID of the IP allowlist configuration.

      • name: Optional[str]

        The name of the IP allowlist configuration.

  • ip_allowlist_created: Optional[IPAllowlistCreated]

    The details for events with this type.

    • id: Optional[str]

      The ID of the IP allowlist configuration.

    • allowed_ips: Optional[List[str]]

      The IP addresses or CIDR ranges included in the configuration.

    • name: Optional[str]

      The name of the IP allowlist configuration.

  • ip_allowlist_deleted: Optional[IPAllowlistDeleted]

    The details for events with this type.

    • id: Optional[str]

      The ID of the IP allowlist configuration.

    • allowed_ips: Optional[List[str]]

      The IP addresses or CIDR ranges that were in the configuration.

    • name: Optional[str]

      The name of the IP allowlist configuration.

  • ip_allowlist_updated: Optional[IPAllowlistUpdated]

    The details for events with this type.

    • id: Optional[str]

      The ID of the IP allowlist configuration.

    • allowed_ips: Optional[List[str]]

      The updated set of IP addresses or CIDR ranges in the configuration.

  • login_failed: Optional[LoginFailed]

    The details for events with this type.

    • error_code: Optional[str]

      The error code of the failure.

    • error_message: Optional[str]

      The error message of the failure.

  • login_succeeded: Optional[object]

    This event has no additional fields beyond the standard audit log attributes.

  • logout_failed: Optional[LogoutFailed]

    The details for events with this type.

    • error_code: Optional[str]

      The error code of the failure.

    • error_message: Optional[str]

      The error message of the failure.

  • logout_succeeded: Optional[object]

    This event has no additional fields beyond the standard audit log attributes.

  • organization_updated: Optional[OrganizationUpdated]

    The details for events with this type.

    • id: Optional[str]

      The organization ID.

    • changes_requested: Optional[OrganizationUpdatedChangesRequested]

      The payload used to update the organization settings.

      • api_call_logging: Optional[str]

        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[str]

        The list of project ids if api_call_logging is set to enabled_for_selected_projects

      • description: Optional[str]

        The organization description.

      • name: Optional[str]

        The organization name.

      • threads_ui_visibility: Optional[str]

        Visibility of the threads page which shows messages created with the Assistants API and Playground. One of ANY_ROLE, OWNERS, or NONE.

      • title: Optional[str]

        The organization title.

      • usage_dashboard_visibility: Optional[str]

        Visibility of the usage dashboard which shows activity and costs for your organization. One of ANY_ROLE or OWNERS.

  • project: Optional[Project]

    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[str]

      The project ID.

    • name: Optional[str]

      The project title.

  • project_archived: Optional[ProjectArchived]

    The details for events with this type.

    • id: Optional[str]

      The project ID.

  • project_created: Optional[ProjectCreated]

    The details for events with this type.

    • id: Optional[str]

      The project ID.

    • data: Optional[ProjectCreatedData]

      The payload used to create the project.

      • name: Optional[str]

        The project name.

      • title: Optional[str]

        The title of the project as seen on the dashboard.

  • project_deleted: Optional[ProjectDeleted]

    The details for events with this type.

    • id: Optional[str]

      The project ID.

  • project_updated: Optional[ProjectUpdated]

    The details for events with this type.

    • id: Optional[str]

      The project ID.

    • changes_requested: Optional[ProjectUpdatedChangesRequested]

      The payload used to update the project.

      • title: Optional[str]

        The title of the project as seen on the dashboard.

  • rate_limit_deleted: Optional[RateLimitDeleted]

    The details for events with this type.

    • id: Optional[str]

      The rate limit ID

  • rate_limit_updated: Optional[RateLimitUpdated]

    The details for events with this type.

    • id: Optional[str]

      The rate limit ID

    • changes_requested: Optional[RateLimitUpdatedChangesRequested]

      The payload used to update the rate limits.

      • batch_1_day_max_input_tokens: Optional[int]

        The maximum batch input tokens per day. Only relevant for certain models.

      • max_audio_megabytes_per_1_minute: Optional[int]

        The maximum audio megabytes per minute. Only relevant for certain models.

      • max_images_per_1_minute: Optional[int]

        The maximum images per minute. Only relevant for certain models.

      • max_requests_per_1_day: Optional[int]

        The maximum requests per day. Only relevant for certain models.

      • max_requests_per_1_minute: Optional[int]

        The maximum requests per minute.

      • max_tokens_per_1_minute: Optional[int]

        The maximum tokens per minute.

  • role_assignment_created: Optional[RoleAssignmentCreated]

    The details for events with this type.

    • id: Optional[str]

      The identifier of the role assignment.

    • principal_id: Optional[str]

      The principal (user or group) that received the role.

    • principal_type: Optional[str]

      The type of principal (user or group) that received the role.

    • resource_id: Optional[str]

      The resource the role assignment is scoped to.

    • resource_type: Optional[str]

      The type of resource the role assignment is scoped to.

  • role_assignment_deleted: Optional[RoleAssignmentDeleted]

    The details for events with this type.

    • id: Optional[str]

      The identifier of the role assignment.

    • principal_id: Optional[str]

      The principal (user or group) that had the role removed.

    • principal_type: Optional[str]

      The type of principal (user or group) that had the role removed.

    • resource_id: Optional[str]

      The resource the role assignment was scoped to.

    • resource_type: Optional[str]

      The type of resource the role assignment was scoped to.

  • role_bound_to_resource: Optional[RoleBoundToResource]

    The details for events with this type.

    • id: Optional[str]

      The ID of the resource the role was bound to. ChatGPT workspace connector resources use <workspace_id>__<connector_id>.

    • connector_id: Optional[str]

      The connector ID for a ChatGPT workspace connector resource.

    • connector_name: Optional[str]

      The connector display name for a ChatGPT workspace connector resource, or the connector ID when the display name could not be resolved.

    • enabled: Optional[bool]

      Whether the connector is enabled for the role.

    • permissions: Optional[List[str]]

      The permissions granted to the role for the resource.

    • resource_id: Optional[str]

      The ID of the resource the role was bound to.

    • resource_type: Optional[str]

      The type of resource the role was bound to.

    • role_id: Optional[str]

      The ID of the role that was bound to the resource.

    • source: Optional[Literal["role_toggle", "role_connector_update", "role_delete", 2 more]]

      The connector role mutation path that produced the event.

      • "role_toggle"

      • "role_connector_update"

      • "role_delete"

      • "workspace_permissions"

      • "connector_publish"

    • workspace_id: Optional[str]

      The workspace ID for a ChatGPT workspace connector resource.

  • role_created: Optional[RoleCreated]

    The details for events with this type.

    • id: Optional[str]

      The role ID.

    • permissions: Optional[List[str]]

      The permissions granted by the role.

    • resource_id: Optional[str]

      The resource the role is scoped to.

    • resource_type: Optional[str]

      The type of resource the role belongs to.

    • role_name: Optional[str]

      The name of the role.

  • role_deleted: Optional[RoleDeleted]

    The details for events with this type.

    • id: Optional[str]

      The role ID.

  • role_unbound_from_resource: Optional[RoleUnboundFromResource]

    The details for events with this type.

    • id: Optional[str]

      The ID of the resource the role was unbound from. ChatGPT workspace connector resources use <workspace_id>__<connector_id>.

    • connector_id: Optional[str]

      The connector ID for a ChatGPT workspace connector resource.

    • connector_name: Optional[str]

      The connector display name for a ChatGPT workspace connector resource, or the connector ID when the display name could not be resolved.

    • enabled: Optional[bool]

      Whether the connector is enabled for the role.

    • permissions: Optional[List[str]]

      The permissions remaining for the role after the change.

    • resource_id: Optional[str]

      The ID of the resource the role was unbound from.

    • resource_type: Optional[str]

      The type of resource the role was unbound from.

    • role_id: Optional[str]

      The ID of the role that was unbound from the resource.

    • source: Optional[Literal["role_toggle", "role_connector_update", "role_delete", 2 more]]

      The connector role mutation path that produced the event.

      • "role_toggle"

      • "role_connector_update"

      • "role_delete"

      • "workspace_permissions"

      • "connector_publish"

    • workspace_id: Optional[str]

      The workspace ID for a ChatGPT workspace connector resource.

  • role_updated: Optional[RoleUpdated]

    The details for events with this type.

    • id: Optional[str]

      The role ID.

    • changes_requested: Optional[RoleUpdatedChangesRequested]

      The payload used to update the role.

      • description: Optional[str]

        The updated role description, when provided.

      • metadata: Optional[object]

        Additional metadata stored on the role.

      • permissions_added: Optional[List[str]]

        The permissions added to the role.

      • permissions_removed: Optional[List[str]]

        The permissions removed from the role.

      • resource_id: Optional[str]

        The resource the role is scoped to.

      • resource_type: Optional[str]

        The type of resource the role belongs to.

      • role_name: Optional[str]

        The updated role name, when provided.

  • scim_disabled: Optional[ScimDisabled]

    The details for events with this type.

    • id: Optional[str]

      The ID of the SCIM was disabled for.

  • scim_enabled: Optional[ScimEnabled]

    The details for events with this type.

    • id: Optional[str]

      The ID of the SCIM was enabled for.

  • service_account_created: Optional[ServiceAccountCreated]

    The details for events with this type.

    • id: Optional[str]

      The service account ID.

    • data: Optional[ServiceAccountCreatedData]

      The payload used to create the service account.

      • role: Optional[str]

        The role of the service account. Is either owner or member.

  • service_account_deleted: Optional[ServiceAccountDeleted]

    The details for events with this type.

    • id: Optional[str]

      The service account ID.

  • service_account_updated: Optional[ServiceAccountUpdated]

    The details for events with this type.

    • id: Optional[str]

      The service account ID.

    • changes_requested: Optional[ServiceAccountUpdatedChangesRequested]

      The payload used to updated the service account.

      • role: Optional[str]

        The role of the service account. Is either owner or member.

  • user_added: Optional[UserAdded]

    The details for events with this type.

    • id: Optional[str]

      The user ID.

    • data: Optional[UserAddedData]

      The payload used to add the user to the project.

      • role: Optional[str]

        The role of the user. Is either owner or member.

  • user_deleted: Optional[UserDeleted]

    The details for events with this type.

    • id: Optional[str]

      The user ID.

  • user_updated: Optional[UserUpdated]

    The details for events with this type.

    • id: Optional[str]

      The project ID.

    • changes_requested: Optional[UserUpdatedChangesRequested]

      The payload used to update the user.

      • role: Optional[str]

        The role of the user. Is either owner or member.

  • workload_identity_provider_mapping_created: Optional[WorkloadIdentityProviderMappingCreated]

    The details for events with this type.

    • id: Optional[str]

      The workload identity provider mapping ID.

    • data: Optional[object]

      The payload used to create the workload identity provider mapping.

    • identity_provider_id: Optional[str]

      The workload identity provider ID.

  • workload_identity_provider_mapping_deleted: Optional[WorkloadIdentityProviderMappingDeleted]

    The details for events with this type.

    • id: Optional[str]

      The workload identity provider mapping ID.

    • identity_provider_id: Optional[str]

      The workload identity provider ID.

    • project_id: Optional[str]

      The project ID.

    • service_account_id: Optional[str]

      The mapped service account ID.

  • workload_identity_provider_mapping_updated: Optional[WorkloadIdentityProviderMappingUpdated]

    The details for events with this type.

    • id: Optional[str]

      The workload identity provider mapping ID.

    • changes_requested: Optional[object]

      The payload used to update the workload identity provider mapping.

    • identity_provider_id: Optional[str]

      The workload identity provider ID.

  • workload_identity_provider_created: Optional[WorkloadIdentityProviderCreated]

    The details for events with this type.

    • id: Optional[str]

      The workload identity provider ID.

    • data: Optional[object]

      The payload used to create the workload identity provider.

  • workload_identity_provider_deleted: Optional[WorkloadIdentityProviderDeleted]

    The details for events with this type.

    • id: Optional[str]

      The workload identity provider ID.

    • name: Optional[str]

      The workload identity provider name.

  • workload_identity_provider_updated: Optional[WorkloadIdentityProviderUpdated]

    The details for events with this type.

    • id: Optional[str]

      The workload identity provider ID.

    • changes_requested: Optional[object]

      The payload used to update the workload identity provider.

Example

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
page = client.admin.organization.audit_logs.list()
page = page.data[0]
print(page.id)

Response

{
  "data": [
    {
      "id": "id",
      "effective_at": 0,
      "type": "api_key.created",
      "actor": {
        "api_key": {
          "id": "id",
          "service_account": {
            "id": "id"
          },
          "type": "user",
          "user": {
            "id": "id",
            "email": "email"
          }
        },
        "session": {
          "ip_address": "ip_address",
          "user": {
            "id": "id",
            "email": "email"
          }
        },
        "type": "session"
      },
      "api_key.created": {
        "id": "id",
        "data": {
          "scopes": [
            "string"
          ]
        }
      },
      "api_key.deleted": {
        "id": "id"
      },
      "api_key.updated": {
        "id": "id",
        "changes_requested": {
          "scopes": [
            "string"
          ]
        }
      },
      "certificate.created": {
        "id": "id",
        "name": "name"
      },
      "certificate.deleted": {
        "id": "id",
        "certificate": "certificate",
        "name": "name"
      },
      "certificate.updated": {
        "id": "id",
        "name": "name"
      },
      "certificates.activated": {
        "certificates": [
          {
            "id": "id",
            "name": "name"
          }
        ]
      },
      "certificates.deactivated": {
        "certificates": [
          {
            "id": "id",
            "name": "name"
          }
        ]
      },
      "checkpoint.permission.created": {
        "id": "id",
        "data": {
          "fine_tuned_model_checkpoint": "fine_tuned_model_checkpoint",
          "project_id": "project_id"
        }
      },
      "checkpoint.permission.deleted": {
        "id": "id"
      },
      "external_key.registered": {
        "id": "id",
        "data": {}
      },
      "external_key.removed": {
        "id": "id"
      },
      "group.created": {
        "id": "id",
        "data": {
          "group_name": "group_name"
        }
      },
      "group.deleted": {
        "id": "id"
      },
      "group.updated": {
        "id": "id",
        "changes_requested": {
          "group_name": "group_name"
        }
      },
      "invite.accepted": {
        "id": "id"
      },
      "invite.deleted": {
        "id": "id"
      },
      "invite.sent": {
        "id": "id",
        "data": {
          "email": "email",
          "role": "role"
        }
      },
      "ip_allowlist.config.activated": {
        "configs": [
          {
            "id": "id",
            "name": "name"
          }
        ]
      },
      "ip_allowlist.config.deactivated": {
        "configs": [
          {
            "id": "id",
            "name": "name"
          }
        ]
      },
      "ip_allowlist.created": {
        "id": "id",
        "allowed_ips": [
          "string"
        ],
        "name": "name"
      },
      "ip_allowlist.deleted": {
        "id": "id",
        "allowed_ips": [
          "string"
        ],
        "name": "name"
      },
      "ip_allowlist.updated": {
        "id": "id",
        "allowed_ips": [
          "string"
        ]
      },
      "login.failed": {
        "error_code": "error_code",
        "error_message": "error_message"
      },
      "login.succeeded": {},
      "logout.failed": {
        "error_code": "error_code",
        "error_message": "error_message"
      },
      "logout.succeeded": {},
      "organization.updated": {
        "id": "id",
        "changes_requested": {
          "api_call_logging": "api_call_logging",
          "api_call_logging_project_ids": "api_call_logging_project_ids",
          "description": "description",
          "name": "name",
          "threads_ui_visibility": "threads_ui_visibility",
          "title": "title",
          "usage_dashboard_visibility": "usage_dashboard_visibility"
        }
      },
      "project": {
        "id": "id",
        "name": "name"
      },
      "project.archived": {
        "id": "id"
      },
      "project.created": {
        "id": "id",
        "data": {
          "name": "name",
          "title": "title"
        }
      },
      "project.deleted": {
        "id": "id"
      },
      "project.updated": {
        "id": "id",
        "changes_requested": {
          "title": "title"
        }
      },
      "rate_limit.deleted": {
        "id": "id"
      },
      "rate_limit.updated": {
        "id": "id",
        "changes_requested": {
          "batch_1_day_max_input_tokens": 0,
          "max_audio_megabytes_per_1_minute": 0,
          "max_images_per_1_minute": 0,
          "max_requests_per_1_day": 0,
          "max_requests_per_1_minute": 0,
          "max_tokens_per_1_minute": 0
        }
      },
      "role.assignment.created": {
        "id": "id",
        "principal_id": "principal_id",
        "principal_type": "principal_type",
        "resource_id": "resource_id",
        "resource_type": "resource_type"
      },
      "role.assignment.deleted": {
        "id": "id",
        "principal_id": "principal_id",
        "principal_type": "principal_type",
        "resource_id": "resource_id",
        "resource_type": "resource_type"
      },
      "role.bound_to_resource": {
        "id": "id",
        "connector_id": "connector_id",
        "connector_name": "connector_name",
        "enabled": true,
        "permissions": [
          "string"
        ],
        "resource_id": "resource_id",
        "resource_type": "resource_type",
        "role_id": "role_id",
        "source": "role_toggle",
        "workspace_id": "workspace_id"
      },
      "role.created": {
        "id": "id",
        "permissions": [
          "string"
        ],
        "resource_id": "resource_id",
        "resource_type": "resource_type",
        "role_name": "role_name"
      },
      "role.deleted": {
        "id": "id"
      },
      "role.unbound_from_resource": {
        "id": "id",
        "connector_id": "connector_id",
        "connector_name": "connector_name",
        "enabled": true,
        "permissions": [
          "string"
        ],
        "resource_id": "resource_id",
        "resource_type": "resource_type",
        "role_id": "role_id",
        "source": "role_toggle",
        "workspace_id": "workspace_id"
      },
      "role.updated": {
        "id": "id",
        "changes_requested": {
          "description": "description",
          "metadata": {},
          "permissions_added": [
            "string"
          ],
          "permissions_removed": [
            "string"
          ],
          "resource_id": "resource_id",
          "resource_type": "resource_type",
          "role_name": "role_name"
        }
      },
      "scim.disabled": {
        "id": "id"
      },
      "scim.enabled": {
        "id": "id"
      },
      "service_account.created": {
        "id": "id",
        "data": {
          "role": "role"
        }
      },
      "service_account.deleted": {
        "id": "id"
      },
      "service_account.updated": {
        "id": "id",
        "changes_requested": {
          "role": "role"
        }
      },
      "user.added": {
        "id": "id",
        "data": {
          "role": "role"
        }
      },
      "user.deleted": {
        "id": "id"
      },
      "user.updated": {
        "id": "id",
        "changes_requested": {
          "role": "role"
        }
      },
      "workload_identity_provider_mapping.created": {
        "id": "id",
        "data": {},
        "identity_provider_id": "identity_provider_id"
      },
      "workload_identity_provider_mapping.deleted": {
        "id": "id",
        "identity_provider_id": "identity_provider_id",
        "project_id": "project_id",
        "service_account_id": "service_account_id"
      },
      "workload_identity_provider_mapping.updated": {
        "id": "id",
        "changes_requested": {},
        "identity_provider_id": "identity_provider_id"
      },
      "workload_identity_provider.created": {
        "id": "id",
        "data": {}
      },
      "workload_identity_provider.deleted": {
        "id": "id",
        "name": "name"
      },
      "workload_identity_provider.updated": {
        "id": "id",
        "changes_requested": {}
      }
    }
  ],
  "has_more": true,
  "object": "list",
  "first_id": "audit_log-defb456h8dks",
  "last_id": "audit_log-hnbkd8s93s"
}

Domain Types

Audit Log List Response

• class AuditLogListResponse: …

  A log of a user action or configuration change within this organization.

  • id: str

    The ID of this log.

  • effective_at: int

    The Unix timestamp (in seconds) of the event.

  • type: Literal["api_key.created", "api_key.updated", "api_key.deleted", 56 more]

    The event type.

    • "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"

    • "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"

  • actor: Optional[Actor]

    The actor who performed the audit logged action.

    • api_key: Optional[ActorAPIKey]

      The API Key used to perform the audit logged action.

      • id: Optional[str]

        The tracking id of the API key.

      • service_account: Optional[ActorAPIKeyServiceAccount]

        The service account that performed the audit logged action.

        • id: Optional[str]

          The service account id.

      • type: Optional[Literal["user", "service_account"]]

        The type of API key. Can be either user or service_account.

        • "user"

        • "service_account"

      • user: Optional[ActorAPIKeyUser]

        The user who performed the audit logged action.

        • id: Optional[str]

          The user id.

        • email: Optional[str]

          The user email.

    • session: Optional[ActorSession]

      The session in which the audit logged action was performed.

      • ip_address: Optional[str]

        The IP address from which the action was performed.

      • user: Optional[ActorSessionUser]

        The user who performed the audit logged action.

        • id: Optional[str]

          The user id.

        • email: Optional[str]

          The user email.

    • type: Optional[Literal["session", "api_key"]]

      The type of actor. Is either session or api_key.

      • "session"

      • "api_key"

  • api_key_created: Optional[APIKeyCreated]

    The details for events with this type.

    • id: Optional[str]

      The tracking ID of the API key.

    • data: Optional[APIKeyCreatedData]

      The payload used to create the API key.

      • scopes: Optional[List[str]]

        A list of scopes allowed for the API key, e.g. ["api.model.request"]

  • api_key_deleted: Optional[APIKeyDeleted]

    The details for events with this type.

    • id: Optional[str]

      The tracking ID of the API key.

  • api_key_updated: Optional[APIKeyUpdated]

    The details for events with this type.

    • id: Optional[str]

      The tracking ID of the API key.

    • changes_requested: Optional[APIKeyUpdatedChangesRequested]

      The payload used to update the API key.

      • scopes: Optional[List[str]]

        A list of scopes allowed for the API key, e.g. ["api.model.request"]

  • certificate_created: Optional[CertificateCreated]

    The details for events with this type.

    • id: Optional[str]

      The certificate ID.

    • name: Optional[str]

      The name of the certificate.

  • certificate_deleted: Optional[CertificateDeleted]

    The details for events with this type.

    • id: Optional[str]

      The certificate ID.

    • certificate: Optional[str]

      The certificate content in PEM format.

    • name: Optional[str]

      The name of the certificate.

  • certificate_updated: Optional[CertificateUpdated]

    The details for events with this type.

    • id: Optional[str]

      The certificate ID.

    • name: Optional[str]

      The name of the certificate.

  • certificates_activated: Optional[CertificatesActivated]

    The details for events with this type.

    • certificates: Optional[List[CertificatesActivatedCertificate]]

      • id: Optional[str]

        The certificate ID.

      • name: Optional[str]

        The name of the certificate.

  • certificates_deactivated: Optional[CertificatesDeactivated]

    The details for events with this type.

    • certificates: Optional[List[CertificatesDeactivatedCertificate]]

      • id: Optional[str]

        The certificate ID.

      • name: Optional[str]

        The name of the certificate.

  • checkpoint_permission_created: Optional[CheckpointPermissionCreated]

    The project and fine-tuned model checkpoint that the checkpoint permission was created for.

    • id: Optional[str]

      The ID of the checkpoint permission.

    • data: Optional[CheckpointPermissionCreatedData]

      The payload used to create the checkpoint permission.

      • fine_tuned_model_checkpoint: Optional[str]

        The ID of the fine-tuned model checkpoint.

      • project_id: Optional[str]

        The ID of the project that the checkpoint permission was created for.

  • checkpoint_permission_deleted: Optional[CheckpointPermissionDeleted]

    The details for events with this type.

    • id: Optional[str]

      The ID of the checkpoint permission.

  • external_key_registered: Optional[ExternalKeyRegistered]

    The details for events with this type.

    • id: Optional[str]

      The ID of the external key configuration.

    • data: Optional[object]

      The configuration for the external key.

  • external_key_removed: Optional[ExternalKeyRemoved]

    The details for events with this type.

    • id: Optional[str]

      The ID of the external key configuration.

  • group_created: Optional[GroupCreated]

    The details for events with this type.

    • id: Optional[str]

      The ID of the group.

    • data: Optional[GroupCreatedData]

      Information about the created group.

      • group_name: Optional[str]

        The group name.

  • group_deleted: Optional[GroupDeleted]

    The details for events with this type.

    • id: Optional[str]

      The ID of the group.

  • group_updated: Optional[GroupUpdated]

    The details for events with this type.

    • id: Optional[str]

      The ID of the group.

    • changes_requested: Optional[GroupUpdatedChangesRequested]

      The payload used to update the group.

      • group_name: Optional[str]

        The updated group name.

  • invite_accepted: Optional[InviteAccepted]

    The details for events with this type.

    • id: Optional[str]

      The ID of the invite.

  • invite_deleted: Optional[InviteDeleted]

    The details for events with this type.

    • id: Optional[str]

      The ID of the invite.

  • invite_sent: Optional[InviteSent]

    The details for events with this type.

    • id: Optional[str]

      The ID of the invite.

    • data: Optional[InviteSentData]

      The payload used to create the invite.

      • email: Optional[str]

        The email invited to the organization.

      • role: Optional[str]

        The role the email was invited to be. Is either owner or member.

  • ip_allowlist_config_activated: Optional[IPAllowlistConfigActivated]

    The details for events with this type.

    • configs: Optional[List[IPAllowlistConfigActivatedConfig]]

      The configurations that were activated.

      • id: Optional[str]

        The ID of the IP allowlist configuration.

      • name: Optional[str]

        The name of the IP allowlist configuration.

  • ip_allowlist_config_deactivated: Optional[IPAllowlistConfigDeactivated]

    The details for events with this type.

    • configs: Optional[List[IPAllowlistConfigDeactivatedConfig]]

      The configurations that were deactivated.

      • id: Optional[str]

        The ID of the IP allowlist configuration.

      • name: Optional[str]

        The name of the IP allowlist configuration.

  • ip_allowlist_created: Optional[IPAllowlistCreated]

    The details for events with this type.

    • id: Optional[str]

      The ID of the IP allowlist configuration.

    • allowed_ips: Optional[List[str]]

      The IP addresses or CIDR ranges included in the configuration.

    • name: Optional[str]

      The name of the IP allowlist configuration.

  • ip_allowlist_deleted: Optional[IPAllowlistDeleted]

    The details for events with this type.

    • id: Optional[str]

      The ID of the IP allowlist configuration.

    • allowed_ips: Optional[List[str]]

      The IP addresses or CIDR ranges that were in the configuration.

    • name: Optional[str]

      The name of the IP allowlist configuration.

  • ip_allowlist_updated: Optional[IPAllowlistUpdated]

    The details for events with this type.

    • id: Optional[str]

      The ID of the IP allowlist configuration.

    • allowed_ips: Optional[List[str]]

      The updated set of IP addresses or CIDR ranges in the configuration.

  • login_failed: Optional[LoginFailed]

    The details for events with this type.

    • error_code: Optional[str]

      The error code of the failure.

    • error_message: Optional[str]

      The error message of the failure.

  • login_succeeded: Optional[object]

    This event has no additional fields beyond the standard audit log attributes.

  • logout_failed: Optional[LogoutFailed]

    The details for events with this type.

    • error_code: Optional[str]

      The error code of the failure.

    • error_message: Optional[str]

      The error message of the failure.

  • logout_succeeded: Optional[object]

    This event has no additional fields beyond the standard audit log attributes.

  • organization_updated: Optional[OrganizationUpdated]

    The details for events with this type.

    • id: Optional[str]

      The organization ID.

    • changes_requested: Optional[OrganizationUpdatedChangesRequested]

      The payload used to update the organization settings.

      • api_call_logging: Optional[str]

        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[str]

        The list of project ids if api_call_logging is set to enabled_for_selected_projects

      • description: Optional[str]

        The organization description.

      • name: Optional[str]

        The organization name.

      • threads_ui_visibility: Optional[str]

        Visibility of the threads page which shows messages created with the Assistants API and Playground. One of ANY_ROLE, OWNERS, or NONE.

      • title: Optional[str]

        The organization title.

      • usage_dashboard_visibility: Optional[str]

        Visibility of the usage dashboard which shows activity and costs for your organization. One of ANY_ROLE or OWNERS.

  • project: Optional[Project]

    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[str]

      The project ID.

    • name: Optional[str]

      The project title.

  • project_archived: Optional[ProjectArchived]

    The details for events with this type.

    • id: Optional[str]

      The project ID.

  • project_created: Optional[ProjectCreated]

    The details for events with this type.

    • id: Optional[str]

      The project ID.

    • data: Optional[ProjectCreatedData]

      The payload used to create the project.

      • name: Optional[str]

        The project name.

      • title: Optional[str]

        The title of the project as seen on the dashboard.

  • project_deleted: Optional[ProjectDeleted]

    The details for events with this type.

    • id: Optional[str]

      The project ID.

  • project_updated: Optional[ProjectUpdated]

    The details for events with this type.

    • id: Optional[str]

      The project ID.

    • changes_requested: Optional[ProjectUpdatedChangesRequested]

      The payload used to update the project.

      • title: Optional[str]

        The title of the project as seen on the dashboard.

  • rate_limit_deleted: Optional[RateLimitDeleted]

    The details for events with this type.

    • id: Optional[str]

      The rate limit ID

  • rate_limit_updated: Optional[RateLimitUpdated]

    The details for events with this type.

    • id: Optional[str]

      The rate limit ID

    • changes_requested: Optional[RateLimitUpdatedChangesRequested]

      The payload used to update the rate limits.

      • batch_1_day_max_input_tokens: Optional[int]

        The maximum batch input tokens per day. Only relevant for certain models.

      • max_audio_megabytes_per_1_minute: Optional[int]

        The maximum audio megabytes per minute. Only relevant for certain models.

      • max_images_per_1_minute: Optional[int]

        The maximum images per minute. Only relevant for certain models.

      • max_requests_per_1_day: Optional[int]

        The maximum requests per day. Only relevant for certain models.

      • max_requests_per_1_minute: Optional[int]

        The maximum requests per minute.

      • max_tokens_per_1_minute: Optional[int]

        The maximum tokens per minute.

  • role_assignment_created: Optional[RoleAssignmentCreated]

    The details for events with this type.

    • id: Optional[str]

      The identifier of the role assignment.

    • principal_id: Optional[str]

      The principal (user or group) that received the role.

    • principal_type: Optional[str]

      The type of principal (user or group) that received the role.

    • resource_id: Optional[str]

      The resource the role assignment is scoped to.

    • resource_type: Optional[str]

      The type of resource the role assignment is scoped to.

  • role_assignment_deleted: Optional[RoleAssignmentDeleted]

    The details for events with this type.

    • id: Optional[str]

      The identifier of the role assignment.

    • principal_id: Optional[str]

      The principal (user or group) that had the role removed.

    • principal_type: Optional[str]

      The type of principal (user or group) that had the role removed.

    • resource_id: Optional[str]

      The resource the role assignment was scoped to.

    • resource_type: Optional[str]

      The type of resource the role assignment was scoped to.

  • role_bound_to_resource: Optional[RoleBoundToResource]

    The details for events with this type.

    • id: Optional[str]

      The ID of the resource the role was bound to. ChatGPT workspace connector resources use <workspace_id>__<connector_id>.

    • connector_id: Optional[str]

      The connector ID for a ChatGPT workspace connector resource.

    • connector_name: Optional[str]

      The connector display name for a ChatGPT workspace connector resource, or the connector ID when the display name could not be resolved.

    • enabled: Optional[bool]

      Whether the connector is enabled for the role.

    • permissions: Optional[List[str]]

      The permissions granted to the role for the resource.

    • resource_id: Optional[str]

      The ID of the resource the role was bound to.

    • resource_type: Optional[str]

      The type of resource the role was bound to.

    • role_id: Optional[str]

      The ID of the role that was bound to the resource.

    • source: Optional[Literal["role_toggle", "role_connector_update", "role_delete", 2 more]]

      The connector role mutation path that produced the event.

      • "role_toggle"

      • "role_connector_update"

      • "role_delete"

      • "workspace_permissions"

      • "connector_publish"

    • workspace_id: Optional[str]

      The workspace ID for a ChatGPT workspace connector resource.

  • role_created: Optional[RoleCreated]

    The details for events with this type.

    • id: Optional[str]

      The role ID.

    • permissions: Optional[List[str]]

      The permissions granted by the role.

    • resource_id: Optional[str]

      The resource the role is scoped to.

    • resource_type: Optional[str]

      The type of resource the role belongs to.

    • role_name: Optional[str]

      The name of the role.

  • role_deleted: Optional[RoleDeleted]

    The details for events with this type.

    • id: Optional[str]

      The role ID.

  • role_unbound_from_resource: Optional[RoleUnboundFromResource]

    The details for events with this type.

    • id: Optional[str]

      The ID of the resource the role was unbound from. ChatGPT workspace connector resources use <workspace_id>__<connector_id>.

    • connector_id: Optional[str]

      The connector ID for a ChatGPT workspace connector resource.

    • connector_name: Optional[str]

      The connector display name for a ChatGPT workspace connector resource, or the connector ID when the display name could not be resolved.

    • enabled: Optional[bool]

      Whether the connector is enabled for the role.

    • permissions: Optional[List[str]]

      The permissions remaining for the role after the change.

    • resource_id: Optional[str]

      The ID of the resource the role was unbound from.

    • resource_type: Optional[str]

      The type of resource the role was unbound from.

    • role_id: Optional[str]

      The ID of the role that was unbound from the resource.

    • source: Optional[Literal["role_toggle", "role_connector_update", "role_delete", 2 more]]

      The connector role mutation path that produced the event.

      • "role_toggle"

      • "role_connector_update"

      • "role_delete"

      • "workspace_permissions"

      • "connector_publish"

    • workspace_id: Optional[str]

      The workspace ID for a ChatGPT workspace connector resource.

  • role_updated: Optional[RoleUpdated]

    The details for events with this type.

    • id: Optional[str]

      The role ID.

    • changes_requested: Optional[RoleUpdatedChangesRequested]

      The payload used to update the role.

      • description: Optional[str]

        The updated role description, when provided.

      • metadata: Optional[object]

        Additional metadata stored on the role.

      • permissions_added: Optional[List[str]]

        The permissions added to the role.

      • permissions_removed: Optional[List[str]]

        The permissions removed from the role.

      • resource_id: Optional[str]

        The resource the role is scoped to.

      • resource_type: Optional[str]

        The type of resource the role belongs to.

      • role_name: Optional[str]

        The updated role name, when provided.

  • scim_disabled: Optional[ScimDisabled]

    The details for events with this type.

    • id: Optional[str]

      The ID of the SCIM was disabled for.

  • scim_enabled: Optional[ScimEnabled]

    The details for events with this type.

    • id: Optional[str]

      The ID of the SCIM was enabled for.

  • service_account_created: Optional[ServiceAccountCreated]

    The details for events with this type.

    • id: Optional[str]

      The service account ID.

    • data: Optional[ServiceAccountCreatedData]

      The payload used to create the service account.

      • role: Optional[str]

        The role of the service account. Is either owner or member.

  • service_account_deleted: Optional[ServiceAccountDeleted]

    The details for events with this type.

    • id: Optional[str]

      The service account ID.

  • service_account_updated: Optional[ServiceAccountUpdated]

    The details for events with this type.

    • id: Optional[str]

      The service account ID.

    • changes_requested: Optional[ServiceAccountUpdatedChangesRequested]

      The payload used to updated the service account.

      • role: Optional[str]

        The role of the service account. Is either owner or member.

  • user_added: Optional[UserAdded]

    The details for events with this type.

    • id: Optional[str]

      The user ID.

    • data: Optional[UserAddedData]

      The payload used to add the user to the project.

      • role: Optional[str]

        The role of the user. Is either owner or member.

  • user_deleted: Optional[UserDeleted]

    The details for events with this type.

    • id: Optional[str]

      The user ID.

  • user_updated: Optional[UserUpdated]

    The details for events with this type.

    • id: Optional[str]

      The project ID.

    • changes_requested: Optional[UserUpdatedChangesRequested]

      The payload used to update the user.

      • role: Optional[str]

        The role of the user. Is either owner or member.

  • workload_identity_provider_mapping_created: Optional[WorkloadIdentityProviderMappingCreated]

    The details for events with this type.

    • id: Optional[str]

      The workload identity provider mapping ID.

    • data: Optional[object]

      The payload used to create the workload identity provider mapping.

    • identity_provider_id: Optional[str]

      The workload identity provider ID.

  • workload_identity_provider_mapping_deleted: Optional[WorkloadIdentityProviderMappingDeleted]

    The details for events with this type.

    • id: Optional[str]

      The workload identity provider mapping ID.

    • identity_provider_id: Optional[str]

      The workload identity provider ID.

    • project_id: Optional[str]

      The project ID.

    • service_account_id: Optional[str]

      The mapped service account ID.

  • workload_identity_provider_mapping_updated: Optional[WorkloadIdentityProviderMappingUpdated]

    The details for events with this type.

    • id: Optional[str]

      The workload identity provider mapping ID.

    • changes_requested: Optional[object]

      The payload used to update the workload identity provider mapping.

    • identity_provider_id: Optional[str]

      The workload identity provider ID.

  • workload_identity_provider_created: Optional[WorkloadIdentityProviderCreated]

    The details for events with this type.

    • id: Optional[str]

      The workload identity provider ID.

    • data: Optional[object]

      The payload used to create the workload identity provider.

  • workload_identity_provider_deleted: Optional[WorkloadIdentityProviderDeleted]

    The details for events with this type.

    • id: Optional[str]

      The workload identity provider ID.

    • name: Optional[str]

      The workload identity provider name.

  • workload_identity_provider_updated: Optional[WorkloadIdentityProviderUpdated]

    The details for events with this type.

    • id: Optional[str]

      The workload identity provider ID.

    • changes_requested: Optional[object]

      The payload used to update the workload identity provider.

Admin API Keys

List all organization and project API keys.

admin.organization.admin_api_keys.list(AdminAPIKeyListParams**kwargs) -> SyncCursorPage[AdminAPIKey]

get /organization/admin_api_keys

List organization API keys

Parameters

• after: Optional[str]

  Return keys with IDs that come after this ID in the pagination order.

• limit: Optional[int]

  Maximum number of keys to return.

• order: Optional[Literal["asc", "desc"]]

  Order results by creation time, ascending or descending.

  • "asc"

  • "desc"

Returns

• class AdminAPIKey: …

  Represents an individual Admin API key in an org.

  • id: str

    The identifier, which can be referenced in API endpoints

  • created_at: int

    The Unix timestamp (in seconds) of when the API key was created

  • expires_at: Optional[int]

    The Unix timestamp (in seconds) of when the API key expires

  • object: Literal["organization.admin_api_key"]

    The object type, which is always organization.admin_api_key

    • "organization.admin_api_key"

  • owner: Owner

    • id: Optional[str]

      The identifier, which can be referenced in API endpoints

    • created_at: Optional[int]

      The Unix timestamp (in seconds) of when the user was created

    • name: Optional[str]

      The name of the user

    • object: Optional[str]

      The object type, which is always organization.user

    • role: Optional[str]

      Always owner

    • type: Optional[str]

      Always user

  • redacted_value: str

    The redacted value of the API key

  • last_used_at: Optional[int]

    The Unix timestamp (in seconds) of when the API key was last used

  • name: Optional[str]

    The name of the API key

Example

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
page = client.admin.organization.admin_api_keys.list()
page = page.data[0]
print(page.id)

Response

{
  "data": [
    {
      "id": "key_abc",
      "created_at": 1711471533,
      "expires_at": 1714063533,
      "object": "organization.admin_api_key",
      "owner": {
        "id": "sa_456",
        "created_at": 1711471533,
        "name": "My Service Account",
        "object": "organization.user",
        "role": "owner",
        "type": "user"
      },
      "redacted_value": "sk-admin...def",
      "last_used_at": 1711471534,
      "name": "Administration Key"
    }
  ],
  "has_more": false,
  "object": "list",
  "first_id": "key_abc",
  "last_id": "key_xyz"
}

Create admin API key

admin.organization.admin_api_keys.create(AdminAPIKeyCreateParams**kwargs) -> AdminAPIKeyCreateResponse

post /organization/admin_api_keys

Create an organization admin API key

Parameters

• name: str

• expires_in_seconds: Optional[int]

  The number of seconds until the API key expires. Omit this field for a key that does not expire.

Returns

• class AdminAPIKeyCreateResponse: …

  Represents an individual Admin API key in an org.

  • value: str

    The value of the API key. Only shown on create.

Example

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
admin_api_key = client.admin.organization.admin_api_keys.create(
    name="New Admin Key",
)
print(admin_api_key)

Response

{
  "id": "key_abc",
  "created_at": 1711471533,
  "expires_at": 1714063533,
  "object": "organization.admin_api_key",
  "owner": {
    "id": "sa_456",
    "created_at": 1711471533,
    "name": "My Service Account",
    "object": "organization.user",
    "role": "owner",
    "type": "user"
  },
  "redacted_value": "sk-admin...def",
  "last_used_at": 1711471534,
  "name": "Administration Key",
  "value": "sk-admin-1234abcd"
}

Retrieve admin API key

admin.organization.admin_api_keys.retrieve(strkey_id) -> AdminAPIKey

get /organization/admin_api_keys/{key_id}

Retrieve a single organization API key

Parameters

• key_id: str

  The ID of the API key.

Returns

• class AdminAPIKey: …

  Represents an individual Admin API key in an org.

  • id: str

    The identifier, which can be referenced in API endpoints

  • created_at: int

    The Unix timestamp (in seconds) of when the API key was created

  • expires_at: Optional[int]

    The Unix timestamp (in seconds) of when the API key expires

  • object: Literal["organization.admin_api_key"]

    The object type, which is always organization.admin_api_key

    • "organization.admin_api_key"

  • owner: Owner

    • id: Optional[str]

      The identifier, which can be referenced in API endpoints

    • created_at: Optional[int]

      The Unix timestamp (in seconds) of when the user was created

    • name: Optional[str]

      The name of the user

    • object: Optional[str]

      The object type, which is always organization.user

    • role: Optional[str]

      Always owner

    • type: Optional[str]

      Always user

  • redacted_value: str

    The redacted value of the API key

  • last_used_at: Optional[int]

    The Unix timestamp (in seconds) of when the API key was last used

  • name: Optional[str]

    The name of the API key

Example

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
admin_api_key = client.admin.organization.admin_api_keys.retrieve(
    "key_id",
)
print(admin_api_key.id)

Response

{
  "id": "key_abc",
  "created_at": 1711471533,
  "expires_at": 1714063533,
  "object": "organization.admin_api_key",
  "owner": {
    "id": "sa_456",
    "created_at": 1711471533,
    "name": "My Service Account",
    "object": "organization.user",
    "role": "owner",
    "type": "user"
  },
  "redacted_value": "sk-admin...def",
  "last_used_at": 1711471534,
  "name": "Administration Key"
}

Delete admin API key

admin.organization.admin_api_keys.delete(strkey_id) -> AdminAPIKeyDeleteResponse

delete /organization/admin_api_keys/{key_id}

Delete an organization admin API key

Parameters

• key_id: str

  The ID of the API key to be deleted.

Returns

• class AdminAPIKeyDeleteResponse: …

  • id: str

  • deleted: bool

  • object: Literal["organization.admin_api_key.deleted"]

    • "organization.admin_api_key.deleted"

Example

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
admin_api_key = client.admin.organization.admin_api_keys.delete(
    "key_id",
)
print(admin_api_key.id)

Response

{
  "id": "key_abc",
  "deleted": true,
  "object": "organization.admin_api_key.deleted"
}

Domain Types

Admin API Key

• class AdminAPIKey: …

  Represents an individual Admin API key in an org.

  • id: str

    The identifier, which can be referenced in API endpoints

  • created_at: int

    The Unix timestamp (in seconds) of when the API key was created

  • expires_at: Optional[int]

    The Unix timestamp (in seconds) of when the API key expires

  • object: Literal["organization.admin_api_key"]

    The object type, which is always organization.admin_api_key

    • "organization.admin_api_key"

  • owner: Owner

    • id: Optional[str]

      The identifier, which can be referenced in API endpoints

    • created_at: Optional[int]

      The Unix timestamp (in seconds) of when the user was created

    • name: Optional[str]

      The name of the user

    • object: Optional[str]

      The object type, which is always organization.user

    • role: Optional[str]

      Always owner

    • type: Optional[str]

      Always user

  • redacted_value: str

    The redacted value of the API key

  • last_used_at: Optional[int]

    The Unix timestamp (in seconds) of when the API key was last used

  • name: Optional[str]

    The name of the API key

Admin API Key Create Response

• class AdminAPIKeyCreateResponse: …

  Represents an individual Admin API key in an org.

  • value: str

    The value of the API key. Only shown on create.

Admin API Key Delete Response

• class AdminAPIKeyDeleteResponse: …

  • id: str

  • deleted: bool

  • object: Literal["organization.admin_api_key.deleted"]

    • "organization.admin_api_key.deleted"

Usage

Audio speeches

admin.organization.usage.audio_speeches(UsageAudioSpeechesParams**kwargs) -> UsageAudioSpeechesResponse

get /organization/usage/audio_speeches

Get audio speeches usage details for the organization.

Parameters

• start_time: int

  Start time (Unix seconds) of the query time range, inclusive.

• api_key_ids: Optional[Sequence[str]]

  Return only usage for these API keys.

• bucket_width: Optional[Literal["1m", "1h", "1d"]]

  Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.

  • "1m"

  • "1h"

  • "1d"

• end_time: Optional[int]

  End time (Unix seconds) of the query time range, exclusive.

• group_by: Optional[List[Literal["project_id", "user_id", "api_key_id", "model"]]]

  Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model or any combination of them.

  • "project_id"

  • "user_id"

  • "api_key_id"

  • "model"

• limit: Optional[int]

  Specifies the number of buckets to return.

  • bucket_width=1d: default: 7, max: 31
  • bucket_width=1h: default: 24, max: 168
  • bucket_width=1m: default: 60, max: 1440

• models: Optional[Sequence[str]]

  Return only usage for these models.

• page: Optional[str]

  A cursor for use in pagination. Corresponding to the next_page field from the previous response.

• project_ids: Optional[Sequence[str]]

  Return only usage for these projects.

• user_ids: Optional[Sequence[str]]

  Return only usage for these users.

Returns

• class UsageAudioSpeechesResponse: …

  • data: List[Data]

    • end_time: int

    • object: Literal["bucket"]

      • "bucket"

    • results: List[DataResult]

      • class DataResultOrganizationUsageCompletionsResult: …

        The aggregated completions usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.completions.result"]

          • "organization.usage.completions.result"

        • output_tokens: int

          The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • batch: Optional[bool]

          When group_by=batch, this field tells whether the grouped usage result is batch or not.

        • input_audio_tokens: Optional[int]

          The aggregated number of audio input tokens used, including cached tokens.

        • input_cached_tokens: Optional[int]

          The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • output_audio_tokens: Optional[int]

          The aggregated number of audio output tokens used.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • service_tier: Optional[str]

          When group_by=service_tier, this field provides the service tier of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageEmbeddingsResult: …

        The aggregated embeddings usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of input tokens used.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.embeddings.result"]

          • "organization.usage.embeddings.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageModerationsResult: …

        The aggregated moderations usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of input tokens used.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.moderations.result"]

          • "organization.usage.moderations.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageImagesResult: …

        The aggregated images usage details of the specific time bucket.

        • images: int

          The number of images processed.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.images.result"]

          • "organization.usage.images.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • size: Optional[str]

          When group_by=size, this field provides the image size of the grouped usage result.

        • source: Optional[str]

          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[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageAudioSpeechesResult: …

        The aggregated audio speeches usage details of the specific time bucket.

        • characters: int

          The number of characters processed.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.audio_speeches.result"]

          • "organization.usage.audio_speeches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageAudioTranscriptionsResult: …

        The aggregated audio transcriptions usage details of the specific time bucket.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.audio_transcriptions.result"]

          • "organization.usage.audio_transcriptions.result"

        • seconds: int

          The number of seconds processed.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageVectorStoresResult: …

        The aggregated vector stores usage details of the specific time bucket.

        • object: Literal["organization.usage.vector_stores.result"]

          • "organization.usage.vector_stores.result"

        • usage_bytes: int

          The vector stores usage in bytes.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

      • class DataResultOrganizationUsageCodeInterpreterSessionsResult: …

        The aggregated code interpreter sessions usage details of the specific time bucket.

        • num_sessions: int

          The number of code interpreter sessions.

        • object: Literal["organization.usage.code_interpreter_sessions.result"]

          • "organization.usage.code_interpreter_sessions.result"

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

      • class DataResultOrganizationUsageFileSearchesResult: …

        The aggregated file search calls usage details of the specific time bucket.

        • num_requests: int

          The count of file search calls.

        • object: Literal["organization.usage.file_searches.result"]

          • "organization.usage.file_searches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

        • vector_store_id: Optional[str]

          When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result.

      • class DataResultOrganizationUsageWebSearchesResult: …

        The aggregated web search calls usage details of the specific time bucket.

        • num_model_requests: int

          The count of model requests.

        • num_requests: int

          The count of web search calls.

        • object: Literal["organization.usage.web_searches.result"]

          • "organization.usage.web_searches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • context_level: Optional[str]

          When group_by=context_level, this field provides the search context size of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationCostsResult: …

        The aggregated costs details of the specific time bucket.

        • object: Literal["organization.costs.result"]

          • "organization.costs.result"

        • amount: Optional[DataResultOrganizationCostsResultAmount]

          The monetary value in its associated currency.

          • currency: Optional[str]

            Lowercase ISO-4217 currency e.g. "usd"

          • value: Optional[float]

            The numeric value of the cost.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.

        • line_item: Optional[str]

          When group_by=line_item, this field provides the line item of the grouped costs result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped costs result.

        • quantity: Optional[float]

          When group_by=line_item, this field provides the quantity of the grouped costs result.

    • start_time: int

  • has_more: bool

  • next_page: Optional[str]

  • object: Literal["page"]

    • "page"

Example

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
response = client.admin.organization.usage.audio_speeches(
    start_time=0,
)
print(response.data)

Response

{
  "data": [
    {
      "end_time": 0,
      "object": "bucket",
      "results": [
        {
          "input_tokens": 0,
          "num_model_requests": 0,
          "object": "organization.usage.completions.result",
          "output_tokens": 0,
          "api_key_id": "api_key_id",
          "batch": true,
          "input_audio_tokens": 0,
          "input_cached_tokens": 0,
          "model": "model",
          "output_audio_tokens": 0,
          "project_id": "project_id",
          "service_tier": "service_tier",
          "user_id": "user_id"
        }
      ],
      "start_time": 0
    }
  ],
  "has_more": true,
  "next_page": "next_page",
  "object": "page"
}

Audio transcriptions

admin.organization.usage.audio_transcriptions(UsageAudioTranscriptionsParams**kwargs) -> UsageAudioTranscriptionsResponse

get /organization/usage/audio_transcriptions

Get audio transcriptions usage details for the organization.

Parameters

• start_time: int

  Start time (Unix seconds) of the query time range, inclusive.

• api_key_ids: Optional[Sequence[str]]

  Return only usage for these API keys.

• bucket_width: Optional[Literal["1m", "1h", "1d"]]

  Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.

  • "1m"

  • "1h"

  • "1d"

• end_time: Optional[int]

  End time (Unix seconds) of the query time range, exclusive.

• group_by: Optional[List[Literal["project_id", "user_id", "api_key_id", "model"]]]

  Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model or any combination of them.

  • "project_id"

  • "user_id"

  • "api_key_id"

  • "model"

• limit: Optional[int]

  Specifies the number of buckets to return.

  • bucket_width=1d: default: 7, max: 31
  • bucket_width=1h: default: 24, max: 168
  • bucket_width=1m: default: 60, max: 1440

• models: Optional[Sequence[str]]

  Return only usage for these models.

• page: Optional[str]

  A cursor for use in pagination. Corresponding to the next_page field from the previous response.

• project_ids: Optional[Sequence[str]]

  Return only usage for these projects.

• user_ids: Optional[Sequence[str]]

  Return only usage for these users.

Returns

• class UsageAudioTranscriptionsResponse: …

  • data: List[Data]

    • end_time: int

    • object: Literal["bucket"]

      • "bucket"

    • results: List[DataResult]

      • class DataResultOrganizationUsageCompletionsResult: …

        The aggregated completions usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.completions.result"]

          • "organization.usage.completions.result"

        • output_tokens: int

          The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • batch: Optional[bool]

          When group_by=batch, this field tells whether the grouped usage result is batch or not.

        • input_audio_tokens: Optional[int]

          The aggregated number of audio input tokens used, including cached tokens.

        • input_cached_tokens: Optional[int]

          The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • output_audio_tokens: Optional[int]

          The aggregated number of audio output tokens used.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • service_tier: Optional[str]

          When group_by=service_tier, this field provides the service tier of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageEmbeddingsResult: …

        The aggregated embeddings usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of input tokens used.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.embeddings.result"]

          • "organization.usage.embeddings.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageModerationsResult: …

        The aggregated moderations usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of input tokens used.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.moderations.result"]

          • "organization.usage.moderations.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageImagesResult: …

        The aggregated images usage details of the specific time bucket.

        • images: int

          The number of images processed.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.images.result"]

          • "organization.usage.images.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • size: Optional[str]

          When group_by=size, this field provides the image size of the grouped usage result.

        • source: Optional[str]

          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[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageAudioSpeechesResult: …

        The aggregated audio speeches usage details of the specific time bucket.

        • characters: int

          The number of characters processed.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.audio_speeches.result"]

          • "organization.usage.audio_speeches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageAudioTranscriptionsResult: …

        The aggregated audio transcriptions usage details of the specific time bucket.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.audio_transcriptions.result"]

          • "organization.usage.audio_transcriptions.result"

        • seconds: int

          The number of seconds processed.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageVectorStoresResult: …

        The aggregated vector stores usage details of the specific time bucket.

        • object: Literal["organization.usage.vector_stores.result"]

          • "organization.usage.vector_stores.result"

        • usage_bytes: int

          The vector stores usage in bytes.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

      • class DataResultOrganizationUsageCodeInterpreterSessionsResult: …

        The aggregated code interpreter sessions usage details of the specific time bucket.

        • num_sessions: int

          The number of code interpreter sessions.

        • object: Literal["organization.usage.code_interpreter_sessions.result"]

          • "organization.usage.code_interpreter_sessions.result"

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

      • class DataResultOrganizationUsageFileSearchesResult: …

        The aggregated file search calls usage details of the specific time bucket.

        • num_requests: int

          The count of file search calls.

        • object: Literal["organization.usage.file_searches.result"]

          • "organization.usage.file_searches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

        • vector_store_id: Optional[str]

          When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result.

      • class DataResultOrganizationUsageWebSearchesResult: …

        The aggregated web search calls usage details of the specific time bucket.

        • num_model_requests: int

          The count of model requests.

        • num_requests: int

          The count of web search calls.

        • object: Literal["organization.usage.web_searches.result"]

          • "organization.usage.web_searches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • context_level: Optional[str]

          When group_by=context_level, this field provides the search context size of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationCostsResult: …

        The aggregated costs details of the specific time bucket.

        • object: Literal["organization.costs.result"]

          • "organization.costs.result"

        • amount: Optional[DataResultOrganizationCostsResultAmount]

          The monetary value in its associated currency.

          • currency: Optional[str]

            Lowercase ISO-4217 currency e.g. "usd"

          • value: Optional[float]

            The numeric value of the cost.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.

        • line_item: Optional[str]

          When group_by=line_item, this field provides the line item of the grouped costs result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped costs result.

        • quantity: Optional[float]

          When group_by=line_item, this field provides the quantity of the grouped costs result.

    • start_time: int

  • has_more: bool

  • next_page: Optional[str]

  • object: Literal["page"]

    • "page"

Example

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
response = client.admin.organization.usage.audio_transcriptions(
    start_time=0,
)
print(response.data)

Response

{
  "data": [
    {
      "end_time": 0,
      "object": "bucket",
      "results": [
        {
          "input_tokens": 0,
          "num_model_requests": 0,
          "object": "organization.usage.completions.result",
          "output_tokens": 0,
          "api_key_id": "api_key_id",
          "batch": true,
          "input_audio_tokens": 0,
          "input_cached_tokens": 0,
          "model": "model",
          "output_audio_tokens": 0,
          "project_id": "project_id",
          "service_tier": "service_tier",
          "user_id": "user_id"
        }
      ],
      "start_time": 0
    }
  ],
  "has_more": true,
  "next_page": "next_page",
  "object": "page"
}

Code interpreter sessions

admin.organization.usage.code_interpreter_sessions(UsageCodeInterpreterSessionsParams**kwargs) -> UsageCodeInterpreterSessionsResponse

get /organization/usage/code_interpreter_sessions

Get code interpreter sessions usage details for the organization.

Parameters

• start_time: int

  Start time (Unix seconds) of the query time range, inclusive.

• bucket_width: Optional[Literal["1m", "1h", "1d"]]

  Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.

  • "1m"

  • "1h"

  • "1d"

• end_time: Optional[int]

  End time (Unix seconds) of the query time range, exclusive.

• group_by: Optional[List[Literal["project_id"]]]

  Group the usage data by the specified fields. Support fields include project_id.

  • "project_id"

• limit: Optional[int]

  Specifies the number of buckets to return.

  • bucket_width=1d: default: 7, max: 31
  • bucket_width=1h: default: 24, max: 168
  • bucket_width=1m: default: 60, max: 1440

• page: Optional[str]

  A cursor for use in pagination. Corresponding to the next_page field from the previous response.

• project_ids: Optional[Sequence[str]]

  Return only usage for these projects.

Returns

• class UsageCodeInterpreterSessionsResponse: …

  • data: List[Data]

    • end_time: int

    • object: Literal["bucket"]

      • "bucket"

    • results: List[DataResult]

      • class DataResultOrganizationUsageCompletionsResult: …

        The aggregated completions usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.completions.result"]

          • "organization.usage.completions.result"

        • output_tokens: int

          The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • batch: Optional[bool]

          When group_by=batch, this field tells whether the grouped usage result is batch or not.

        • input_audio_tokens: Optional[int]

          The aggregated number of audio input tokens used, including cached tokens.

        • input_cached_tokens: Optional[int]

          The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • output_audio_tokens: Optional[int]

          The aggregated number of audio output tokens used.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • service_tier: Optional[str]

          When group_by=service_tier, this field provides the service tier of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageEmbeddingsResult: …

        The aggregated embeddings usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of input tokens used.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.embeddings.result"]

          • "organization.usage.embeddings.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageModerationsResult: …

        The aggregated moderations usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of input tokens used.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.moderations.result"]

          • "organization.usage.moderations.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageImagesResult: …

        The aggregated images usage details of the specific time bucket.

        • images: int

          The number of images processed.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.images.result"]

          • "organization.usage.images.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • size: Optional[str]

          When group_by=size, this field provides the image size of the grouped usage result.

        • source: Optional[str]

          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[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageAudioSpeechesResult: …

        The aggregated audio speeches usage details of the specific time bucket.

        • characters: int

          The number of characters processed.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.audio_speeches.result"]

          • "organization.usage.audio_speeches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageAudioTranscriptionsResult: …

        The aggregated audio transcriptions usage details of the specific time bucket.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.audio_transcriptions.result"]

          • "organization.usage.audio_transcriptions.result"

        • seconds: int

          The number of seconds processed.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageVectorStoresResult: …

        The aggregated vector stores usage details of the specific time bucket.

        • object: Literal["organization.usage.vector_stores.result"]

          • "organization.usage.vector_stores.result"

        • usage_bytes: int

          The vector stores usage in bytes.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

      • class DataResultOrganizationUsageCodeInterpreterSessionsResult: …

        The aggregated code interpreter sessions usage details of the specific time bucket.

        • num_sessions: int

          The number of code interpreter sessions.

        • object: Literal["organization.usage.code_interpreter_sessions.result"]

          • "organization.usage.code_interpreter_sessions.result"

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

      • class DataResultOrganizationUsageFileSearchesResult: …

        The aggregated file search calls usage details of the specific time bucket.

        • num_requests: int

          The count of file search calls.

        • object: Literal["organization.usage.file_searches.result"]

          • "organization.usage.file_searches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

        • vector_store_id: Optional[str]

          When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result.

      • class DataResultOrganizationUsageWebSearchesResult: …

        The aggregated web search calls usage details of the specific time bucket.

        • num_model_requests: int

          The count of model requests.

        • num_requests: int

          The count of web search calls.

        • object: Literal["organization.usage.web_searches.result"]

          • "organization.usage.web_searches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • context_level: Optional[str]

          When group_by=context_level, this field provides the search context size of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationCostsResult: …

        The aggregated costs details of the specific time bucket.

        • object: Literal["organization.costs.result"]

          • "organization.costs.result"

        • amount: Optional[DataResultOrganizationCostsResultAmount]

          The monetary value in its associated currency.

          • currency: Optional[str]

            Lowercase ISO-4217 currency e.g. "usd"

          • value: Optional[float]

            The numeric value of the cost.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.

        • line_item: Optional[str]

          When group_by=line_item, this field provides the line item of the grouped costs result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped costs result.

        • quantity: Optional[float]

          When group_by=line_item, this field provides the quantity of the grouped costs result.

    • start_time: int

  • has_more: bool

  • next_page: Optional[str]

  • object: Literal["page"]

    • "page"

Example

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
response = client.admin.organization.usage.code_interpreter_sessions(
    start_time=0,
)
print(response.data)

Response

{
  "data": [
    {
      "end_time": 0,
      "object": "bucket",
      "results": [
        {
          "input_tokens": 0,
          "num_model_requests": 0,
          "object": "organization.usage.completions.result",
          "output_tokens": 0,
          "api_key_id": "api_key_id",
          "batch": true,
          "input_audio_tokens": 0,
          "input_cached_tokens": 0,
          "model": "model",
          "output_audio_tokens": 0,
          "project_id": "project_id",
          "service_tier": "service_tier",
          "user_id": "user_id"
        }
      ],
      "start_time": 0
    }
  ],
  "has_more": true,
  "next_page": "next_page",
  "object": "page"
}

Completions

admin.organization.usage.completions(UsageCompletionsParams**kwargs) -> UsageCompletionsResponse

get /organization/usage/completions

Get completions usage details for the organization.

Parameters

• start_time: int

  Start time (Unix seconds) of the query time range, inclusive.

• api_key_ids: Optional[Sequence[str]]

  Return only usage for these API keys.

• batch: Optional[bool]

  If true, return batch jobs only. If false, return non-batch jobs only. By default, return both.

• bucket_width: Optional[Literal["1m", "1h", "1d"]]

  Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.

  • "1m"

  • "1h"

  • "1d"

• end_time: Optional[int]

  End time (Unix seconds) of the query time range, exclusive.

• group_by: Optional[List[Literal["project_id", "user_id", "api_key_id", 3 more]]]

  Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model, batch, service_tier or any combination of them.

  • "project_id"

  • "user_id"

  • "api_key_id"

  • "model"

  • "batch"

  • "service_tier"

• limit: Optional[int]

  Specifies the number of buckets to return.

  • bucket_width=1d: default: 7, max: 31
  • bucket_width=1h: default: 24, max: 168
  • bucket_width=1m: default: 60, max: 1440

• models: Optional[Sequence[str]]

  Return only usage for these models.

• page: Optional[str]

  A cursor for use in pagination. Corresponding to the next_page field from the previous response.

• project_ids: Optional[Sequence[str]]

  Return only usage for these projects.

• user_ids: Optional[Sequence[str]]

  Return only usage for these users.

Returns

• class UsageCompletionsResponse: …

  • data: List[Data]

    • end_time: int

    • object: Literal["bucket"]

      • "bucket"

    • results: List[DataResult]

      • class DataResultOrganizationUsageCompletionsResult: …

        The aggregated completions usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.completions.result"]

          • "organization.usage.completions.result"

        • output_tokens: int

          The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • batch: Optional[bool]

          When group_by=batch, this field tells whether the grouped usage result is batch or not.

        • input_audio_tokens: Optional[int]

          The aggregated number of audio input tokens used, including cached tokens.

        • input_cached_tokens: Optional[int]

          The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • output_audio_tokens: Optional[int]

          The aggregated number of audio output tokens used.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • service_tier: Optional[str]

          When group_by=service_tier, this field provides the service tier of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageEmbeddingsResult: …

        The aggregated embeddings usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of input tokens used.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.embeddings.result"]

          • "organization.usage.embeddings.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageModerationsResult: …

        The aggregated moderations usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of input tokens used.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.moderations.result"]

          • "organization.usage.moderations.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageImagesResult: …

        The aggregated images usage details of the specific time bucket.

        • images: int

          The number of images processed.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.images.result"]

          • "organization.usage.images.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • size: Optional[str]

          When group_by=size, this field provides the image size of the grouped usage result.

        • source: Optional[str]

          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[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageAudioSpeechesResult: …

        The aggregated audio speeches usage details of the specific time bucket.

        • characters: int

          The number of characters processed.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.audio_speeches.result"]

          • "organization.usage.audio_speeches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageAudioTranscriptionsResult: …

        The aggregated audio transcriptions usage details of the specific time bucket.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.audio_transcriptions.result"]

          • "organization.usage.audio_transcriptions.result"

        • seconds: int

          The number of seconds processed.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageVectorStoresResult: …

        The aggregated vector stores usage details of the specific time bucket.

        • object: Literal["organization.usage.vector_stores.result"]

          • "organization.usage.vector_stores.result"

        • usage_bytes: int

          The vector stores usage in bytes.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

      • class DataResultOrganizationUsageCodeInterpreterSessionsResult: …

        The aggregated code interpreter sessions usage details of the specific time bucket.

        • num_sessions: int

          The number of code interpreter sessions.

        • object: Literal["organization.usage.code_interpreter_sessions.result"]

          • "organization.usage.code_interpreter_sessions.result"

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

      • class DataResultOrganizationUsageFileSearchesResult: …

        The aggregated file search calls usage details of the specific time bucket.

        • num_requests: int

          The count of file search calls.

        • object: Literal["organization.usage.file_searches.result"]

          • "organization.usage.file_searches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

        • vector_store_id: Optional[str]

          When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result.

      • class DataResultOrganizationUsageWebSearchesResult: …

        The aggregated web search calls usage details of the specific time bucket.

        • num_model_requests: int

          The count of model requests.

        • num_requests: int

          The count of web search calls.

        • object: Literal["organization.usage.web_searches.result"]

          • "organization.usage.web_searches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • context_level: Optional[str]

          When group_by=context_level, this field provides the search context size of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationCostsResult: …

        The aggregated costs details of the specific time bucket.

        • object: Literal["organization.costs.result"]

          • "organization.costs.result"

        • amount: Optional[DataResultOrganizationCostsResultAmount]

          The monetary value in its associated currency.

          • currency: Optional[str]

            Lowercase ISO-4217 currency e.g. "usd"

          • value: Optional[float]

            The numeric value of the cost.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.

        • line_item: Optional[str]

          When group_by=line_item, this field provides the line item of the grouped costs result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped costs result.

        • quantity: Optional[float]

          When group_by=line_item, this field provides the quantity of the grouped costs result.

    • start_time: int

  • has_more: bool

  • next_page: Optional[str]

  • object: Literal["page"]

    • "page"

Example

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
response = client.admin.organization.usage.completions(
    start_time=0,
)
print(response.data)

Response

{
  "data": [
    {
      "end_time": 0,
      "object": "bucket",
      "results": [
        {
          "input_tokens": 0,
          "num_model_requests": 0,
          "object": "organization.usage.completions.result",
          "output_tokens": 0,
          "api_key_id": "api_key_id",
          "batch": true,
          "input_audio_tokens": 0,
          "input_cached_tokens": 0,
          "model": "model",
          "output_audio_tokens": 0,
          "project_id": "project_id",
          "service_tier": "service_tier",
          "user_id": "user_id"
        }
      ],
      "start_time": 0
    }
  ],
  "has_more": true,
  "next_page": "next_page",
  "object": "page"
}

Embeddings

admin.organization.usage.embeddings(UsageEmbeddingsParams**kwargs) -> UsageEmbeddingsResponse

get /organization/usage/embeddings

Get embeddings usage details for the organization.

Parameters

• start_time: int

  Start time (Unix seconds) of the query time range, inclusive.

• api_key_ids: Optional[Sequence[str]]

  Return only usage for these API keys.

• bucket_width: Optional[Literal["1m", "1h", "1d"]]

  Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.

  • "1m"

  • "1h"

  • "1d"

• end_time: Optional[int]

  End time (Unix seconds) of the query time range, exclusive.

• group_by: Optional[List[Literal["project_id", "user_id", "api_key_id", "model"]]]

  Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model or any combination of them.

  • "project_id"

  • "user_id"

  • "api_key_id"

  • "model"

• limit: Optional[int]

  Specifies the number of buckets to return.

  • bucket_width=1d: default: 7, max: 31
  • bucket_width=1h: default: 24, max: 168
  • bucket_width=1m: default: 60, max: 1440

• models: Optional[Sequence[str]]

  Return only usage for these models.

• page: Optional[str]

  A cursor for use in pagination. Corresponding to the next_page field from the previous response.

• project_ids: Optional[Sequence[str]]

  Return only usage for these projects.

• user_ids: Optional[Sequence[str]]

  Return only usage for these users.

Returns

• class UsageEmbeddingsResponse: …

  • data: List[Data]

    • end_time: int

    • object: Literal["bucket"]

      • "bucket"

    • results: List[DataResult]

      • class DataResultOrganizationUsageCompletionsResult: …

        The aggregated completions usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.completions.result"]

          • "organization.usage.completions.result"

        • output_tokens: int

          The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • batch: Optional[bool]

          When group_by=batch, this field tells whether the grouped usage result is batch or not.

        • input_audio_tokens: Optional[int]

          The aggregated number of audio input tokens used, including cached tokens.

        • input_cached_tokens: Optional[int]

          The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • output_audio_tokens: Optional[int]

          The aggregated number of audio output tokens used.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • service_tier: Optional[str]

          When group_by=service_tier, this field provides the service tier of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageEmbeddingsResult: …

        The aggregated embeddings usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of input tokens used.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.embeddings.result"]

          • "organization.usage.embeddings.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageModerationsResult: …

        The aggregated moderations usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of input tokens used.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.moderations.result"]

          • "organization.usage.moderations.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageImagesResult: …

        The aggregated images usage details of the specific time bucket.

        • images: int

          The number of images processed.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.images.result"]

          • "organization.usage.images.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • size: Optional[str]

          When group_by=size, this field provides the image size of the grouped usage result.

        • source: Optional[str]

          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[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageAudioSpeechesResult: …

        The aggregated audio speeches usage details of the specific time bucket.

        • characters: int

          The number of characters processed.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.audio_speeches.result"]

          • "organization.usage.audio_speeches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageAudioTranscriptionsResult: …

        The aggregated audio transcriptions usage details of the specific time bucket.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.audio_transcriptions.result"]

          • "organization.usage.audio_transcriptions.result"

        • seconds: int

          The number of seconds processed.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageVectorStoresResult: …

        The aggregated vector stores usage details of the specific time bucket.

        • object: Literal["organization.usage.vector_stores.result"]

          • "organization.usage.vector_stores.result"

        • usage_bytes: int

          The vector stores usage in bytes.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

      • class DataResultOrganizationUsageCodeInterpreterSessionsResult: …

        The aggregated code interpreter sessions usage details of the specific time bucket.

        • num_sessions: int

          The number of code interpreter sessions.

        • object: Literal["organization.usage.code_interpreter_sessions.result"]

          • "organization.usage.code_interpreter_sessions.result"

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

      • class DataResultOrganizationUsageFileSearchesResult: …

        The aggregated file search calls usage details of the specific time bucket.

        • num_requests: int

          The count of file search calls.

        • object: Literal["organization.usage.file_searches.result"]

          • "organization.usage.file_searches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

        • vector_store_id: Optional[str]

          When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result.

      • class DataResultOrganizationUsageWebSearchesResult: …

        The aggregated web search calls usage details of the specific time bucket.

        • num_model_requests: int

          The count of model requests.

        • num_requests: int

          The count of web search calls.

        • object: Literal["organization.usage.web_searches.result"]

          • "organization.usage.web_searches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • context_level: Optional[str]

          When group_by=context_level, this field provides the search context size of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationCostsResult: …

        The aggregated costs details of the specific time bucket.

        • object: Literal["organization.costs.result"]

          • "organization.costs.result"

        • amount: Optional[DataResultOrganizationCostsResultAmount]

          The monetary value in its associated currency.

          • currency: Optional[str]

            Lowercase ISO-4217 currency e.g. "usd"

          • value: Optional[float]

            The numeric value of the cost.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.

        • line_item: Optional[str]

          When group_by=line_item, this field provides the line item of the grouped costs result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped costs result.

        • quantity: Optional[float]

          When group_by=line_item, this field provides the quantity of the grouped costs result.

    • start_time: int

  • has_more: bool

  • next_page: Optional[str]

  • object: Literal["page"]

    • "page"

Example

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
response = client.admin.organization.usage.embeddings(
    start_time=0,
)
print(response.data)

Response

{
  "data": [
    {
      "end_time": 0,
      "object": "bucket",
      "results": [
        {
          "input_tokens": 0,
          "num_model_requests": 0,
          "object": "organization.usage.completions.result",
          "output_tokens": 0,
          "api_key_id": "api_key_id",
          "batch": true,
          "input_audio_tokens": 0,
          "input_cached_tokens": 0,
          "model": "model",
          "output_audio_tokens": 0,
          "project_id": "project_id",
          "service_tier": "service_tier",
          "user_id": "user_id"
        }
      ],
      "start_time": 0
    }
  ],
  "has_more": true,
  "next_page": "next_page",
  "object": "page"
}

Images

admin.organization.usage.images(UsageImagesParams**kwargs) -> UsageImagesResponse

get /organization/usage/images

Get images usage details for the organization.

Parameters

• start_time: int

  Start time (Unix seconds) of the query time range, inclusive.

• api_key_ids: Optional[Sequence[str]]

  Return only usage for these API keys.

• bucket_width: Optional[Literal["1m", "1h", "1d"]]

  Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.

  • "1m"

  • "1h"

  • "1d"

• end_time: Optional[int]

  End time (Unix seconds) of the query time range, exclusive.

• group_by: Optional[List[Literal["project_id", "user_id", "api_key_id", 3 more]]]

  Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model, size, source or any combination of them.

  • "project_id"

  • "user_id"

  • "api_key_id"

  • "model"

  • "size"

  • "source"

• limit: Optional[int]

  Specifies the number of buckets to return.

  • bucket_width=1d: default: 7, max: 31
  • bucket_width=1h: default: 24, max: 168
  • bucket_width=1m: default: 60, max: 1440

• models: Optional[Sequence[str]]

  Return only usage for these models.

• page: Optional[str]

  A cursor for use in pagination. Corresponding to the next_page field from the previous response.

• project_ids: Optional[Sequence[str]]

  Return only usage for these projects.

• sizes: Optional[List[Literal["256x256", "512x512", "1024x1024", 2 more]]]

  Return only usages for these image sizes. Possible values are 256x256, 512x512, 1024x1024, 1792x1792, 1024x1792 or any combination of them.

  • "256x256"

  • "512x512"

  • "1024x1024"

  • "1792x1792"

  • "1024x1792"

• sources: Optional[List[Literal["image.generation", "image.edit", "image.variation"]]]

  Return only usages for these sources. Possible values are image.generation, image.edit, image.variation or any combination of them.

  • "image.generation"

  • "image.edit"

  • "image.variation"

• user_ids: Optional[Sequence[str]]

  Return only usage for these users.

Returns

• class UsageImagesResponse: …

  • data: List[Data]

    • end_time: int

    • object: Literal["bucket"]

      • "bucket"

    • results: List[DataResult]

      • class DataResultOrganizationUsageCompletionsResult: …

        The aggregated completions usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.completions.result"]

          • "organization.usage.completions.result"

        • output_tokens: int

          The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • batch: Optional[bool]

          When group_by=batch, this field tells whether the grouped usage result is batch or not.

        • input_audio_tokens: Optional[int]

          The aggregated number of audio input tokens used, including cached tokens.

        • input_cached_tokens: Optional[int]

          The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • output_audio_tokens: Optional[int]

          The aggregated number of audio output tokens used.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • service_tier: Optional[str]

          When group_by=service_tier, this field provides the service tier of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageEmbeddingsResult: …

        The aggregated embeddings usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of input tokens used.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.embeddings.result"]

          • "organization.usage.embeddings.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageModerationsResult: …

        The aggregated moderations usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of input tokens used.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.moderations.result"]

          • "organization.usage.moderations.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageImagesResult: …

        The aggregated images usage details of the specific time bucket.

        • images: int

          The number of images processed.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.images.result"]

          • "organization.usage.images.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • size: Optional[str]

          When group_by=size, this field provides the image size of the grouped usage result.

        • source: Optional[str]

          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[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageAudioSpeechesResult: …

        The aggregated audio speeches usage details of the specific time bucket.

        • characters: int

          The number of characters processed.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.audio_speeches.result"]

          • "organization.usage.audio_speeches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageAudioTranscriptionsResult: …

        The aggregated audio transcriptions usage details of the specific time bucket.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.audio_transcriptions.result"]

          • "organization.usage.audio_transcriptions.result"

        • seconds: int

          The number of seconds processed.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageVectorStoresResult: …

        The aggregated vector stores usage details of the specific time bucket.

        • object: Literal["organization.usage.vector_stores.result"]

          • "organization.usage.vector_stores.result"

        • usage_bytes: int

          The vector stores usage in bytes.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

      • class DataResultOrganizationUsageCodeInterpreterSessionsResult: …

        The aggregated code interpreter sessions usage details of the specific time bucket.

        • num_sessions: int

          The number of code interpreter sessions.

        • object: Literal["organization.usage.code_interpreter_sessions.result"]

          • "organization.usage.code_interpreter_sessions.result"

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

      • class DataResultOrganizationUsageFileSearchesResult: …

        The aggregated file search calls usage details of the specific time bucket.

        • num_requests: int

          The count of file search calls.

        • object: Literal["organization.usage.file_searches.result"]

          • "organization.usage.file_searches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

        • vector_store_id: Optional[str]

          When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result.

      • class DataResultOrganizationUsageWebSearchesResult: …

        The aggregated web search calls usage details of the specific time bucket.

        • num_model_requests: int

          The count of model requests.

        • num_requests: int

          The count of web search calls.

        • object: Literal["organization.usage.web_searches.result"]

          • "organization.usage.web_searches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • context_level: Optional[str]

          When group_by=context_level, this field provides the search context size of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationCostsResult: …

        The aggregated costs details of the specific time bucket.

        • object: Literal["organization.costs.result"]

          • "organization.costs.result"

        • amount: Optional[DataResultOrganizationCostsResultAmount]

          The monetary value in its associated currency.

          • currency: Optional[str]

            Lowercase ISO-4217 currency e.g. "usd"

          • value: Optional[float]

            The numeric value of the cost.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.

        • line_item: Optional[str]

          When group_by=line_item, this field provides the line item of the grouped costs result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped costs result.

        • quantity: Optional[float]

          When group_by=line_item, this field provides the quantity of the grouped costs result.

    • start_time: int

  • has_more: bool

  • next_page: Optional[str]

  • object: Literal["page"]

    • "page"

Example

import os
from openai import OpenAI

client = OpenAI(
    admin_api_key=os.environ.get("OPENAI_ADMIN_KEY"),  # This is the default and can be omitted
)
response = client.admin.organization.usage.images(
    start_time=0,
)
print(response.data)

Response

{
  "data": [
    {
      "end_time": 0,
      "object": "bucket",
      "results": [
        {
          "input_tokens": 0,
          "num_model_requests": 0,
          "object": "organization.usage.completions.result",
          "output_tokens": 0,
          "api_key_id": "api_key_id",
          "batch": true,
          "input_audio_tokens": 0,
          "input_cached_tokens": 0,
          "model": "model",
          "output_audio_tokens": 0,
          "project_id": "project_id",
          "service_tier": "service_tier",
          "user_id": "user_id"
        }
      ],
      "start_time": 0
    }
  ],
  "has_more": true,
  "next_page": "next_page",
  "object": "page"
}

Moderations

admin.organization.usage.moderations(UsageModerationsParams**kwargs) -> UsageModerationsResponse

get /organization/usage/moderations

Get moderations usage details for the organization.

Parameters

• start_time: int

  Start time (Unix seconds) of the query time range, inclusive.

• api_key_ids: Optional[Sequence[str]]

  Return only usage for these API keys.

• bucket_width: Optional[Literal["1m", "1h", "1d"]]

  Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.

  • "1m"

  • "1h"

  • "1d"

• end_time: Optional[int]

  End time (Unix seconds) of the query time range, exclusive.

• group_by: Optional[List[Literal["project_id", "user_id", "api_key_id", "model"]]]

  Group the usage data by the specified fields. Support fields include project_id, user_id, api_key_id, model or any combination of them.

  • "project_id"

  • "user_id"

  • "api_key_id"

  • "model"

• limit: Optional[int]

  Specifies the number of buckets to return.

  • bucket_width=1d: default: 7, max: 31
  • bucket_width=1h: default: 24, max: 168
  • bucket_width=1m: default: 60, max: 1440

• models: Optional[Sequence[str]]

  Return only usage for these models.

• page: Optional[str]

  A cursor for use in pagination. Corresponding to the next_page field from the previous response.

• project_ids: Optional[Sequence[str]]

  Return only usage for these projects.

• user_ids: Optional[Sequence[str]]

  Return only usage for these users.

Returns

• class UsageModerationsResponse: …

  • data: List[Data]

    • end_time: int

    • object: Literal["bucket"]

      • "bucket"

    • results: List[DataResult]

      • class DataResultOrganizationUsageCompletionsResult: …

        The aggregated completions usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.completions.result"]

          • "organization.usage.completions.result"

        • output_tokens: int

          The aggregated number of text output tokens used. For customers subscribe to scale tier, this includes scale tier tokens.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • batch: Optional[bool]

          When group_by=batch, this field tells whether the grouped usage result is batch or not.

        • input_audio_tokens: Optional[int]

          The aggregated number of audio input tokens used, including cached tokens.

        • input_cached_tokens: Optional[int]

          The aggregated number of text input tokens that has been cached from previous requests. For customers subscribe to scale tier, this includes scale tier tokens.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • output_audio_tokens: Optional[int]

          The aggregated number of audio output tokens used.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • service_tier: Optional[str]

          When group_by=service_tier, this field provides the service tier of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageEmbeddingsResult: …

        The aggregated embeddings usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of input tokens used.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.embeddings.result"]

          • "organization.usage.embeddings.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageModerationsResult: …

        The aggregated moderations usage details of the specific time bucket.

        • input_tokens: int

          The aggregated number of input tokens used.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.moderations.result"]

          • "organization.usage.moderations.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageImagesResult: …

        The aggregated images usage details of the specific time bucket.

        • images: int

          The number of images processed.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.images.result"]

          • "organization.usage.images.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • size: Optional[str]

          When group_by=size, this field provides the image size of the grouped usage result.

        • source: Optional[str]

          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[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageAudioSpeechesResult: …

        The aggregated audio speeches usage details of the specific time bucket.

        • characters: int

          The number of characters processed.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.audio_speeches.result"]

          • "organization.usage.audio_speeches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageAudioTranscriptionsResult: …

        The aggregated audio transcriptions usage details of the specific time bucket.

        • num_model_requests: int

          The count of requests made to the model.

        • object: Literal["organization.usage.audio_transcriptions.result"]

          • "organization.usage.audio_transcriptions.result"

        • seconds: int

          The number of seconds processed.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationUsageVectorStoresResult: …

        The aggregated vector stores usage details of the specific time bucket.

        • object: Literal["organization.usage.vector_stores.result"]

          • "organization.usage.vector_stores.result"

        • usage_bytes: int

          The vector stores usage in bytes.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

      • class DataResultOrganizationUsageCodeInterpreterSessionsResult: …

        The aggregated code interpreter sessions usage details of the specific time bucket.

        • num_sessions: int

          The number of code interpreter sessions.

        • object: Literal["organization.usage.code_interpreter_sessions.result"]

          • "organization.usage.code_interpreter_sessions.result"

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

      • class DataResultOrganizationUsageFileSearchesResult: …

        The aggregated file search calls usage details of the specific time bucket.

        • num_requests: int

          The count of file search calls.

        • object: Literal["organization.usage.file_searches.result"]

          • "organization.usage.file_searches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

        • vector_store_id: Optional[str]

          When group_by=vector_store_id, this field provides the vector store ID of the grouped usage result.

      • class DataResultOrganizationUsageWebSearchesResult: …

        The aggregated web search calls usage details of the specific time bucket.

        • num_model_requests: int

          The count of model requests.

        • num_requests: int

          The count of web search calls.

        • object: Literal["organization.usage.web_searches.result"]

          • "organization.usage.web_searches.result"

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API key ID of the grouped usage result.

        • context_level: Optional[str]

          When group_by=context_level, this field provides the search context size of the grouped usage result.

        • model: Optional[str]

          When group_by=model, this field provides the model name of the grouped usage result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped usage result.

        • user_id: Optional[str]

          When group_by=user_id, this field provides the user ID of the grouped usage result.

      • class DataResultOrganizationCostsResult: …

        The aggregated costs details of the specific time bucket.

        • object: Literal["organization.costs.result"]

          • "organization.costs.result"

        • amount: Optional[DataResultOrganizationCostsResultAmount]

          The monetary value in its associated currency.

          • currency: Optional[str]

            Lowercase ISO-4217 currency e.g. "usd"

          • value: Optional[float]

            The numeric value of the cost.

        • api_key_id: Optional[str]

          When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.

        • line_item: Optional[str]

          When group_by=line_item, this field provides the line item of the grouped costs result.

        • project_id: Optional[str]

          When group_by=project_id, this field provides the project ID of the grouped costs result.

        • quantity: Optional[float]

          When group_by=line_item, this field provides the quantity of the grouped costs result.

    • start_time: int

  • has_more: bool

  • next_page: Optional[str]

  • object: Literal["page"]

    • "page"