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

# Introdução

> Visão geral da API pública aidesk para integradores.

# Introdução

A API pública da aidesk permite que o seu sistema envie mensagens WhatsApp (texto, mídia e templates), consulte o status de delivery e receba webhooks assinados.

## Base URL

```
https://api.aideskbr.com
```

Todas as rotas documentadas neste portal estão sob `/api/public/v1`.

## O que você consegue fazer

| Recurso  | Path                               | Uso                            |
| -------- | ---------------------------------- | ------------------------------ |
| Ping     | `GET /api/public/v1/ping`          | Validar key, org e scopes      |
| Enviar   | `POST /api/public/v1/messages`     | Texto, mídia ou template       |
| Status   | `GET /api/public/v1/messages/{id}` | Polling de delivery            |
| Webhooks | `/api/public/v1/webhooks`          | Eventos `message.*` no seu URL |

## Autenticação

Use uma API key `ak_live_...` criada no app ([como obter](https://help.aideskbr.com/integrations/api-keys)).

```bash theme={null}
curl -sS https://api.aideskbr.com/api/public/v1/ping \
  -H 'Authorization: Bearer ak_live_SUA_KEY'
```

A organização vem **sempre** da key — não envie `organization_id` nestas rotas.

## Próximos passos

<CardGroup cols={2}>
  <Card title="Autenticação" icon="key" href="/authentication">
    Headers, scopes e ciclo de vida da key
  </Card>

  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Do ping ao primeiro envio em minutos
  </Card>

  <Card title="Webhooks" icon="webhook" href="/webhooks">
    Assinatura HMAC e payloads
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/ping">
    Playground interativo OpenAPI
  </Card>
</CardGroup>