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

# The caller's credit balance



## OpenAPI

````yaml /openapi.json get /api/credits/balance
openapi: 3.1.0
info:
  title: Syvon API
  version: 1.0.0
  description: >-
    Two client-facing surfaces: the Portal management plane (syvon.ai/api/*,
    portal JWT) and the Brain read plane (brain.syvon.ai/v1/*, workspace key
    sk_ws_…). Schemas are generated from the @syvon/sdk TypeScript types — the
    shipped .d.ts files are the authoritative contract.
servers:
  - url: https://syvon.ai
    description: Portal (management plane)
  - url: https://brain.syvon.ai
    description: Brain (read plane)
security: []
tags:
  - name: Auth
    description: Minting the portal JWT
  - name: Portal
    description: Management plane — user-scoped (portal JWT)
  - name: Brain
    description: Published-agent read plane — workspace-scoped (sk_ws_…)
paths:
  /api/credits/balance:
    get:
      tags:
        - Portal
      summary: The caller's credit balance
      operationId: getCreditBalance
      responses:
        '200':
          description: Balance
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditBalance'
      security:
        - bearerAuth: []
      servers:
        - url: https://syvon.ai
components:
  schemas:
    CreditBalance:
      type: object
      description: ''
      properties:
        balance:
          description: ''
          type: object
          properties:
            available:
              description: ''
              type: number
            held:
              description: ''
              type: number
            total:
              description: ''
              type: number
          required:
            - available
            - held
            - total
        unit:
          description: ''
          type: string
          enum:
            - credits
        usdCents:
          description: ''
          type: object
          properties:
            available:
              description: ''
              type: number
            held:
              description: ''
              type: number
            total:
              description: ''
              type: number
          required:
            - available
            - held
            - total
      required:
        - balance
        - unit
        - usdCents
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Portal API JWT (user-scoped, ~1h)

````