Pular para o conteúdo principal

Visão geral da API

A API do AgentHub permite registrar ferramentas e agentes, aprovar acessos, conversar com agentes e consultar a auditoria — tudo o que o painel faz, de forma programática.

URL base​

https://SEU-AGENTHUB

Substitua SEU-AGENTHUB pela URL da sua organização.

Documentação interativa​

A API publica uma documentação interativa que reflete exatamente a versão em uso:

  • /docs — interface estilo Swagger UI (testar endpoints no navegador);
  • /redoc — referência em formato ReDoc.

Autenticação​

Há dois tipos de credencial (veja Autenticação):

CredencialUsada porOnde
Token de acesso (usuário)Pessoas/integrações administrativasTodos os endpoints /api/v1/*, exceto o chat do agente
client_secret (agente)Agentes em execuçãoApenas o endpoint de conversa do próprio agente

Ambas são enviadas no cabeçalho:

Authorization: Bearer <credencial>

Formato​

  • Corpo das requisições e respostas em JSON (Content-Type: application/json).
  • Datas em ISO 8601 / UTC (ex.: 2026-05-20T10:00:00Z).
  • Listas longas (ex.: auditoria) aceitam paginação via limit e offset.

Papéis​

Cada endpoint exige um papel mínimo (leitor, revisor, admin ou super admin). Ele é indicado ao lado de cada operação nas próximas páginas. Veja Usuários e papéis.

Saúde​

GET /health​

Sem autenticação. Verifica se a API está no ar.

{ "status": "ok" }

Próximas páginas​