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

# The token budgets that limit the caller

> The caller's own budget and those of the teams (realm roles) they
hold. Empty when nothing limits them.



## OpenAPI

````yaml get /api/airouter/budgets/me
openapi: 3.1.0
info:
  title: Nx1 AI API
  description: |

    AI API for Nx1 Data Platform Management and Automated Data Tasks.

    Authentication is required via PSK in Authorization header.

    Default PSK is | [ask a friend] |
  version: 0.10.2
servers: []
security: []
paths:
  /api/airouter/budgets/me:
    get:
      tags:
        - AI Router
      summary: The token budgets that limit the caller
      description: |-
        The caller's own budget and those of the teams (realm roles) they
        hold. Empty when nothing limits them.
      operationId: my_budgets_api_airouter_budgets_me_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MyBudgetsResponse'
      security:
        - OAuth2AuthorizationCodeBearer: []
        - APIKeyHeader: []
components:
  schemas:
    MyBudgetsResponse:
      properties:
        budgets:
          items:
            $ref: '#/components/schemas/TokenBudget'
          type: array
          title: Budgets
        timezone:
          type: string
          title: Timezone
          default: UTC
        usage_available:
          type: boolean
          title: Usage Available
          description: False when the counters couldn't be read; usage shows 0.
          default: true
        user:
          type: string
          title: User
      type: object
      required:
        - user
      title: MyBudgetsResponse
      description: 'The budgets that limit one caller: their own, then their teams''.'
    TokenBudget:
      properties:
        id:
          type: string
          title: Id
        scope:
          type: string
          enum:
            - user
            - team
          title: Scope
        subject:
          type: string
          title: Subject
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        action:
          type: string
          enum:
            - block
            - warn
          title: Action
          default: block
        enabled:
          type: boolean
          title: Enabled
          default: true
        periods:
          additionalProperties:
            $ref: '#/components/schemas/PeriodUsage'
          propertyNames:
            enum:
              - daily
              - weekly
              - monthly
          type: object
          title: Periods
        active_members:
          anyOf:
            - type: integer
            - type: 'null'
          title: Active Members
        top_members:
          anyOf:
            - items:
                $ref: '#/components/schemas/MemberUsage'
              type: array
            - type: 'null'
          title: Top Members
        updated_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated By
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
        - scope
        - subject
        - periods
      title: TokenBudget
    PeriodUsage:
      properties:
        limit:
          anyOf:
            - type: integer
            - type: 'null'
          title: Limit
        used:
          type: integer
          title: Used
          default: 0
        resets_at:
          type: string
          format: date-time
          title: Resets At
      type: object
      required:
        - resets_at
      title: PeriodUsage
    MemberUsage:
      properties:
        user:
          type: string
          title: User
        tokens:
          type: integer
          title: Tokens
      type: object
      required:
        - user
        - tokens
      title: MemberUsage
  securitySchemes:
    OAuth2AuthorizationCodeBearer:
      type: oauth2
      flows:
        authorizationCode:
          scopes: {}
          authorizationUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/auth
          tokenUrl: >-
            https://sso-rapid.rapid.nx1cloud.com/realms/rapid/protocol/openid-connect/token
    APIKeyHeader:
      type: apiKey
      in: header
      name: Authorization-PSK

````

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