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

# The caller's current budget status (effective cap + spend this cycle)



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/budget
openapi: 3.1.0
info:
  description: >-
    The /api/v1 REST mirror of the 3ngram memory core
    (docs/concepts/architecture.mdx: one core, N transports). Authenticate with
    an X-API-Key header or a session Bearer token.
  title: 3ngram REST API
  version: v1
servers:
  - description: 3ngram platform
    url: https://api.3ngram.ai
security:
  - apiKey: []
  - sessionBearer: []
paths:
  /api/v1/budget:
    get:
      summary: The caller's current budget status (effective cap + spend this cycle)
      operationId: getBudget
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  capUsdOverride:
                    anyOf:
                      - type: number
                      - type: 'null'
                  consumedUsd:
                    type: number
                  effectiveCapUsd:
                    type: number
                  periodEnd:
                    anyOf:
                      - type: string
                      - type: 'null'
                  periodStart:
                    anyOf:
                      - type: string
                      - type: 'null'
                required:
                  - effectiveCapUsd
                  - consumedUsd
                  - capUsdOverride
                  - periodStart
                  - periodEnd
                type: object
          description: Success
components:
  securitySchemes:
    apiKey:
      in: header
      name: X-API-Key
      type: apiKey
    sessionBearer:
      scheme: bearer
      type: http

````