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

# Return the current billing cycle usage summary visible to the caller

> A developer credential sees only its engineer's own usage
(`scope: user`); every other caller sees the org's
(`scope: organization`).



## OpenAPI

````yaml /openapi/v1.json get /usage
openapi: 3.1.2
info:
  title: HASP AI API
  version: '2026-07-12'
  description: >-
    The HASP Public AI API is the regulated-AI substrate for healthcare and
    other

    regulated industries — identity, policy, audit, compliance, and PHI handling

    for AI inference, exposed via two surfaces:


    - **Native (`/v1/ai/*`)**: HASP-native chat with full event taxonomy, run
    lifecycle,
      and PHI metadata.
    - **Anthropic-compat (`/v1/messages`)**: Drop-in replacement for
    `@anthropic-ai/sdk` —
      change only `baseURL`. All Gateway compliance checks (BAA, credits, PHI policy) apply.

    All requests require an API key (`Authorization: Bearer
    hasp_api_live_<key>`). See

    [Authentication](https://docs.usehasp.com/ai-api/authentication) for key
    management.
servers:
  - url: https://api.usehasp.com/v1
    description: Production
security:
  - http: []
paths:
  /usage:
    get:
      tags:
        - Usage
      summary: Return the current billing cycle usage summary visible to the caller
      description: |-
        A developer credential sees only its engineer's own usage
        (`scope: user`); every other caller sees the org's
        (`scope: organization`).
      operationId: v1.control.usage
      responses:
        '200':
          description: >-
            The current billing cycle usage summary visible to the caller;
            `scope` says whose usage it is.
          content:
            application/json:
              schema:
                type: object
                examples:
                  - success: true
                    data:
                      object: usage
                      scope: organization
                      period:
                        start: '2026-07-01T00:00:00Z'
                        end: null
                      credits:
                        allotment: 50000
                        used: 12340
                        remaining: 37660
                        overage_purchased: 0
                        overage_consumed: 0
                      requests:
                        total: 486
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items: {}
                required:
                  - success
                  - data
        '401':
          description: Bearer token is missing, malformed, or revoked.
          content:
            application/json:
              schema:
                type: object
                examples:
                  - success: false
                    error:
                      type: authentication
                      code: INVALID_API_KEY
                      message: Bearer token is missing, malformed, or revoked.
                      param: null
                      details: null
                      retryable: false
                      request_id: 01JQREQ7XZQK5N6PZ1VVXHYB8T
                    meta:
                      request_id: 01JQREQ7XZQK5N6PZ1VVXHYB8T
        '403':
          description: >-
            The caller is authenticated but lacks the scope or capability this
            route requires.
          content:
            application/json:
              schema:
                type: object
                examples:
                  - success: false
                    error:
                      type: permission
                      code: MISSING_SCOPE
                      message: >-
                        The caller is authenticated but lacks the scope or
                        capability this route requires.
                      param: null
                      details: null
                      retryable: false
                      request_id: 01JQREQ7XZQK5N6PZ1VVXHYB8T
                    meta:
                      request_id: 01JQREQ7XZQK5N6PZ1VVXHYB8T
components:
  securitySchemes:
    http:
      type: http
      scheme: bearer

````

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