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

# Get the caller's credit balance

> available = balance - held, computed at read time — never a stored/cached value.



## OpenAPI

````yaml /openapi.json get /api/public/v1/me/credits
openapi: 3.1.0
info:
  title: VyomFlow API
  version: 1.0.0
  description: >-
    The versioned public REST surface (`/api/public/v1/*`, bearer API-key auth)
    plus the app's own internal `/api/v1/*` surface (Clerk session-token auth),
    generated directly from the same Zod contracts the Route Handlers validate
    against — never a hand-maintained duplicate. The MCP endpoint (`/api/mcp`)
    is a separate streamable-HTTP JSON-RPC transport, not expressible here — see
    the MCP guide.
servers:
  - url: https://api.vyomflow.co.in
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
paths:
  /api/public/v1/me/credits:
    get:
      tags:
        - Public API
      summary: Get the caller's credit balance
      description: >-
        available = balance - held, computed at read time — never a
        stored/cached value.
      responses:
        '200':
          description: The caller's balance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditBalance'
        '401':
          description: Missing, invalid, or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Valid key missing the required `credits:read` scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
        - ApiKeyAuth:
            - credits:read
components:
  schemas:
    CreditBalance:
      type: object
      properties:
        balance:
          type: string
        held:
          type: string
        available:
          type: string
      required:
        - balance
        - held
        - available
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Clerk-native API key, `Authorization: Bearer <key>`. Minted at
        https://www.vyomflow.co.in/settings/api-keys, scoped per operation. 401
        = missing/invalid/revoked key; 403 = valid key missing the required
        scope.

````