Organization
OrganizationAdmin API Keys
Create admin API key
Delete admin API key
List all organization and project API keys.
Retrieve admin API key
ModelsExpand Collapse
AdminAPIKey object { id, created_at, expires_at, 5 more } Represents an individual Admin API key in an org.
Represents an individual Admin API key in an org.
OrganizationAudit Logs
List user actions and configuration changes within this organization.
List audit logs
ModelsExpand Collapse
AuditLogListResponse object { id, effective_at, type, 57 more } A log of a user action or configuration change within this organization.
A log of a user action or configuration change within this organization.
type: "api_key.created" or "api_key.updated" or "api_key.deleted" or 140 moreThe event type.
The event type.
actor: optional object { api_key, session, type } The actor who performed the audit logged action.
The actor who performed the audit logged action.
api_key: optional object { id, service_account, type, user } The API Key used to perform the audit logged action.
The API Key used to perform the audit logged action.
"certificate.deleted": optional object { id, certificate, name } The details for events with this type.
The details for events with this type.
"checkpoint.permission.created": optional object { id, data } The project and fine-tuned model checkpoint that the checkpoint permission was created for.
The project and fine-tuned model checkpoint that the checkpoint permission was created for.
"ip_allowlist.config.deactivated": optional object { configs } The details for events with this type.
The details for events with this type.
"ip_allowlist.created": optional object { id, allowed_ips, name } The details for events with this type.
The details for events with this type.
"ip_allowlist.deleted": optional object { id, allowed_ips, name } The details for events with this type.
The details for events with this type.
"login.failed": optional object { error_code, error_message } The details for events with this type.
The details for events with this type.
This event has no additional fields beyond the standard audit log attributes.
"logout.failed": optional object { error_code, error_message } The details for events with this type.
The details for events with this type.
This event has no additional fields beyond the standard audit log attributes.
"organization.updated": optional object { id, changes_requested } The details for events with this type.
The details for events with this type.
changes_requested: optional object { api_call_logging, api_call_logging_project_ids, description, 4 more } The payload used to update the organization settings.
The payload used to update the organization settings.
How your organization logs data from supported API calls. One of disabled, enabled_per_call, enabled_for_all_projects, or enabled_for_selected_projects
The list of project ids if api_call_logging is set to enabled_for_selected_projects
project: optional object { id, name } The project that the action was scoped to. Absent for actions not scoped to projects. Note that any admin actions taken via Admin API keys are associated with the default project.
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.
"rate_limit.updated": optional object { id, changes_requested } The details for events with this type.
The details for events with this type.
changes_requested: optional object { batch_1_day_max_input_tokens, max_audio_megabytes_per_1_minute, max_images_per_1_minute, 3 more } The payload used to update the rate limits.
The payload used to update the rate limits.
The maximum batch input tokens per day. Only relevant for certain models.
The maximum audio megabytes per minute. Only relevant for certain models.
The maximum images per minute. Only relevant for certain models.
"role.assignment.created": optional object { id, principal_id, principal_type, 2 more } The details for events with this type.
The details for events with this type.
"role.assignment.deleted": optional object { id, principal_id, principal_type, 2 more } The details for events with this type.
The details for events with this type.
"role.bound_to_resource": optional object { id, connector_id, connector_name, 7 more } The details for events with this type.
The details for events with this type.
The ID of the resource the role was bound to. ChatGPT workspace connector resources use <workspace_id>__<connector_id>.
The connector display name for a ChatGPT workspace connector resource, or the connector ID when the display name could not be resolved.
"role.created": optional object { id, permissions, resource_id, 2 more } The details for events with this type.
The details for events with this type.
"role.unbound_from_resource": optional object { id, connector_id, connector_name, 7 more } The details for events with this type.
The details for events with this type.
The ID of the resource the role was unbound from. ChatGPT workspace connector resources use <workspace_id>__<connector_id>.
The connector display name for a ChatGPT workspace connector resource, or the connector ID when the display name could not be resolved.
"role.updated": optional object { id, changes_requested } The details for events with this type.
The details for events with this type.
"service_account.updated": optional object { id, changes_requested } The details for events with this type.
The details for events with this type.
"workload_identity_provider_mapping.created": optional object { id, data, identity_provider_id } The details for events with this type.
The details for events with this type.
"workload_identity_provider_mapping.deleted": optional object { id, identity_provider_id, project_id, service_account_id } The details for events with this type.
The details for events with this type.
"workload_identity_provider_mapping.updated": optional object { id, changes_requested, identity_provider_id } The details for events with this type.
The details for events with this type.
"workload_identity_provider.created": optional object { id, data } The details for events with this type.
The details for events with this type.
OrganizationCertificates
Activate certificates for organization
Upload certificate
Deactivate certificates for organization
Delete certificate
List organization certificates
Get certificate
Modify certificate
ModelsExpand Collapse
Certificate object { id, certificate_details, created_at, 3 more } Represents an individual certificate uploaded to the organization.
Represents an individual certificate uploaded to the organization.
The Unix timestamp (in seconds) of when the certificate was uploaded.
object: "certificate" or "organization.certificate" or "organization.project.certificate"The object type.
- If creating, updating, or getting a specific certificate, the object type is
certificate.
- If listing, activating, or deactivating certificates for the organization, the object type is
organization.certificate.
- If listing, activating, or deactivating certificates for a project, the object type is
organization.project.certificate.
The object type.
- If creating, updating, or getting a specific certificate, the object type is
certificate. - If listing, activating, or deactivating certificates for the organization, the object type is
organization.certificate. - If listing, activating, or deactivating certificates for a project, the object type is
organization.project.certificate.
CertificateActivateResponse object { id, active, certificate_details, 3 more } Represents an individual certificate configured at the organization level.
Represents an individual certificate configured at the organization level.
CertificateDeactivateResponse object { id, active, certificate_details, 3 more } Represents an individual certificate configured at the organization level.
Represents an individual certificate configured at the organization level.
CertificateListResponse object { id, active, certificate_details, 3 more } Represents an individual certificate configured at the organization level.
Represents an individual certificate configured at the organization level.
OrganizationData Retention
Retrieve organization data retention
Update organization data retention
ModelsExpand Collapse
OrganizationGroups
Create group
Delete group
List groups
Retrieve group
Update group
ModelsExpand Collapse
OrganizationGroupsRoles
Assign organization role to group
Unassign organization role from group
List group organization role assignments
Retrieve group organization role
ModelsExpand Collapse
RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more } Detailed information about a role assignment entry returned when listing assignments.
Detailed information about a role assignment entry returned when listing assignments.
OrganizationGroupsUsers
Add group user
Remove group user
List group users
Retrieve group user
OrganizationInvites
Create invite
Delete invite
List invites
Retrieve invite
ModelsExpand Collapse
Invite object { id, created_at, email, 6 more } Represents an individual invite to the organization.
Represents an individual invite to the organization.
OrganizationProjects
Archive project
Create project
List projects
Retrieve project
Modify project
OrganizationProjectsAPI Keys
Delete project API key
List project API keys
Retrieve project API key
ModelsExpand Collapse
ProjectAPIKey object { id, created_at, last_used_at, 5 more } Represents an individual API key in a project.
Represents an individual API key in a project.
The Unix timestamp (in seconds) of when the API key was last used.
owner: object { service_account, type, user }
OrganizationProjectsCertificates
Activate certificates for project
Deactivate certificates for project
List project certificates
ModelsExpand Collapse
CertificateActivateResponse object { id, active, certificate_details, 3 more } Represents an individual certificate configured at the project level.
Represents an individual certificate configured at the project level.
CertificateDeactivateResponse object { id, active, certificate_details, 3 more } Represents an individual certificate configured at the project level.
Represents an individual certificate configured at the project level.
OrganizationProjectsData Retention
Retrieve project data retention
Update project data retention
OrganizationProjectsGroups
Add project group
Remove project group
List project groups
Retrieve project group
OrganizationProjectsGroupsRoles
Assign project role to group
Unassign project role from group
List project group role assignments
Retrieve project group role
ModelsExpand Collapse
RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more } Detailed information about a role assignment entry returned when listing assignments.
Detailed information about a role assignment entry returned when listing assignments.
OrganizationProjectsHosted Tool Permissions
Retrieve project hosted tool permissions
Modify project hosted tool permissions
ModelsExpand Collapse
ProjectHostedToolPermissions object { code_interpreter, file_search, image_generation, 2 more } Represents hosted tool permissions for a project.
Represents hosted tool permissions for a project.
OrganizationProjectsModel Permissions
Delete project model permissions
Retrieve project model permissions
Modify project model permissions
ModelsExpand Collapse
OrganizationProjectsRate Limits
List project rate limits
Modify project rate limit
ModelsExpand Collapse
ProjectRateLimit object { id, max_requests_per_1_minute, max_tokens_per_1_minute, 6 more } Represents a project rate limit config.
Represents a project rate limit config.
The maximum batch input tokens per day. Only present for relevant models.
The maximum audio megabytes per minute. Only present for relevant models.
OrganizationProjectsRoles
Create project role
Delete project role
List project roles
Retrieve project role
Update project role
OrganizationProjectsService Accounts
Create project service account
Delete project service account
List project service accounts
Retrieve project service account
Update project service account
ModelsExpand Collapse
ProjectServiceAccount object { id, created_at, name, 2 more } Represents an individual service account in a project.
Represents an individual service account in a project.
OrganizationProjectsService AccountsAPI Keys
Create project service account API key
OrganizationProjectsSpend Alerts
Create project spend alert
Delete project spend alert
List project spend alerts
Retrieve project spend alert
Update project spend alert
OrganizationProjectsSpend Limit
Delete project spend limit
Retrieve project spend limit
Update project spend limit
ModelsExpand Collapse
ProjectSpendLimit object { currency, enforcement, interval, 2 more } Represents a hard spend limit configured at the project level.
Represents a hard spend limit configured at the project level.
OrganizationProjectsUsers
Create project user
Delete project user
List project users
Retrieve project user
Modify project user
OrganizationProjectsUsersRoles
Assign project role to user
Unassign project role from user
List project user role assignments
Retrieve project user role
ModelsExpand Collapse
RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more } Detailed information about a role assignment entry returned when listing assignments.
Detailed information about a role assignment entry returned when listing assignments.
OrganizationRoles
Create organization role
Delete organization role
List organization roles
Retrieve organization role
Update organization role
OrganizationSpend Alerts
Create organization spend alert
Delete organization spend alert
List organization spend alerts
Retrieve organization spend alert
Update organization spend alert
ModelsExpand Collapse
OrganizationSpend Limit
Delete organization spend limit
Retrieve organization spend limit
Update organization spend limit
ModelsExpand Collapse
OrganizationSpendLimit object { currency, enforcement, interval, 2 more } Represents a hard spend limit configured at the organization level.
Represents a hard spend limit configured at the organization level.
OrganizationUsage
Audio speeches
Audio transcriptions
Code interpreter sessions
Completions
Costs
Embeddings
File search calls
Images
Moderations
Vector stores
Web search calls
ModelsExpand Collapse
UsageAudioSpeechesResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 5 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 3 more } The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
When group_by=line_item, this field provides the line item of the grouped costs result.
UsageAudioTranscriptionsResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 5 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 3 more } The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
When group_by=line_item, this field provides the line item of the grouped costs result.
UsageCodeInterpreterSessionsResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 5 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 3 more } The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
When group_by=line_item, this field provides the line item of the grouped costs result.
UsageCompletionsResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 5 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 3 more } The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
When group_by=line_item, this field provides the line item of the grouped costs result.
UsageCostsResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 5 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 3 more } The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
When group_by=line_item, this field provides the line item of the grouped costs result.
UsageEmbeddingsResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 5 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 3 more } The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
When group_by=line_item, this field provides the line item of the grouped costs result.
UsageFileSearchCallsResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 5 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 3 more } The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
When group_by=line_item, this field provides the line item of the grouped costs result.
UsageImagesResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 5 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 3 more } The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
When group_by=line_item, this field provides the line item of the grouped costs result.
UsageModerationsResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 5 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 3 more } The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
When group_by=line_item, this field provides the line item of the grouped costs result.
UsageVectorStoresResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 5 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 3 more } The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
When group_by=line_item, this field provides the line item of the grouped costs result.
UsageWebSearchCallsResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of object { input_tokens, num_model_requests, object, 19 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 19 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 5 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 3 more } The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
When group_by=line_item, this field provides the line item of the grouped costs result.
OrganizationUsers
Delete user
List users
Retrieve user
Modify user
ModelsExpand Collapse
OrganizationUser object { id, added_at, object, 13 more } Represents an individual user within an organization.
Represents an individual user within an organization.
The Unix timestamp (in seconds) of the user’s last API key usage.
Whether the user is an authorized purchaser for Scale Tier.
OrganizationUsersRoles
Assign organization role to user
Unassign organization role from user
List user organization role assignments
Retrieve user organization role
ModelsExpand Collapse
RoleRetrieveResponse object { id, assignment_sources, created_at, 9 more } Detailed information about a role assignment entry returned when listing assignments.
Detailed information about a role assignment entry returned when listing assignments.