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

# Referência da API

> API REST do Cawme — URL base, autenticação e convenções

## URL base

```
https://cawme.com/api/v1
```

Um ambiente sandbox está disponível para testes:

```
https://sandbox.cawme.com/api/v1
```

## Autenticação

Todos os endpoints exigem um Bearer token:

```http theme={null}
Authorization: Bearer <seu-clerk-token>
```

Consulte o [guia de Autenticação](/guides/authentication) para mais detalhes.

## Formato das requisições

* Todos os corpos de requisição usam `Content-Type: application/json`
* Todos os timestamps são ISO 8601 em UTC (ex.: `2026-03-01T10:00:00Z`)
* Os IDs são strings com prefixo: `inst_<hex>` para instâncias, `call_<hex>` para chamadas

## Códigos de resposta

| Código | Significado                                          |
| ------ | ---------------------------------------------------- |
| `200`  | OK                                                   |
| `201`  | Recurso criado                                       |
| `204`  | Sem conteúdo (delete ou terminate bem-sucedido)      |
| `400`  | Requisição inválida — campos ausentes ou incorretos  |
| `401`  | Não autorizado — token ausente ou inválido           |
| `403`  | Proibido — token válido, mas sem permissão de acesso |
| `404`  | Recurso não encontrado                               |
| `501`  | Ainda não implementado                               |

## Idempotência

Se você criar uma chamada para uma instância que já possui uma chamada ativa (`QUEUED`, `RINGING` ou `IN_PROGRESS`), a API retorna a chamada existente com status `200` em vez de criar uma duplicata. Isso protege contra envios duplicados causados por retentativas de rede ou pelo React Strict Mode.

## Limites de taxa (Rate Limiting)

Requisições com token demo são limitadas por IP. Requisições autenticadas seguem limites padrão de uso justo.

## Recursos

<CardGroup cols={2}>
  <Card title="Instâncias" icon="mobile" href="/api-reference/instances/create">
    Crie e gerencie instâncias do WhatsApp.
  </Card>

  <Card title="Chamadas" icon="phone" href="/api-reference/calls/create">
    Inicie e gerencie chamadas de saída.
  </Card>
</CardGroup>