API
Visão geral da API
Endereço base, autenticação e as famílias de rotas da API da AIUBY: Gateway de modelos e rotas da plataforma.
#Endereço base
https://aiuby.comPara o SDK da OpenAI, o endereço base é https://aiuby.com/api/gateway/v1.
#Autenticação
Toda rota exige uma chave de API com o escopo correspondente, enviada no cabeçalho de autorização. O Gateway também aceita x-api-key.
Authorization: Bearer aiuby_...- Sem chave ou com chave inválida:
401. - Chave sem o escopo da rota:
403.
#Rotas
| Rota | Escopo | Para quê |
|---|---|---|
POST /api/gateway/v1/chat/completions | Chamar modelos pelo Gateway | Chat no formato da OpenAI, com qualquer modelo liberado |
GET /api/gateway/v1/models | Chamar modelos pelo Gateway | Listar os modelos do workspace |
POST /api/gateway/anthropic/v1/messages | Chamar modelos pelo Gateway | Formato nativo da Anthropic, só para modelos dela |
POST /api/gateway/openai/v1/chat/completions | Chamar modelos pelo Gateway | Formato nativo da OpenAI, só para modelos dela |
POST /api/platform/knowledge/search | Buscar no Knowledge | Buscar nos documentos |
POST /api/platform/agents/{id}/runs | Executar agentes | Iniciar um agente |
POST /api/platform/prompts/{id}/runs | Executar prompts | Executar um prompt |
POST /api/platform/flows/{id}/runs | Executar fluxos | Iniciar um fluxo |
GET /api/platform/audit/export | Exportar auditoria | Exportar eventos |
As rotas do Compute estão em Compute e CLI. As rotas dos produtos de engenharia (Software Delivery, Security Testing, Incident Management e os demais) estão na API v1, com a referência por produto e a especificação em /api/v1/openapi.json.
#Identificador da requisição
Toda resposta do Gateway traz o cabeçalho x-aiuby-request-id. Guarde esse valor: é com ele que a equipe localiza uma chamada.