Agentes
Criar agentes, configurar prompts, vincular ferramentas, skills, bases de conhecimento e canais.
Conversas
Enviar mensagens, receber respostas em streaming (SSE), listar conversas e mensagens.
Hub
Gerenciar identidade do hub, domínio, políticas de acesso, links externos e clientes.
Cobrança
Configurar planos, pacotes de créditos, cupons e consultar assinaturas dos clientes.
URL base
/public/api/v1/.
O que ela não é
Essa API é escopada por workspace, não por usuário. Não tem fluxo OAuth de end-user aqui. A API key autentica um workspace, e toda operação roda como aquele workspace. Para autenticação de end-user no portal do Hub (onde seus clientes entram para conversar com agentes), veja a documentação do produto Hub.Formato
- Todas as requisições e respostas usam
application/json(exceto file uploads). - Todos os IDs nas URLs são UUIDs.
- Timestamps em ISO 8601 com timezone (
2026-12-31T23:59:59Z). - Parsing estrito do request body — campos desconhecidos retornam
400 VALIDATION_ERROR.
Próximos passos
Criar uma API key
Gere uma API key de workspace no Studio. Veja Autenticação.
Fazer a primeira chamada
Siga o Quickstart para listar agentes e enviar uma mensagem em menos de cinco minutos.