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

# Visão geral

> Envie mensagens WhatsApp e gerencie leads da sua conta Superlead por API.

A API pública da Superlead permite enviar mensagens WhatsApp para os leads da sua empresa e consultar ou criar leads a partir dos seus próprios sistemas — automações no n8n, CRMs, backends próprios.

```text theme={null}
Base URL: https://api.superlead.app/v1
```

Todas as requisições usam JSON e exigem uma chave de API no header `Authorization`. A chave é criada no painel da Superlead e enxerga apenas os dados da sua empresa.

## O que você pode fazer

<Columns cols={2}>
  <Card title="Enviar mensagens" icon="send" href="/guias/envio-de-mensagens">
    Texto livre, templates aprovados, mídia e mais — para leads existentes da sua empresa.
  </Card>

  <Card title="Consultar e criar leads" icon="users" href="/guias/leads">
    Busque um lead por telefone ou id e crie leads explicitamente quando necessário.
  </Card>

  <Card title="Acompanhar status" icon="list-checks" href="/guias/envio-de-mensagens#acompanhar-o-status-da-mensagem">
    Cada envio retorna um id. Consulte o ciclo de vida: accepted, sent, delivered, read ou failed.
  </Card>

  <Card title="Referência completa" icon="book-open" href="/referencia/visao-geral">
    Todos os endpoints com playground interativo, exemplos de código e schemas.
  </Card>
</Columns>

## Fluxo típico

<Steps>
  <Step title="Crie uma chave de API">
    No painel da Superlead, em **Integrações**, gere uma chave `sl_live_...`. Ela aparece uma única vez — guarde em local seguro.
  </Step>

  <Step title="Envie uma mensagem">
    Faça um `POST /v1/messages` informando o telefone do lead em `to`. O lead precisa existir na sua empresa.
  </Step>

  <Step title="Consulte o resultado">
    Use o `id` retornado (`msg_...`) em `GET /v1/messages/{id}` para acompanhar o status real de entrega.
  </Step>
</Steps>

## Princípios do contrato

* **Versionado por caminho**: tudo vive sob `/v1`. Mudanças incompatíveis só entram em uma versão nova; o `/v1` recebe apenas adições.
* **Isolamento por empresa**: a chave de API só alcança leads, mensagens e templates da empresa dona da chave.
* **Erros estáveis**: toda falha retorna um envelope com `code` estável e `request_id` para suporte. Veja o [catálogo de erros](/guias/erros).
* **Idempotência**: envie o header `Idempotency-Key` para repetir requisições com segurança. Veja [Idempotência](/guias/idempotencia).