Query parameters

• start_time integer Required

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

• end_time integer

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

• bucket_width string

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

  Values are 1m, 1h, or 1d. Default value is 1d.

• sources array[string]

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

  Values are image.generation, image.edit, or image.variation.

• sizes array[string]

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

  Values are 256x256, 512x512, 1024x1024, 1792x1792, or 1024x1792.

• project_ids array[string]

  Return only usage for these projects.

• user_ids array[string]

  Return only usage for these users.

• api_key_ids array[string]

  Return only usage for these API keys.

• models array[string]

  Return only usage for these models.

• group_by array[string]

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

  Values are project_id, user_id, api_key_id, model, size, or source.

• limit integer

  Specifies the number of buckets to return.

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

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

Responses

• 200 application/json

  Usage data retrieved successfully.

  Hide response attributes Show response attributes object

  • object string Required

    Value is page.

  • data array[object] Required
    Hide data attributes Show data attributes object

    • object string Required

      Value is bucket.

    • start_time integer Required
    • end_time integer Required
    • result array[object] Required
      One of:

      UsageCompletionsResult object UsageEmbeddingsResult object UsageModerationsResult object UsageImagesResult object UsageAudioSpeechesResult object UsageAudioTranscriptionsResult object UsageVectorStoresResult object UsageCodeInterpreterSessionsResult object CostsResult object

      The aggregated completions usage details of the specific time bucket.

      Hide attributes Show attributes

      • object string Required

        Value is organization.usage.completions.result.

      • input_tokens integer Required

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

      • input_cached_tokens integer

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

      • output_tokens integer Required

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

      • input_audio_tokens integer

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

      • output_audio_tokens integer

        The aggregated number of audio output tokens used.

      • num_model_requests integer Required

        The count of requests made to the model.

      • project_id string | null

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

      • user_id string | null

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

      • api_key_id string | null

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

      • model string | null

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

      • batch boolean | null

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

      The aggregated embeddings usage details of the specific time bucket.

      Hide attributes Show attributes

      • object string Required

        Value is organization.usage.embeddings.result.

      • input_tokens integer Required

        The aggregated number of input tokens used.

      • num_model_requests integer Required

        The count of requests made to the model.

      • project_id string | null

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

      • user_id string | null

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

      • api_key_id string | null

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

      • model string | null

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

      The aggregated moderations usage details of the specific time bucket.

      Hide attributes Show attributes

      • object string Required

        Value is organization.usage.moderations.result.

      • input_tokens integer Required

        The aggregated number of input tokens used.

      • num_model_requests integer Required

        The count of requests made to the model.

      • project_id string | null

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

      • user_id string | null

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

      • api_key_id string | null

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

      • model string | null

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

      The aggregated images usage details of the specific time bucket.

      Hide attributes Show attributes

      • object string Required

        Value is organization.usage.images.result.

      • images integer Required

        The number of images processed.

      • num_model_requests integer Required

        The count of requests made to the model.

      • source string | null

        When group_by=source, this field provides the source of the grouped usage result, possible values are image.generation, image.edit, image.variation.

      • size string | null

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

      • project_id string | null

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

      • user_id string | null

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

      • api_key_id string | null

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

      • model string | null

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

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

      Hide attributes Show attributes

      • object string Required

        Value is organization.usage.audio_speeches.result.

      • characters integer Required

        The number of characters processed.

      • num_model_requests integer Required

        The count of requests made to the model.

      • project_id string | null

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

      • user_id string | null

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

      • api_key_id string | null

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

      • model string | null

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

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

      Hide attributes Show attributes

      • object string Required

        Value is organization.usage.audio_transcriptions.result.

      • seconds integer Required

        The number of seconds processed.

      • num_model_requests integer Required

        The count of requests made to the model.

      • project_id string | null

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

      • user_id string | null

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

      • api_key_id string | null

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

      • model string | null

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

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

      Hide attributes Show attributes

      • object string Required

        Value is organization.usage.vector_stores.result.

      • usage_bytes integer Required

        The vector stores usage in bytes.

      • project_id string | null

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

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

      Hide attributes Show attributes

      • object string Required

        Value is organization.usage.code_interpreter_sessions.result.

      • num_sessions integer

        The number of code interpreter sessions.

      • project_id string | null

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

      The aggregated costs details of the specific time bucket.

      Hide attributes Show attributes

      • object string Required

        Value is organization.costs.result.

      • amount object

        The monetary value in its associated currency.

        Hide amount attributes Show amount attributes object

        • value number

          The numeric value of the cost.

        • currency string

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

      • line_item string | null

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

      • project_id string | null

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

  • has_more boolean Required
  • next_page string Required