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

# Consultar saldo de créditos

> Este endpoint retorna o saldo atual de créditos do usuário e estatísticas de uso.

## GET /credits/balance

Este endpoint retorna o saldo atual de créditos e estatísticas de uso do usuário autenticado. Exige autenticação por sessão (token de acesso JWT).

<Note>
  **Para integrações de terceiros:** use `GET /credits/balance/api` com autenticação por chave de API.
</Note>

### Resposta

<ResponseField name="balance" type="number">
  Saldo disponível de créditos do usuário.
</ResponseField>

<ResponseField name="totalPurchased" type="number">
  Total de créditos comprados no histórico da conta.
</ResponseField>

<ResponseField name="totalUsed" type="number">
  Total de créditos utilizados no histórico da conta.
</ResponseField>

<ResponseField name="recentTransactions" type="array">
  Lista das transações de crédito recentes.

  <Expandable title="Propriedades da transação">
    <ResponseField name="id" type="string">
      Identificador da transação.
    </ResponseField>

    <ResponseField name="type" type="string">
      Tipo da transação: "purchase", "usage" ou "refund".
    </ResponseField>

    <ResponseField name="amount" type="number">
      Quantidade de créditos (positiva em compras, negativa em uso).
    </ResponseField>

    <ResponseField name="description" type="string">
      Descrição legível da transação.
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      Data e hora em ISO 8601.
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.llmgenerator.com/api/v1/credits/balance \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
  ```

  ```javascript Node.js theme={null}
  const response = await fetch('https://api.llmgenerator.com/api/v1/credits/balance', {
    headers: {
      'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
    }
  });

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://api.llmgenerator.com/api/v1/credits/balance',
      headers={'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}
  )

  data = response.json()
  ```
</RequestExample>

<ResponseExample>
  ```json Sucesso (200) theme={null}
  {
    "balance": 450,
    "totalPurchased": 1000,
    "totalUsed": 550,
    "recentTransactions": [
      {
        "id": "txn_abc123",
        "type": "purchase",
        "amount": 500,
        "description": "Purchased Pro Pack",
        "createdAt": "2026-01-15T10:00:00Z"
      },
      {
        "id": "txn_def456",
        "type": "usage",
        "amount": -50,
        "description": "API LLMs.txt generation (enhanced) for example.com (25 URLs)",
        "createdAt": "2026-01-20T14:30:00Z"
      }
    ]
  }
  ```

  ```json Não autorizado (401) theme={null}
  {
    "message": "Unauthorized"
  }
  ```
</ResponseExample>

***

## GET /credits/balance/api

Este endpoint retorna o saldo atual de créditos usando autenticação por chave de API. Indicado para integrações externas e aplicativos de terceiros.

### Autenticação

Exige chave de API. Inclua sua chave no cabeçalho `Authorization`:

```
Authorization: Bearer llmgen_your_api_key_here
```

### Resposta

Igual à de `/credits/balance`, acima.

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET https://api.llmgenerator.com/api/v1/credits/balance/api \
    -H "Authorization: Bearer llmgen_your_api_key_here"
  ```

  ```javascript Node.js theme={null}
  const response = await fetch('https://api.llmgenerator.com/api/v1/credits/balance/api', {
    headers: {
      'Authorization': 'Bearer llmgen_your_api_key_here'
    }
  });

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://api.llmgenerator.com/api/v1/credits/balance/api',
      headers={'Authorization': 'Bearer llmgen_your_api_key_here'}
  )

  data = response.json()
  ```
</RequestExample>