API Reference

Endpoints HTTP da plataforma AUMO, organizados pelo serviço que responde por cada recurso.

A API da AUMO é a mesma que o Admin e o Chat usam. Todas as rotas passam por um único gateway e cada recurso pertence a um serviço, que dá nome às seções desta referência.

Quase toda rota vive dentro de uma organização e de um workspace: /api/v1/org/{org_id}/workspaces/{workspace_id}/.... Antes de chamar qualquer endpoint, leia Autenticação e Convenções.

Primeiros passos

Autenticação

Escolher entre token de usuário, Personal Access Token e chave de projeto.

Convenções

Formato de erro, paginação, correlation id e idempotência, comuns a todos os serviços.

Como ler esta referência

Cada serviço lista suas rotas na barra lateral como uma árvore de arquivos, a partir de /api/v1. Cada segmento do caminho é um item:

Página: o caminho tem operações. Todos os métodos daquele caminho ficam na mesma página, com playground, parâmetros, corpo, respostas e exemplos de código.
Pasta: o caminho tem sub-rotas. Quando ele também tem operações, a pasta abre a própria página.
Prefixo agrupado: segmentos sem operação próprias, como org/{org_id}/workspaces/{workspace_id}, aparecem juntos num item só.