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

# Get Balance

> Retorna o saldo atual do usuário autenticado.



## OpenAPI

````yaml GET /user/balance
openapi: 3.1.0
info:
  title: Muffins AI API
  description: >-
    API oficial da Muffins AI, oferecendo ferramentas avançadas de inteligência
    artificial para integração com seus sistemas.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://chat.muffinscorp.com/api/public
security:
  - apiKeyAuth: []
paths:
  /user/balance:
    get:
      description: Retorna o saldo atual do usuário autenticado.
      responses:
        '200':
          description: Saldo retornado com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balance'
        '400':
          description: Erro na solicitação.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Não autorizado - API key inválida ou faltando.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Balance:
      type: object
      properties:
        balance:
          type: object
          properties:
            regularBalance:
              description: Saldo regular disponível (créditos não diários).
              type: number
            dailyBalance:
              description: Saldo diário disponível.
              type: number
            totalBalance:
              description: Soma total dos saldos (regular + diário).
              type: number
            hasDailyCredit:
              description: Indica se o usuário possui crédito diário disponível.
              type: boolean
            credits:
              type: array
              items:
                type: object
                properties:
                  id:
                    description: ID único do crédito.
                    type: string
                    format: uuid
                  userId:
                    description: ID do usuário dono do crédito.
                    type: string
                    format: uuid
                  amount:
                    description: Valor total original do crédito.
                    type: number
                  expiresAt:
                    description: Data de expiração do crédito.
                    type: string
                    format: date-time
                  extendedExpiresAt:
                    description: Data extendida de expiração (se aplicável).
                    type:
                      - string
                      - 'null'
                    format: date-time
                  createdAt:
                    description: Data de criação do crédito.
                    type: string
                    format: date-time
                  usedAmount:
                    description: Quantidade já utilizada deste crédito.
                    type: number
                  type:
                    description: 'Tipo do crédito (ex: ''plan'').'
                    type: string
                required:
                  - id
                  - userId
                  - amount
                  - expiresAt
                  - createdAt
                  - type
            dailyCredit:
              type: object
              properties:
                id:
                  description: ID único do crédito diário.
                  type: string
                  format: uuid
                userId:
                  description: ID do usuário dono do crédito diário.
                  type: string
                  format: uuid
                grantedAmount:
                  description: Quantidade total de crédito diário concedido.
                  type: number
                amount:
                  description: Quantidade disponível de crédito diário.
                  type: number
                grantedDate:
                  description: Data de concessão do crédito diário.
                  type: string
                  format: date
                used:
                  description: Indica se o crédito diário foi utilizado.
                  type: boolean
              required:
                - id
                - userId
                - grantedAmount
                - amount
                - grantedDate
          required:
            - regularBalance
            - dailyBalance
            - totalBalance
            - hasDailyCredit
        success:
          description: Indica se a requisição foi bem sucedida.
          type: boolean
        timestamp:
          description: Data e hora da resposta.
          type: string
          format: date-time
      required:
        - balance
        - success
        - timestamp
    Error:
      type: object
      required:
        - error
        - code
        - success
      properties:
        error:
          description: Descrição legível do erro.
          type: string
          example: Invalid API Key
        code:
          description: Código de erro padrão para tratamento programático.
          type: string
          enum:
            - AUTH_FAILED
            - INVALID_INPUT
            - RATE_LIMITED
            - SERVER_ERROR
          example: AUTH_FAILED
        message:
          description: Mensagem detalhada do erro (opcional).
          type: string
        traceId:
          description: ID único para rastreamento do erro no servidor.
          type: string
          format: uuid
        success:
          description: Indica se a requisição foi bem sucedida (sempre false para erros).
          type: boolean
          enum:
            - false
        details:
          description: Informações técnicas adicionais para depuração.
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: x-api-key
      in: header
      description: API key for authentication

````