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

# Visão Geral da API

> Introdução à API REST do WhataBot.

## Introdução

A API REST do WhataBot permite que você gerencie programaticamente sessões de conversa, fluxos, espaços de trabalho, setores e clientes OAuth. Todos os endpoints v1 são acessíveis através de requisições HTTP padrão que retornam respostas JSON.

## URL Base

Todas as requisições da API v1 são feitas para:

```
https://api.whatabot.app/api/v1
```

## Formato de Resposta

Todas as respostas são retornadas como JSON. Respostas bem-sucedidas usam códigos de status HTTP padrão (`200`, `201`, `202`, `204`). Respostas de erro seguem o formato:

```json theme={null}
{
  "statusCode": 400,
  "message": "Validation failed",
  "error": "Bad Request"
}
```

## Paginação

Endpoints de listagem suportam paginação via parâmetros de consulta:

| Parâmetro | Tipo    | Padrão | Descrição                 |
| --------- | ------- | ------ | ------------------------- |
| `page`    | integer | `0`    | Número da página (base 0) |
| `size`    | integer | `10`   | Itens por página          |

Respostas paginadas incluem:

```json theme={null}
{
  "content": [...],
  "totalElements": 42,
  "totalPages": 5,
  "number": 0,
  "size": 10,
  "first": true,
  "last": false
}
```

## Autenticação

Todos os endpoints v1 usam autenticação por **Chave de API** via cabeçalho `X-Api-Key`:

```bash theme={null}
curl -X GET "https://api.whatabot.app/api/v1/flows" \
  -H "X-Api-Key: wh_your_api_key_here"
```

<Note>
  Consulte a página de [Autenticação](/api-reference/authentication) para instruções de como criar sua chave de API.
</Note>

## Referência Rápida

<CardGroup cols={2}>
  <Card title="Autenticação" icon="lock" href="/api-reference/authentication">
    Chaves de API e autenticação para iframe.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/api-reference/webhooks">
    Receba notificações de sessões via callback.
  </Card>

  <Card title="Sessões" icon="comments" href="/api-reference/sessions/create-session">
    Crie e gerencie sessões de conversa.
  </Card>

  <Card title="Fluxos" icon="diagram-project" href="/api-reference/flows/create-flow">
    Crie e liste fluxos de conversa.
  </Card>

  <Card title="Espaços de Trabalho" icon="building" href="/api-reference/workspaces/create-workspace">
    Gerencie espaços de trabalho.
  </Card>

  <Card title="Setores" icon="building-columns" href="/api-reference/sectors/create-sector">
    Gerencie setores para transferências.
  </Card>
</CardGroup>