Usage
Audio speeches
Audio transcriptions
Code interpreter sessions
Completions
Costs
Decisions
Embeddings
File search calls
Images
Moderations
Vector stores
Web search calls
Models
UsageAudioSpeechesResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } or OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } or OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache with a 12-hour retention period.
The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses.
The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 6 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.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=line_item, this field provides the line item of the grouped costs result.
When group_by=project_id, this field provides the project ID of the grouped costs result.
When group_by=line_item, this field provides the quantity 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 OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } or OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } or OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache with a 12-hour retention period.
The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses.
The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 6 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.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=line_item, this field provides the line item of the grouped costs result.
When group_by=project_id, this field provides the project ID of the grouped costs result.
When group_by=line_item, this field provides the quantity 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 OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } or OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } or OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache with a 12-hour retention period.
The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses.
The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 6 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.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=line_item, this field provides the line item of the grouped costs result.
When group_by=project_id, this field provides the project ID of the grouped costs result.
When group_by=line_item, this field provides the quantity 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 OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } or OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } or OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache with a 12-hour retention period.
The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses.
The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 6 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.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=line_item, this field provides the line item of the grouped costs result.
When group_by=project_id, this field provides the project ID of the grouped costs result.
When group_by=line_item, this field provides the quantity 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 OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } or OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } or OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache with a 12-hour retention period.
The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses.
The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 6 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.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=line_item, this field provides the line item of the grouped costs result.
When group_by=project_id, this field provides the project ID of the grouped costs result.
When group_by=line_item, this field provides the quantity of the grouped costs result.
UsageDecisionsResponse 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, 22 more }
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of uncached audio input tokens used.
The aggregated number of input tokens written to the cache with a 12-hour retention period.
The aggregated number of input tokens written to the cache with a 30-minute retention period.
The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods.
The aggregated number of cached audio input tokens used.
The aggregated number of cached image input tokens used.
The aggregated number of cached text input tokens used.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached image input tokens used.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
UsageEmbeddingsResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } or OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } or OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache with a 12-hour retention period.
The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses.
The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 6 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.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=line_item, this field provides the line item of the grouped costs result.
When group_by=project_id, this field provides the project ID of the grouped costs result.
When group_by=line_item, this field provides the quantity of the grouped costs result.
UsageFileSearchCallsResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } or OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } or OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache with a 12-hour retention period.
The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses.
The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 6 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.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=line_item, this field provides the line item of the grouped costs result.
When group_by=project_id, this field provides the project ID of the grouped costs result.
When group_by=line_item, this field provides the quantity 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 OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } or OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } or OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache with a 12-hour retention period.
The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses.
The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 6 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.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=line_item, this field provides the line item of the grouped costs result.
When group_by=project_id, this field provides the project ID of the grouped costs result.
When group_by=line_item, this field provides the quantity 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 OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } or OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } or OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache with a 12-hour retention period.
The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses.
The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 6 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.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=line_item, this field provides the line item of the grouped costs result.
When group_by=project_id, this field provides the project ID of the grouped costs result.
When group_by=line_item, this field provides the quantity 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 OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } or OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } or OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache with a 12-hour retention period.
The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses.
The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 6 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.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=line_item, this field provides the line item of the grouped costs result.
When group_by=project_id, this field provides the project ID of the grouped costs result.
When group_by=line_item, this field provides the quantity of the grouped costs result.
UsageWebSearchCallsResponse object { data, has_more, next_page, object }
data: array of object { end_time, object, results, start_time }
results: array of OrganizationUsageCompletionsResult { input_tokens, num_model_requests, object, 22 more } or OrganizationUsageEmbeddingsResult { input_tokens, num_model_requests, object, 4 more } or OrganizationUsageModerationsResult { input_tokens, num_model_requests, object, 4 more } or 8 more
OrganizationUsageCompletionsResult object { input_tokens, num_model_requests, object, 22 more } The aggregated completions usage details of the specific time bucket.
The aggregated completions usage details of the specific time bucket.
The aggregated number of input tokens used, including cached and cache-write tokens. This includes text, audio, and image tokens. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of output tokens used across text, audio, and image outputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=batch, this field tells whether the grouped usage result is batch or not.
The aggregated number of input tokens written to the cache with a 12-hour retention period.
The aggregated number of input tokens written to the cache with a 30-minute retention period. May be absent or null for older responses.
The aggregated number of input tokens written to the cache across 30-minute and 12-hour retention periods.
The aggregated number of cached input tokens used across text, audio, and image inputs. For customers subscribed to Scale Tier, this includes Scale Tier tokens.
The aggregated number of uncached text input tokens used, excluding cache-write tokens.
The aggregated number of uncached input tokens used across text, audio, and image inputs, excluding cache-write tokens.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageEmbeddingsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated embeddings usage details of the specific time bucket.
The aggregated embeddings usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageModerationsResult object { input_tokens, num_model_requests, object, 4 more } The aggregated moderations usage details of the specific time bucket.
The aggregated moderations usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageImagesResult object { images, num_model_requests, object, 6 more } The aggregated images usage details of the specific time bucket.
The aggregated images usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
When group_by=size, this field provides the image size of the grouped usage result.
OrganizationUsageAudioSpeechesResult object { characters, num_model_requests, object, 4 more } The aggregated audio speeches usage details of the specific time bucket.
The aggregated audio speeches usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageAudioTranscriptionsResult object { num_model_requests, object, seconds, 4 more } The aggregated audio transcriptions usage details of the specific time bucket.
The aggregated audio transcriptions usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationUsageVectorStoresResult object { object, usage_bytes, project_id } The aggregated vector stores usage details of the specific time bucket.
The aggregated vector stores usage details of the specific time bucket.
OrganizationUsageCodeInterpreterSessionsResult object { num_sessions, object, project_id } The aggregated code interpreter sessions usage details of the specific time bucket.
The aggregated code interpreter sessions usage details of the specific time bucket.
OrganizationUsageFileSearchesResult object { num_requests, object, api_key_id, 3 more } The aggregated file search calls usage details of the specific time bucket.
The aggregated file search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
When group_by=project_id, this field provides the project ID of the grouped usage result.
OrganizationUsageWebSearchesResult object { num_model_requests, num_requests, object, 6 more } The aggregated web search calls usage details of the specific time bucket.
The aggregated web search calls usage details of the specific time bucket.
When group_by=api_key_id, this field provides the API key ID of the grouped usage result.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=context_level, this field provides the search context size of the grouped usage result.
When group_by=model, this field provides the model name of the grouped usage result.
OrganizationCostsResult object { object, amount, api_key_id, 6 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.
api_source: optional "agents_api" or "unlabeled" or nullWhen grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When grouped by api_source, agents_api identifies attributed Agents API activity and unlabeled includes all records without published source attribution, including historical and unknown origins. Unlabeled does not imply direct API usage. Without source grouping, this field is null.
When group_by=line_item, this field provides the line item of the grouped costs result.
When group_by=project_id, this field provides the project ID of the grouped costs result.
When group_by=line_item, this field provides the quantity of the grouped costs result.