Endpoints Disponíveis
Abrir Swagger UI
Recursos da API
Seção intitulada “Recursos da API”Agentes
Seção intitulada “Agentes”Agentes são os módulos de IA instalados no workspace. Através da API você pode consultar os agentes disponíveis, instalar novos agentes e obter detalhes de agentes já configurados.
| Método | Endpoint | Descrição |
|---|---|---|
GET | /api/agent-base/product/{productId} | Listar agentes do workspace |
POST | /api/agent-base/install | Instalar um agente no workspace |
GET | /api/agent-base/{id} | Obter detalhes de um agente |
Quando usar: para automatizar a instalação de agentes, listar agentes ativos ou integrar a gestão de agentes em pipelines de CI/CD.
Execuções de Agentes
Seção intitulada “Execuções de Agentes”Execuções representam as invocações dos agentes — cada vez que um agente processa uma tarefa, uma execução é registrada.
| Método | Endpoint | Descrição |
|---|---|---|
GET | /api/agent-base/{id}/executions | Listar execuções de um agente |
Quando usar: para monitorar execuções de agentes ou construir dashboards customizados de acompanhamento.
Integrações
Seção intitulada “Integrações”Integrações conectam ferramentas externas (Git, DevOps, comunicadores, etc.) ao Prodgy. A API permite gerenciar essas conexões de forma programática. Cada integração possui um escopo: local (restrita a um workspace) ou global (disponível para todos).
| Método | Endpoint | Descrição |
|---|---|---|
GET | /api/integrations-base | Listar integrações (suporta query param product_id) |
GET | /api/integrations-base/{id} | Obter detalhes de uma integração |
POST | /api/integrations-base | Criar integração |
PUT | /api/integrations-base/{id} | Atualizar integração |
DELETE | /api/integrations-base/{id} | Excluir integração |
GET | /api/integrations-base/product/{productId}/active | Listar integrações ativas do workspace |
Suporte multi-instância: é possível instalar múltiplas instâncias do mesmo tipo de integração. Ao criar, envie title (nome de exibição obrigatório) e opcionalmente product_id para restringir a um workspace. A coluna scope é definida automaticamente (local quando product_id é fornecido, global caso contrário). Integrações Local substituem as Global do mesmo tipo para agentes de IA (mecanismo shadow).
Quando usar: para provisionar integrações automaticamente ao configurar novos workspaces ou sincronizar configurações entre ambientes.
Base de Conhecimento
Seção intitulada “Base de Conhecimento”A base de conhecimento armazena documentos que os agentes utilizam para gerar respostas contextualizadas via busca semântica (RAG).
| Método | Endpoint | Descrição |
|---|---|---|
GET | /api/knowledge-base/{productId} | Listar bases de conhecimento do workspace |
POST | /api/knowledge-base/embeddings | Busca semântica (somente vetores, sem LLM) |
Quando usar: para consultar as bases de conhecimento associadas a um workspace e seus documentos.
Triggers
Seção intitulada “Triggers”Triggers são gatilhos automáticos que disparam ações dos agentes com base em eventos configurados, como webhooks recebidos ou agendamentos.
| Método | Endpoint | Descrição |
|---|---|---|
POST | /api/agent-base/triggers/{triggerId}/execute | Executar trigger manual |
GET | /api/agent-base/triggers/manual/version/{versionId} | Listar triggers manuais de uma versão |
GET | /api/agent-base/triggers/{triggerId} | Obter detalhes de um trigger |
Quando usar: para executar triggers manualmente, listar triggers disponíveis para uma versão de workflow ou consultar detalhes de um trigger específico.
Webhooks
Seção intitulada “Webhooks”Webhooks permitem que sistemas externos enviem eventos ao Prodgy, disparando ações automáticas nos agentes.
| Método | Endpoint | Descrição |
|---|---|---|
POST | /api/webhook/{caminho} | Receber evento via webhook |
POST | /api/communicator/webhook/{id} | Webhook de comunicadores (Slack, Google Chat) |
POST | /api/communicator/botframework/{id}/messages | Webhook do Microsoft Teams |
Quando usar: para integrar pipelines de CI/CD, receber notificações de ferramentas externas ou conectar plataformas de comunicação.
Chat com Base de Conhecimento
Seção intitulada “Chat com Base de Conhecimento”Converse com a base de conhecimento do workspace via IA, com respostas em tempo real via streaming (Server-Sent Events). Suporta histórico de conversa por sessão.
| Método | Endpoint | Descrição |
|---|---|---|
POST | /api/assistant/chat | Enviar mensagem e receber resposta via SSE |
GET | /api/assistant/chat/history | Obter histórico de uma sessão |
Autenticação: Token de API do workspace (X-API-Token ou Authorization: Bearer prodgy_*).
Exemplo com cURL:
curl -N -X POST https://<instancia>/api/assistant/chat \ -H "X-API-Token: prodgy_<token>" \ -H "Content-Type: application/json" \ -d '{"message": "Como funciona o onboarding?", "session_id": "minha-sessao-01"}'
Eventos SSE retornados:
| Evento | Descrição |
|---|---|
session | ID da sessão (para continuar a conversa) |
thinking | IA processando a mensagem |
ai_response | Resposta da IA com fontes e metadados |
error | Erro durante processamento |
done | Stream finalizado |
Quando usar: para integrar chat com IA em aplicações externas, construir chatbots customizados ou criar interfaces de perguntas e respostas baseadas na base de conhecimento do workspace.
Storage (Arquivos e Knowledge Base)
Seção intitulada “Storage (Arquivos e Knowledge Base)”Gerencie arquivos da base de conhecimento — upload com chunking e geração de embeddings automáticos, download, exclusão e listagem.
| Método | Endpoint | Descrição |
|---|---|---|
POST | /api/knowledge-base/storage/upload | Upload de arquivo (faz chunk + embeddings) |
GET | /api/knowledge-base/storage/file/{id}/download | Download de arquivo |
DELETE | /api/knowledge-base/storage/file/{id} | Excluir arquivo |
GET | /api/knowledge-base/storage/{knowledgeBaseId} | Listar itens de uma knowledge base |
Quando usar: para enviar documentos à base de conhecimento de forma programática, baixar arquivos armazenados ou gerenciar o conteúdo das bases de conhecimento via automação.
Tokens de API
Seção intitulada “Tokens de API”Gerencie tokens de acesso programaticamente. Esses endpoints requerem autenticação JWT (sessão de usuário).
| Método | Endpoint | Descrição |
|---|---|---|
POST | /api/api-tokens | Criar token |
GET | /api/api-tokens/product/{productId} | Listar tokens do workspace |
GET | /api/api-tokens/{id} | Obter token por ID |
PUT | /api/api-tokens/{id} | Atualizar token |
POST | /api/api-tokens/{id}/revoke | Revogar token |
POST | /api/api-tokens/{id}/renew | Renovar expiração |
POST | /api/api-tokens/{id}/regenerate | Regenerar token |
DELETE | /api/api-tokens/{id} | Excluir token |
GET | /api/api-tokens/{id}/audit-logs | Consultar logs de auditoria |
GET | /api/api-token/auth/validate | Validar token |
Paginação
Seção intitulada “Paginação”Alguns endpoints suportam paginação via query parameters:
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
page | integer | 1 | Número da página |
pageSize | integer | 50 | Itens por página |
limit | integer | 100 | Limite alternativo de resultados |
Referência Completa
Seção intitulada “Referência Completa”Para consultar todos os parâmetros, tipos de dados, exemplos de request/response e testar endpoints diretamente no navegador, acesse a documentação interativa:
Documentação Swagger