# Consulta Saldo de Créditos

> Parâmetros, exemplos e respostas de GET /v1/credits na NextAPI.

Fonte: https://www.nextapi.com.br/docs/api/get-v1-credits

`GET /v1/credits`

Retorna o saldo detalhado de créditos da assinatura e créditos extras, além dos limites associados ao workspace atual.

- Esta operação é isenta (consome 0 créditos).
- A consulta pode ser executada mesmo se o saldo estiver zerado.

URL base: `https://api.nextapi.com.br`. Autenticação: cabeçalho `Authorization: Bearer SEU_TOKEN`.

## Exemplo de requisição

```bash
curl --request GET 'https://api.nextapi.com.br/v1/credits' \
  --header 'Authorization: Bearer SEU_TOKEN' \
  --header 'Accept: application/json'
```

## Parâmetros

Esta operação não declara parâmetros de rota ou query no contrato.

## Respostas HTTP

| Status | Descrição | Formato JSON |
| --- | --- | --- |
| `200` | Operação realizada com sucesso | WorkspaceCreditsResponse |
| `400` | Erro nos parametros informados na requisição | IErrorCodeModel |
| `401` | Token de autenticação inválido ou ausente | IErrorCodeModel |
| `500` | Erro ao processar a requisição | objeto |

Autenticação e limites também podem gerar erros antes da execução da operação. Veja o [guia de tratamento de erros](https://www.nextapi.com.br/docs/erros.md).

## Resposta de sucesso

Exemplo estrutural gerado do schema: os valores são ilustrativos. Campos anuláveis podem retornar `null`.

```json
{
  "workspaceId": 0,
  "monthReference": "string",
  "planCredits": {
    "allocated": 0,
    "remaining": 0
  },
  "extraCredits": {
    "remaining": 0
  },
  "totalRemainingCredits": 0,
  "limits": {
    "requestsPerMinute": 0,
    "allowExternalSearch": false,
    "canLiveSearch": false
  }
}
```

## Campos da resposta

Modelo: `WorkspaceCreditsResponse`

### WorkspaceCreditsResponse

| Campo | Tipo | Obrigatório | Descrição / regras |
| --- | --- | --- | --- |
| `workspaceId` | `integer (int64)` | Não marcado no contrato | — |
| `monthReference` | `string \| null` | Não marcado no contrato | — |
| `planCredits` | `PlanCreditsInfo` | Não marcado no contrato | — |
| `extraCredits` | `ExtraCreditsInfo` | Não marcado no contrato | — |
| `totalRemainingCredits` | `integer (int32)` | Não marcado no contrato | — |
| `limits` | `LimitsInfo` | Não marcado no contrato | — |

### PlanCreditsInfo

| Campo | Tipo | Obrigatório | Descrição / regras |
| --- | --- | --- | --- |
| `allocated` | `integer (int32)` | Não marcado no contrato | — |
| `remaining` | `integer (int32)` | Não marcado no contrato | — |

### ExtraCreditsInfo

| Campo | Tipo | Obrigatório | Descrição / regras |
| --- | --- | --- | --- |
| `remaining` | `integer (int32)` | Não marcado no contrato | — |

### LimitsInfo

| Campo | Tipo | Obrigatório | Descrição / regras |
| --- | --- | --- | --- |
| `requestsPerMinute` | `integer (int32)` | Não marcado no contrato | — |
| `allowExternalSearch` | `boolean` | Não marcado no contrato | — |
| `canLiveSearch` | `boolean` | Não marcado no contrato | — |