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

# Get current-period usage

> Retrieve workspace usage, quota, and billing-period information.

Check `quota_enabled` before interpreting quota values. USD amounts and pricing can be null when billing is not configured. Treat quota and currency fields as account-specific values, not a published price list.


## OpenAPI

````yaml GET /api/v1/organizations/usage/current-period
openapi: 3.1.0
info:
  title: Bandwidth Agent Builder API
  version: v1
  description: >-
    Manage agents, place calls, and retrieve conversation results in your
    workspace.
servers:
  - url: https://agents.labs.bandwidth.com
    description: Workspace API
security: []
paths:
  /api/v1/organizations/usage/current-period:
    get:
      tags:
        - usage
      summary: Get current-period usage
      description: >-
        **Authorization:** Accepts a Labs OAuth bearer token or a Labs API key.
        Workspace-scoped resources require membership in the requested
        workspace.


        Retrieve workspace usage, quota, and billing-period information.
      operationId: get_current_period_usage_api_v1_organizations_usage_current_period_get
      parameters:
        - description: >-
            Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace
            ID to access. The key owner must be a current member. Missing or
            invalid IDs return 400; non-member workspaces return 403. Not
            required for bearer authentication, which uses the user's selected
            workspace.
          in: header
          name: X-VOAI-ORGANIZATION-ID
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Required with X-BW-LABS-AGENTS-API-KEY: the positive local
              workspace ID to access. The key owner must be a current member.
              Missing or invalid IDs return 400; non-member workspaces return
              403. Not required for bearer authentication, which uses the user's
              selected workspace.
            title: X-Voai-Organization-Id
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrentUsageResponse'
          description: Successful Response
        '400':
          description: Invalid request or missing/invalid workspace header with an API key.
        '401':
          description: Missing, invalid, or expired credential.
        '403':
          description: >-
            The account lacks access to the workspace, resource, or required
            role.
        '404':
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - LabsAuth: []
        - LabsApiKey: []
components:
  schemas:
    CurrentUsageResponse:
      properties:
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        next_refresh_date:
          title: Next Refresh Date
          type: string
        percentage_used:
          title: Percentage Used
          type: number
        period_end:
          title: Period End
          type: string
        period_start:
          title: Period Start
          type: string
        price_per_second_usd:
          anyOf:
            - type: number
            - type: 'null'
          title: Price Per Second Usd
        quota_amount_usd:
          anyOf:
            - type: number
            - type: 'null'
          title: Quota Amount Usd
        quota_enabled:
          title: Quota Enabled
          type: boolean
        quota_voai_tokens:
          title: Token Quota
          type: integer
        total_duration_seconds:
          title: Total Duration Seconds
          type: integer
        used_amount_usd:
          anyOf:
            - type: number
            - type: 'null'
          title: Used Amount Usd
        used_voai_tokens:
          title: Used Tokens
          type: number
      required:
        - period_start
        - period_end
        - used_voai_tokens
        - quota_voai_tokens
        - percentage_used
        - next_refresh_date
        - quota_enabled
        - total_duration_seconds
      title: CurrentUsageResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    LabsAuth:
      description: >-
        Bandwidth Labs OAuth access token. Uses the user's selected workspace;
        the workspace header is not required. Do not also send an API key.
        Bearer-only operations may additionally require the Labs `super_user`
        role.
      scheme: bearer
      type: http
    LabsApiKey:
      description: >-
        Bandwidth Labs API key. Also send `X-VOAI-ORGANIZATION-ID` with a
        positive local workspace ID belonging to the key owner. Access follows
        the owner's current workspace role. Do not also send a bearer token. API
        keys cannot access bearer-only or Labs `super_user` operations.
      in: header
      name: X-BW-LABS-AGENTS-API-KEY
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.