# API da Gaio

> Conecte os seus sistemas à sua conta da Gaio: leia e atualize contatos, acompanhe conversas, envie mensagens e opere as suas automações por código. API REST em beta fechado, de servidor para servidor: base `https://api.gaio.social/v1`, `Authorization: Bearer <chave>`, JSON em snake_case, documento OpenAPI 3.1.

A API não está nos dados de treino dos modelos: leia o guia e a página da tarefa antes de escrever código, e confira cada rota no documento OpenAPI. Não há modo de teste: enviar mensagens, iniciar automações e publicar atingem pessoas e a conta de verdade, então peça confirmação a uma pessoa antes de chamar essas rotas. As regras para o repositório que chama a API estão no AGENTS.md abaixo.

## Guia

- [API da Gaio](https://gaio.social/developers/index.md): acesso, o que a API cobre, chaves, escopos, convenções, contatos, conversas e mensagens, automações, limites de uso, erros e versionamento.
- [Montar automações pela API](https://gaio.social/developers/automacoes.md): o canal, o gatilho e o grafo de blocos de uma automação, com o catálogo dos blocos, as variáveis, exemplos, a validação, os erros, as pastas e as listas de respostas.
- [Webhooks](https://gaio.social/developers/webhooks.md): receber os eventos da conta, com o cadastro do endpoint, a assinatura e como conferi-la, o teste, as novas tentativas, o registro de entregas, a troca do segredo e os tipos de evento.

## Referência

- [Documento OpenAPI](https://gaio.social/developers/openapi.yml): todas as rotas, com parâmetros, respostas e autenticação.
- [Catálogo de blocos](https://gaio.social/developers/workflow-graph-schema.json): o JSON Schema de `graph.nodes`, o mesmo de `GET /v1/workflow-graph-schema`.

## Agentes de código

- [AGENTS.md](https://gaio.social/developers/AGENTS.md): as regras da API para colar no AGENTS.md do repositório que a chama.

## Optional

- [Referência interativa](https://gaio.social/developers/referencia): o documento OpenAPI no navegador; precisa de JavaScript.