> ## Documentation Index
> Fetch the complete documentation index at: https://docs.breezeblue.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get usage metering

> Get aggregated usage with daily buckets and recent requests.



## OpenAPI

````yaml /openapi.json get /v1/usage
openapi: 3.1.0
info:
  title: Breeze Developer API
  description: >-
    Breeze Developer API for models, voices, text-to-speech, history, balance,
    usage, and browser-managed API keys.
  version: 1.0.0
servers:
  - url: https://api.breeze.blue
security: []
tags:
  - name: Models
    description: Supported TTS models.
  - name: Text to Speech
    description: Text-to-speech synthesis and instruction rewriting.
  - name: Voices
    description: Saved voices and voice settings.
  - name: Voice Previews
    description: Create, audition, and save temporary voice previews.
  - name: Account
    description: Balance, usage, and API keys.
  - name: History
    description: Generated audio history.
paths:
  /v1/usage:
    get:
      tags:
        - Account
      summary: Get usage metering
      description: Get aggregated usage with daily buckets and recent requests.
      operationId: account_usage_list
      parameters:
        - name: days
          in: query
          required: false
          schema:
            type: integer
            maximum: 90
            minimum: 1
            default: 30
            title: Days
          description: Window length in days (1–90).
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Search
          description: >-
            Keyword filter across endpoint, model, action code, key id, key
            name, and key prefix.
        - name: method
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Method
          description: Filter by HTTP method.
        - name: api_key_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Api Key Id
          description: Filter by public API key identifier (key_...).
        - name: status_class
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Status Class
          description: 'Filter by HTTP status class: 2xx, 4xx, 5xx, or other.'
        - name: client_type
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Client Type
          description: 'Filter by client type: api, sdk, or cli.'
        - name: from
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: From
          description: Inclusive start date (YYYY-MM-DD).
        - name: to
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: To
          description: Inclusive end date (YYYY-MM-DD).
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
          description: Page number for the request log.
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 20
            title: Page Size
          description: Rows per page.
      responses:
        '200':
          description: Aggregated usage.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
          headers:
            x-breeze-api-key-id:
              description: >-
                Public API key identifier used to authenticate the request, when
                an API key was used.
              schema:
                type: string
        '401':
          description: HTTP 401 error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: HTTP 422 error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '503':
          description: HTTP 503 error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: cURL
          label: cURL
          source: |-
            curl \
              --request GET \
              --url "https://api.breeze.blue/v1/usage" \
              --header "xi-api-key: $BREEZE_API_KEY"
        - lang: Python
          label: Python SDK
          source: >-
            import os


            from breeze_blue import BreezeBlue


            client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"])


            usage = client.account.usage(days=30, api_key_id="key_01hprod",
            client_type="sdk")


            print(usage["summary"])
        - lang: TypeScript
          label: TypeScript SDK
          source: |-
            import { BreezeBlueClient } from "@breeze.blue/sdk";

            const client = new BreezeBlueClient({
              apiKey: process.env.BREEZE_API_KEY!,
            });

            const usage = await client.account.usage({
              days: 30,
              apiKeyId: "key_01hprod",
              clientType: "sdk",
            });

            console.log(usage.summary);
components:
  schemas:
    UsageResponse:
      additionalProperties: true
      properties:
        window_days:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          title: Window Days
        summary:
          $ref: '#/components/schemas/UsageSummaryResponse'
        total:
          title: Total
          type: integer
        page:
          title: Page
          type: integer
        page_size:
          title: Page Size
          type: integer
        daily:
          items:
            $ref: '#/components/schemas/UsageDailyBucketResponse'
          title: Daily
          type: array
        items:
          items:
            $ref: '#/components/schemas/UsageItemResponse'
          title: Items
          type: array
      required:
        - summary
        - total
        - page
        - page_size
      title: UsageResponse
      type: object
    ErrorResponse:
      properties:
        ok:
          default: false
          title: Ok
          type: boolean
        code:
          title: Code
          type: string
        detail:
          title: Detail
          type: string
        error:
          title: Error
          type: string
        meta:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          title: Meta
      required:
        - code
        - detail
        - error
      title: ErrorResponse
      type: object
    ValidationErrorResponse:
      properties:
        ok:
          default: false
          title: Ok
          type: boolean
        code:
          title: Code
          type: string
        detail:
          title: Detail
          type: string
        error:
          title: Error
          type: string
        meta:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Meta
      required:
        - code
        - detail
        - error
      title: ValidationErrorResponse
      type: object
    UsageSummaryResponse:
      properties:
        request_count:
          default: 0
          title: Request Count
          type: integer
        total_text_characters:
          default: 0
          title: Total Text Characters
          type: integer
        total_billable_units:
          default: 0
          title: Total Billable Units
          type: integer
        total_cost:
          default: 0
          title: Total Cost
          type: number
        total_cost_millicredits:
          default: 0
          title: Total Cost Millicredits
          type: integer
      title: UsageSummaryResponse
      type: object
    UsageDailyBucketResponse:
      properties:
        date:
          title: Date
          type: string
        request_count:
          title: Request Count
          type: integer
      required:
        - date
        - request_count
      title: UsageDailyBucketResponse
      type: object
    UsageItemResponse:
      additionalProperties: true
      properties:
        id:
          title: Id
          type: string
        endpoint:
          title: Endpoint
          type: string
        method:
          title: Method
          type: string
        status:
          title: Status
          type: integer
        api_key_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Api Key Id
        api_key_name:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Api Key Name
        api_key_prefix:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Api Key Prefix
        model:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Model
        billable_units:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          title: Billable Units
        cost:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          title: Cost
        cost_millicredits:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          title: Cost Millicredits
        latency_ms:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Time to first audio for streaming audio requests, in milliseconds.
          title: Latency Ms
        duration_ms:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Generated audio duration, in milliseconds.
          title: Duration Ms
        first_audio_chunk_ms:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: >-
            Compatibility alias for streaming time to first audio, in
            milliseconds.
          title: First Audio Chunk Ms
        request_duration_ms:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          description: Developer API request duration, in milliseconds.
          title: Request Duration Ms
        trace_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Trace Id
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Request Id
        text_characters:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          title: Text Characters
        action_code:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Action Code
        client_type:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Client Type
        client_name:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Client Name
        client_version:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Client Version
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Created At
      required:
        - id
        - endpoint
        - method
        - status
      title: UsageItemResponse
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: xi-api-key
      description: Breeze Developer API key.

````