Organization
OrganizationAudit Logs
List user actions and configuration changes within this organization.
List audit logs
ModelsExpand Collapse
class AuditLogListResponse: …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: Literal["api_key.created", "api_key.updated", "api_key.deleted", 48 more]The event type.
The event type.
actor: Optional[Actor]The actor who performed the audit logged action.
The actor who performed the audit logged action.
api_key: Optional[ActorAPIKey]The API Key used to perform the audit logged action.
The API Key used to perform the audit logged action.
checkpoint_permission_created: Optional[CheckpointPermissionCreated]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.
checkpoint_permission_deleted: Optional[CheckpointPermissionDeleted]The details for events with this type.
The details for events with this type.
ip_allowlist_config_activated: Optional[IPAllowlistConfigActivated]The details for events with this type.
The details for events with this type.
ip_allowlist_config_deactivated: Optional[IPAllowlistConfigDeactivated]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.
This event has no additional fields beyond the standard audit log attributes.
organization_updated: Optional[OrganizationUpdated]The details for events with this type.
The details for events with this type.
changes_requested: Optional[OrganizationUpdatedChangesRequested]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[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.
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[RateLimitUpdated]The details for events with this type.
The details for events with this type.
changes_requested: Optional[RateLimitUpdatedChangesRequested]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_updated: Optional[RoleUpdated]The details for events with this type.
The details for events with this type.
OrganizationAdmin API Keys
List all organization and project API keys.
Create admin API key
Retrieve admin API key
Delete admin API key
ModelsExpand Collapse
OrganizationUsage
Audio speeches
Audio transcriptions
Code interpreter sessions
Completions
Embeddings
Images
Moderations
Vector stores
Costs
ModelsExpand Collapse
class UsageAudioSpeechesResponse: …
data: List[Data]
results: List[DataResult]
class DataResultOrganizationUsageCompletionsResult: …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.
class DataResultOrganizationUsageEmbeddingsResult: …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.
class DataResultOrganizationUsageModerationsResult: …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.
class DataResultOrganizationUsageImagesResult: …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.
class DataResultOrganizationUsageAudioSpeechesResult: …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.
class DataResultOrganizationUsageAudioTranscriptionsResult: …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.
class DataResultOrganizationUsageVectorStoresResult: …The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
class DataResultOrganizationUsageCodeInterpreterSessionsResult: …The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
class DataResultOrganizationCostsResult: …The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
amount: Optional[DataResultOrganizationCostsResultAmount]The monetary value in its associated currency.
The monetary value in its associated currency.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
class UsageAudioTranscriptionsResponse: …
data: List[Data]
results: List[DataResult]
class DataResultOrganizationUsageCompletionsResult: …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.
class DataResultOrganizationUsageEmbeddingsResult: …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.
class DataResultOrganizationUsageModerationsResult: …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.
class DataResultOrganizationUsageImagesResult: …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.
class DataResultOrganizationUsageAudioSpeechesResult: …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.
class DataResultOrganizationUsageAudioTranscriptionsResult: …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.
class DataResultOrganizationUsageVectorStoresResult: …The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
class DataResultOrganizationUsageCodeInterpreterSessionsResult: …The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
class DataResultOrganizationCostsResult: …The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
amount: Optional[DataResultOrganizationCostsResultAmount]The monetary value in its associated currency.
The monetary value in its associated currency.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
class UsageCodeInterpreterSessionsResponse: …
data: List[Data]
results: List[DataResult]
class DataResultOrganizationUsageCompletionsResult: …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.
class DataResultOrganizationUsageEmbeddingsResult: …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.
class DataResultOrganizationUsageModerationsResult: …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.
class DataResultOrganizationUsageImagesResult: …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.
class DataResultOrganizationUsageAudioSpeechesResult: …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.
class DataResultOrganizationUsageAudioTranscriptionsResult: …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.
class DataResultOrganizationUsageVectorStoresResult: …The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
class DataResultOrganizationUsageCodeInterpreterSessionsResult: …The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
class DataResultOrganizationCostsResult: …The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
amount: Optional[DataResultOrganizationCostsResultAmount]The monetary value in its associated currency.
The monetary value in its associated currency.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
class UsageCompletionsResponse: …
data: List[Data]
results: List[DataResult]
class DataResultOrganizationUsageCompletionsResult: …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.
class DataResultOrganizationUsageEmbeddingsResult: …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.
class DataResultOrganizationUsageModerationsResult: …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.
class DataResultOrganizationUsageImagesResult: …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.
class DataResultOrganizationUsageAudioSpeechesResult: …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.
class DataResultOrganizationUsageAudioTranscriptionsResult: …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.
class DataResultOrganizationUsageVectorStoresResult: …The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
class DataResultOrganizationUsageCodeInterpreterSessionsResult: …The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
class DataResultOrganizationCostsResult: …The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
amount: Optional[DataResultOrganizationCostsResultAmount]The monetary value in its associated currency.
The monetary value in its associated currency.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
class UsageEmbeddingsResponse: …
data: List[Data]
results: List[DataResult]
class DataResultOrganizationUsageCompletionsResult: …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.
class DataResultOrganizationUsageEmbeddingsResult: …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.
class DataResultOrganizationUsageModerationsResult: …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.
class DataResultOrganizationUsageImagesResult: …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.
class DataResultOrganizationUsageAudioSpeechesResult: …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.
class DataResultOrganizationUsageAudioTranscriptionsResult: …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.
class DataResultOrganizationUsageVectorStoresResult: …The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
class DataResultOrganizationUsageCodeInterpreterSessionsResult: …The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
class DataResultOrganizationCostsResult: …The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
amount: Optional[DataResultOrganizationCostsResultAmount]The monetary value in its associated currency.
The monetary value in its associated currency.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
class UsageImagesResponse: …
data: List[Data]
results: List[DataResult]
class DataResultOrganizationUsageCompletionsResult: …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.
class DataResultOrganizationUsageEmbeddingsResult: …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.
class DataResultOrganizationUsageModerationsResult: …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.
class DataResultOrganizationUsageImagesResult: …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.
class DataResultOrganizationUsageAudioSpeechesResult: …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.
class DataResultOrganizationUsageAudioTranscriptionsResult: …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.
class DataResultOrganizationUsageVectorStoresResult: …The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
class DataResultOrganizationUsageCodeInterpreterSessionsResult: …The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
class DataResultOrganizationCostsResult: …The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
amount: Optional[DataResultOrganizationCostsResultAmount]The monetary value in its associated currency.
The monetary value in its associated currency.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
class UsageModerationsResponse: …
data: List[Data]
results: List[DataResult]
class DataResultOrganizationUsageCompletionsResult: …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.
class DataResultOrganizationUsageEmbeddingsResult: …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.
class DataResultOrganizationUsageModerationsResult: …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.
class DataResultOrganizationUsageImagesResult: …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.
class DataResultOrganizationUsageAudioSpeechesResult: …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.
class DataResultOrganizationUsageAudioTranscriptionsResult: …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.
class DataResultOrganizationUsageVectorStoresResult: …The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
class DataResultOrganizationUsageCodeInterpreterSessionsResult: …The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
class DataResultOrganizationCostsResult: …The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
amount: Optional[DataResultOrganizationCostsResultAmount]The monetary value in its associated currency.
The monetary value in its associated currency.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
class UsageVectorStoresResponse: …
data: List[Data]
results: List[DataResult]
class DataResultOrganizationUsageCompletionsResult: …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.
class DataResultOrganizationUsageEmbeddingsResult: …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.
class DataResultOrganizationUsageModerationsResult: …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.
class DataResultOrganizationUsageImagesResult: …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.
class DataResultOrganizationUsageAudioSpeechesResult: …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.
class DataResultOrganizationUsageAudioTranscriptionsResult: …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.
class DataResultOrganizationUsageVectorStoresResult: …The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
class DataResultOrganizationUsageCodeInterpreterSessionsResult: …The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
class DataResultOrganizationCostsResult: …The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
amount: Optional[DataResultOrganizationCostsResultAmount]The monetary value in its associated currency.
The monetary value in its associated currency.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
class UsageCostsResponse: …
data: List[Data]
results: List[DataResult]
class DataResultOrganizationUsageCompletionsResult: …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.
class DataResultOrganizationUsageEmbeddingsResult: …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.
class DataResultOrganizationUsageModerationsResult: …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.
class DataResultOrganizationUsageImagesResult: …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.
class DataResultOrganizationUsageAudioSpeechesResult: …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.
class DataResultOrganizationUsageAudioTranscriptionsResult: …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.
class DataResultOrganizationUsageVectorStoresResult: …The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
class DataResultOrganizationUsageCodeInterpreterSessionsResult: …The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
class DataResultOrganizationCostsResult: …The aggregated costs details of the specific time bucket.
The aggregated costs details of the specific time bucket.
amount: Optional[DataResultOrganizationCostsResultAmount]The monetary value in its associated currency.
The monetary value in its associated currency.
When group_by=api_key_id, this field provides the API Key ID of the grouped costs result.
OrganizationInvites
List invites
Create invite
Retrieve invite
Delete invite
ModelsExpand Collapse
class Invite: …Represents an individual invite to the organization.
Represents an individual invite to the organization.
OrganizationUsers
List users
Retrieve user
Modify user
Delete user
ModelsExpand Collapse
class OrganizationUser: …Represents an individual user within an organization.
Represents an individual user within an organization.
OrganizationUsersRoles
List user organization role assignments
Assign organization role to user
Unassign organization role from user
ModelsExpand Collapse
OrganizationGroups
List groups
Create group
Update group
Delete group
OrganizationGroupsUsers
List group users
Add group user
Remove group user
ModelsExpand Collapse
OrganizationGroupsRoles
List group organization role assignments
Assign organization role to group
Unassign organization role from group
ModelsExpand Collapse
OrganizationRoles
List organization roles
Create organization role
Update organization role
Delete organization role
OrganizationCertificates
List organization certificates
Upload certificate
Get certificate
Modify certificate
Delete certificate
Activate certificates for organization
Deactivate certificates for organization
ModelsExpand Collapse
class Certificate: …Represents an individual certificate uploaded to the organization.
Represents an individual certificate uploaded to the organization.
object: Literal["certificate", "organization.certificate", "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.
OrganizationProjects
List projects
Create project
Retrieve project
Modify project
Archive project
OrganizationProjectsUsers
List project users
Create project user
Retrieve project user
Modify project user
Delete project user
OrganizationProjectsUsersRoles
List project user role assignments
Assign project role to user
Unassign project role from user
ModelsExpand Collapse
OrganizationProjectsService Accounts
List project service accounts
Create project service account
Retrieve project service account
Delete project service account
ModelsExpand Collapse
class ProjectServiceAccount: …Represents an individual service account in a project.
Represents an individual service account in a project.
OrganizationProjectsAPI Keys
List project API keys
Retrieve project API key
Delete project API key
ModelsExpand Collapse
class ProjectAPIKey: …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.
The object type, which is always organization.project.api_key
OrganizationProjectsRate Limits
List project rate limits
Modify project rate limit
ModelsExpand Collapse
class ProjectRateLimit: …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.