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

# Introdução

> Integre qualquer sistema com a Cordialy e automatize seu atendimento via WhatsApp com IA

A **API pública da Cordialy** permite conectar seu CRM, ERP, e-commerce ou qualquer sistema interno à plataforma de atendimento via WhatsApp com IA — sem precisar acessar a plataforma manualmente.

## O que você pode fazer

<CardGroup cols={2}>
  <Card title="Gerenciar Leads" icon="users" href="/guides/leads">
    Crie e atualize leads direto do seu sistema. Sincronize status, responsáveis e dados de contato sem abrir a plataforma.
  </Card>

  <Card title="Enviar Mensagens" icon="message" href="/guides/messaging">
    Dispare mensagens via WhatsApp para leads em momentos específicos — confirmações, notificações, cobranças, lembretes.
  </Card>

  <Card title="Automatizar Follow-ups" icon="clock" href="/guides/followups">
    Agende mensagens automáticas de reativação com base em eventos do seu sistema, sem depender da IA da Cordialy.
  </Card>

  <Card title="Consultar Agentes" icon="robot" href="/guides/agents">
    Veja quais agentes de IA estão ativos e entenda as condições de ativação de cada um.
  </Card>

  <Card title="Receber Eventos" icon="webhook" href="/guides/webhooks">
    Configure webhooks para ser notificado quando leads responderem, mudarem de status ou sessões forem abertas.
  </Card>

  <Card title="Acessar Relatórios" icon="chart-bar" href="/api-reference/reports/summary">
    Puxe métricas de atendimento para integrar no seu BI, dashboard ou relatório gerencial.
  </Card>
</CardGroup>

## Base URL

Todos os endpoints usam a mesma base:

```
https://api.cordialy.ai/integrations/v1
```

## Autenticação

Todas as requisições precisam do header `X-API-Key`:

```bash theme={null}
curl https://api.cordialy.ai/integrations/v1/leads \
  -H "X-API-Key: sua_chave_aqui"
```

Gere sua chave em **Plataforma → Integrações → API Keys**.

## Disponibilidade por plano

A API pública está disponível **apenas para planos Premium**. Planos Low Ticket não possuem acesso à API.

| Recurso                     | Starter | Growth | Enterprise | Enterprise Plus |
| --------------------------- | :-----: | :----: | :--------: | :-------------: |
| Leads (leitura e escrita)   |    ✅    |    ✅   |      ✅     |        ✅        |
| Envio de mensagens          |    ✅    |    ✅   |      ✅     |        ✅        |
| Follow-ups                  |    —    |    ✅   |      ✅     |        ✅        |
| Base de conhecimento        |    —    |    ✅   |      ✅     |        ✅        |
| Agentes de IA               |    —    |    —   |      ✅     |        ✅        |
| Relatórios                  |    —    |    —   |      ✅     |        ✅        |
| Webhooks (eventos de saída) |  ✅ (2)  |  ✅ (5) |  ilimitado |    ilimitado    |
| API Keys permitidas         |    1    |    3   |  ilimitado |    ilimitado    |

## Limites de taxa

| Plano           | Req/s |
| --------------- | ----- |
| Starter         | 5     |
| Growth          | 20    |
| Enterprise      | 60    |
| Enterprise Plus | 150   |

Quando o limite é atingido, a API retorna `429 Too Many Requests`. O header `Retry-After` indica em quantos segundos você pode tentar novamente.

## Próximos passos

<CardGroup cols={2}>
  <Card title="Autenticação" icon="key" href="/authentication">
    Como gerar e usar sua API key com segurança.
  </Card>

  <Card title="Quickstart" icon="bolt" href="/quickstart">
    Envie sua primeira mensagem em menos de 5 minutos.
  </Card>
</CardGroup>