Admin
AdminOrganization
AdminOrganizationAudit Logs
List user actions and configuration changes within this organization.
List audit logs
ModelsExpand Collapse
AuditLogListResponse object { id, effective_at, type, 49 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 48 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.created": optional object { id, permissions, resource_id, 2 more } The details for events with this type.
The details for events with this type.
"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.
AdminOrganizationAdmin API Keys
List all organization and project API keys.
Create admin API key
Retrieve admin API key
Delete admin API key
ModelsExpand Collapse
AdminAPIKey object { id, created_at, object, 4 more } Represents an individual Admin API key in an org.
Represents an individual Admin API key in an org.
AdminOrganizationUsage
Audio speeches
Audio transcriptions
Code interpreter sessions
Completions
Embeddings
Images
Moderations
Vector stores
Costs
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, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 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 text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.
The aggregated number of text output tokens used. For customers subscribe 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 audio input tokens used, including cached tokens.
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.
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.
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, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 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 text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.
The aggregated number of text output tokens used. For customers subscribe 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 audio input tokens used, including cached tokens.
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.
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.
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, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 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 text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.
The aggregated number of text output tokens used. For customers subscribe 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 audio input tokens used, including cached tokens.
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.
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.
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, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 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 text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.
The aggregated number of text output tokens used. For customers subscribe 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 audio input tokens used, including cached tokens.
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.
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.
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, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 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 text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.
The aggregated number of text output tokens used. For customers subscribe 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 audio input tokens used, including cached tokens.
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.
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.
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, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 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 text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.
The aggregated number of text output tokens used. For customers subscribe 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 audio input tokens used, including cached tokens.
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.
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.
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, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 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 text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.
The aggregated number of text output tokens used. For customers subscribe 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 audio input tokens used, including cached tokens.
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.
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.
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, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 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 text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.
The aggregated number of text output tokens used. For customers subscribe 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 audio input tokens used, including cached tokens.
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.
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.
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, 10 more } or object { input_tokens, num_model_requests, object, 4 more } or object { input_tokens, num_model_requests, object, 4 more } or 6 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 10 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 text input tokens used, including cached tokens. For customers subscribe to scale tier, this includes scale tier tokens.
The aggregated number of text output tokens used. For customers subscribe 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 audio input tokens used, including cached tokens.
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.
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.
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.
AdminOrganizationInvites
List invites
Create invite
Retrieve invite
Delete 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.
AdminOrganizationUsers
List users
Retrieve user
Modify user
Delete 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.
AdminOrganizationUsersRoles
List user organization role assignments
Assign organization role to user
Unassign organization role from user
ModelsExpand Collapse
AdminOrganizationGroups
List groups
Create group
Update group
Delete group
ModelsExpand Collapse
AdminOrganizationGroupsUsers
List group users
Add group user
Remove group user
ModelsExpand Collapse
AdminOrganizationGroupsRoles
List group organization role assignments
Assign organization role to group
Unassign organization role from group
ModelsExpand Collapse
AdminOrganizationRoles
List organization roles
Create organization role
Update organization role
Delete organization role
AdminOrganizationCertificates
List organization certificates
Upload certificate
Get certificate
Modify certificate
Delete certificate
Activate certificates for organization
Deactivate certificates for organization
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.
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.
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.
AdminOrganizationProjects
List projects
Create project
Retrieve project
Modify project
Archive project
AdminOrganizationProjectsUsers
List project users
Create project user
Retrieve project user
Modify project user
Delete project user
AdminOrganizationProjectsUsersRoles
List project user role assignments
Assign project role to user
Unassign project role from user
ModelsExpand Collapse
AdminOrganizationProjectsService Accounts
List project service accounts
Create project service account
Retrieve project service account
Delete 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.
AdminOrganizationProjectsAPI Keys
List project API keys
Retrieve project API key
Delete project API key
ModelsExpand Collapse
ProjectAPIKey object { id, created_at, last_used_at, 4 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 }
AdminOrganizationProjectsRate 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.
AdminOrganizationProjectsGroups
List project groups
Add project group
Remove project group
AdminOrganizationProjectsGroupsRoles
List project group role assignments
Assign project role to group
Unassign project role from group
ModelsExpand Collapse
AdminOrganizationProjectsRoles
List project roles
Create project role
Update project role
Delete project role
AdminOrganizationProjectsCertificates
List project certificates
Activate certificates for project
Deactivate certificates for project
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.