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

# Visão geral

> API REST da weve: JSON em todas as respostas, um envelope único de erro e um contrato OpenAPI que gera esta documentação.

## Base URL

<CodeGroup>
  ```bash Produção theme={null}
  https://api.weve.cx
  ```

  ```bash Desenvolvimento theme={null}
  http://localhost:8080
  ```
</CodeGroup>

## O contrato manda

Esta referência não é escrita à mão: ela sai do mesmo `openapi.yaml` que gera a interface do
servidor em Go e o client TypeScript do dashboard. Um endpoint só chega aqui depois de existir
no contrato — e o build quebra se a implementação divergir dele.

Na prática: **o que está documentado é o que a API faz**, e não a intenção de quem escreveu a
página.

## Formato das respostas

Toda resposta é JSON. Recursos vêm embrulhados em `data`, o que deixa espaço para metadados
crescerem sem quebrar quem já consome:

```json theme={null}
{
  "data": {
    "id": "4d54e9be-2e48-45fb-8756-8db91763c48f",
    "name": "Ada Lovelace",
    "email": "ada@weve.cx",
    "created_at": "2026-09-01T10:52:07Z",
    "updated_at": "2026-09-01T10:52:07Z"
  }
}
```

Erro segue o envelope descrito em [Erros](/essentials/errors). Datas são ISO 8601 e
identificadores são UUID.

<Note>
  A API está em desenvolvimento e ainda não exige credencial. Não a use com dados reais até a
  autenticação existir.
</Note>