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

# Uso

> Consultar o consumo atual do plano da sua organização.

# Uso

Retorna o consumo atual do período em andamento: créditos de IA e de ressincronização (no nível da organização) e créditos de IA detalhados por agente, além de agentes e capacidade da base de conhecimento.

```http theme={null}
GET https://app.chatnorris.ai/api/v2/usage
Authorization: Bearer <sua_api_key>
```

**Escopo necessário:** nenhum (apenas autenticação válida)

***

## Resposta

```json theme={null}
{
  "status": "success",
  "data": {
    "messages": {
      "used": 3420,
      "limit": 5000
    },
    "chatbots": {
      "used": 3,
      "limit": 5
    },
    "knowledge_base_chars": {
      "used": 820000,
      "limit": 5000000
    },
    "credits": {
      "ai": {
        "used": 1200,
        "limit": 3000,
        "remaining": 1800
      },
      "resync": {
        "used": 500,
        "limit": 15000,
        "remaining": 14500
      }
    },
    "chatbot_credits": [
      {
        "id": "bot_xyz789",
        "name": "Agente de suporte",
        "credits": {
          "ai": {
            "used": 300,
            "limit": 500,
            "remaining": 200
          }
        }
      }
    ],
    "period": {
      "start": "2026-06-01T00:00:00.000Z",
      "end": "2026-07-01T00:00:00.000Z"
    }
  }
}
```

### Campos da resposta

| Campo | Tipo | Descrição |
| - | - | - |
| `messages.used` | number | Alias herdado: reflete o mesmo consumo que `credits.ai.used`, mantido por compatibilidade. Prefira `credits.ai` para novas integrações. |
| `messages.limit` | number \| null | Alias herdado do limite do pacote `ai` (`null` = ilimitado) |
| `chatbots.used` | integer | Agentes ativos da organização |
| `chatbots.limit` | integer \| null | Limite de agentes salvo na conta. É um campo herdado e pode não refletir os agentes adicionais contratados; o limite vigente aparece em **Faturamento e uso → Uso** |
| `knowledge_base_chars.used` | integer | Caracteres indexados na KB |
| `knowledge_base_chars.limit` | integer \| null | Limite de caracteres do plano (`null` = ilimitado) |
| `credits.ai` | object | Consumo do pacote de créditos de IA da organização no período atual |
| `credits.resync` | object | Consumo do pacote de créditos de ressincronização da organização no período atual |
| `credits.<bucket>.used` | number | Créditos consumidos desse pacote no período atual |
| `credits.<bucket>.limit` | number \| null | Limite desse pacote (`null` = ilimitado) |
| `credits.<bucket>.remaining` | number \| null | Créditos restantes desse pacote (`null` se o limite for ilimitado) |
| `chatbot_credits` | array | Detalhamento do consumo de créditos por agente |
| `chatbot_credits[].id` | string | ID do agente |
| `chatbot_credits[].name` | string | Nome do agente |
| `chatbot_credits[].credits.ai.limit` / `.remaining` | number \| null | Só têm valor se esse agente tiver um teto de créditos próprio ativado (Configurações do agente → Limites); caso contrário, são `null` |
| `period.start` | string | Início do período de faturamento (ISO 8601) |
| `period.end` | string | Fim do período de faturamento / data de reset dos contadores (ISO 8601) |

> [!NOTE]
>
> Um limite `null` indica que esse recurso é ilimitado no seu plano atual. A resposta não inclui o pacote de créditos de email.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.