API REST

A API REST do OutDo é documentada em OpenAPI:

Abrir a referência OpenAPI

Essa página desenha, aqui no site, o openapi.json comitado: endereço base, todas as rotas, corpos e respostas. O mesmo documento é servido ao vivo pelo próprio serviço, em https://docs-api.out-do.app (desenvolvimento: https://docs-api.dev.out-do.app), onde reflete a versão que está de pé nesse ambiente.

Esta página não duplica a referência: diz só o que é preciso saber antes de a abrir.

Autenticar

Dois tipos de credencial, no mesmo cabeçalho:

Authorization: Bearer <credencial>

• Uma chave de API da organização, que começa por outdo_sk_. É a credencial de um agente ou de uma integração.
• Um JWT de utilizador do Supabase, que é o que a aplicação usa.

Uma chave só vê o que a organização dela vê: as políticas de segurança da base de dados continuam a mandar, e o scope nunca alarga o que elas negam.

Scopes

Scope	O que autoriza
read	Ler linhas e estrutura.
write	Criar, alterar e apagar linhas.
structure	Criar e alterar estrutura: tabelas, colunas, vistas, rails, módulos e automações.

Os scopes escolhem-se na cunhagem da chave, e o structure é aditivo: só vale acompanhado de write. Uma chave com structure e sem write é recusada à cunhagem, com um 422, em vez de nascer inútil: o perfil de acesso sintético de uma chave deriva os verbos de read e de write, logo uma chave só com structure nasceria sem permissão de ver e a base negava-lhe tudo.

Automações

As rotas /v1/workflows-v2 do OpenAPI criam e versionam automações. O envelope da definição, o ciclo rascunho até ativo e dois exemplos completos estão em Automações (WorkflowV2).

Limites que poupam tempo

• Uma organização em plano gratuito não cunha chaves de API.
• A escrita de estrutura é escrita a sério: um agente com structure cria tabelas e colunas a fundo. Construir primeiro em desenvolvimento é a regra.