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

# GET /portal/api/quota



## OpenAPI

````yaml /generated/openapi.json get /portal/api/quota
openapi: 3.1.0
info:
  description: >-
    Forwarding, management, portal and OAuth APIs generated from Rust types.
    Input and output schemas preserve their respective Serde contracts.
    Streaming events and WebSocket messages are documented alongside HTTP
    payloads.
  title: GPROXY HTTP API
  version: 4.2.1
servers: []
security:
  - bearer: []
  - anthropicKey: []
  - googleKey: []
  - queryKey: []
paths:
  /portal/api/quota:
    get:
      tags:
        - Portal
      summary: GET /portal/api/quota
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Output_PortalQuotaWindowDto'
                type: array
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output_Envelope'
          description: Gateway error
      security:
        - consoleSession: []
        - bearer: []
        - anthropicKey: []
        - googleKey: []
components:
  schemas:
    Output_PortalQuotaWindowDto:
      description: >-
        One budget window of the caller's own chain.


        The owner is reported because a user has to be able to tell "I am out of
        my

        own allowance" from "my team is out of its allowance", which are two
        very

        different things to do something about. Every owner here is one the
        caller

        is themselves part of: the chain is built from their own key binding.
      properties:
        limit:
          type: string
        modelPattern:
          description: The glob this budget covers, absent when it covers everything.
          type:
            - string
            - 'null'
        ownerId:
          type: string
        ownerKind:
          description: '`api_key`, `user`, `team` or `org`.'
          type: string
        period:
          description: '`5h`, `1d`, `7d`, `1m`, `total`, …'
          type: string
        resetsAtMs:
          description: None for a permanent (`total`) window.
          format: int64
          type:
            - integer
            - 'null'
        startsAtMs:
          format: int64
          type: integer
        unit:
          description: '`USD` for a cost budget.'
          type: string
        used:
          type: string
        usedPercent:
          description: |-
            On the 0..100 scale, to two decimals. None when the limit is zero,
            which is a switched-off subject rather than a ratio.
          type:
            - string
            - 'null'
        windowKey:
          description: The budget's stable key within its owner, e.g. `primary`.
          type: string
      required:
        - ownerKind
        - ownerId
        - windowKey
        - period
        - modelPattern
        - unit
        - used
        - limit
        - usedPercent
        - startsAtMs
        - resetsAtMs
      type: object
    Output_Envelope:
      properties:
        error:
          $ref: '#/components/schemas/Output_EnvelopeBody'
      required:
        - error
      type: object
    Output_EnvelopeBody:
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      type: object
  securitySchemes:
    bearer:
      scheme: bearer
      type: http
    anthropicKey:
      in: header
      name: x-api-key
      type: apiKey
    googleKey:
      in: header
      name: x-goog-api-key
      type: apiKey
    queryKey:
      in: query
      name: key
      type: apiKey
    consoleSession:
      in: cookie
      name: gproxy_session
      type: apiKey

````

## Related topics

- [GET /portal/api/context](https://gproxy.leenhawk.com/api-reference/portal/get-portalapicontext.md)
- [GET /portal/api/keys](https://gproxy.leenhawk.com/api-reference/portal/get-portalapikeys.md)
- [GET /portal/api/models](https://gproxy.leenhawk.com/api-reference/portal/get-portalapimodels.md)
- [GET /portal/api/requests](https://gproxy.leenhawk.com/api-reference/portal/get-portalapirequests.md)
- [GET /portal/api/sessions](https://gproxy.leenhawk.com/api-reference/portal/get-portalapisessions.md)


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