api reference¶
além da interface visual, a datablixt expõe uma API REST completa — a mesma que a própria interface usa por trás dos panos. isso permite integrar a plataforma a sistemas internos da sua empresa: disparar pipelines a partir de outra aplicação, consultar o catálogo programaticamente, ou automatizar tarefas administrativas sem passar pela tela.
quando faz sentido usar a API
use a API quando você precisa automatizar algo que hoje depende de um clique manual — por exemplo, disparar um pipeline a partir de um sistema interno, ou consultar o status de execuções dentro de um painel próprio da empresa. para o dia a dia de construir e operar pipelines, a interface visual continua sendo o caminho recomendado.
base URL¶
autenticação¶
a API usa autenticação via token (Bearer). depois de autenticar (login ou fluxo OAuth, conforme configurado na sua organização), inclua o token em todas as chamadas:
agentes de IA e integrações programáticas também podem usar um token de serviço próprio, gerado na configuração do agente — veja configurando agentes.
principais grupos de endpoints¶
| grupo | para que serve |
|---|---|
| autenticação | login, oauth e gestão de sessão |
| organizações e workspaces | criação e configuração de organizações, workspaces e membros |
| pipelines e workflows | criação, edição e publicação de pipelines |
| execuções (runs) | disparo e acompanhamento de execuções, histórico e status |
| catálogo | navegação de workspaces/lakehouses/tabelas, schema e consulta sql ad-hoc |
| lakehouses | criação e gerenciamento de lakehouses, tabelas e arquivos |
| vault de credenciais | criação e gerenciamento de credenciais criptografadas |
| governança | linhagem, auditoria, configuração de PII e controle de acesso |
| integrações | conexão com github e gerenciamento de webhooks |
| agentes de IA | criação de agentes, concessão de acesso e conversas via API |
referência completa de endpoints¶
esta página cobre uma visão geral de uso — não é uma referência exaustiva endpoint por endpoint. a especificação completa (OpenAPI/Swagger), gerada diretamente a partir da API em execução, fica disponível em /docs (interface interativa) e /redoc (referência navegável) na sua instância da datablixt.
convenção de resposta
a maioria dos endpoints retorna respostas paginadas para listagens (page, page_size, total) e envolve o dado principal em uma estrutura de resposta padrão — consulte a especificação OpenAPI da sua instância para o formato exato de cada endpoint.