Available Endpoints

Developer

Tip

This page provides an overview of the resources available in the Prodgy API. For complete details on parameters, types, and responses for each endpoint, consult the interactive Swagger documentation.

Open Swagger UI

---

API Resources

Agents

Agents are the AI modules installed on the workspace. Through the API you can query available agents, install new agents, and get details of already configured agents.

Method	Endpoint	Description
GET	/api/agent-base/product/{productId}	List product agents
POST	/api/agent-base/install	Install an agent on the workspace
GET	/api/agent-base/{id}	Get agent details

When to use: to automate agent installation, list active agents, or integrate agent management into CI/CD pipelines.

---

Agent Executions

Executions represent agent invocations — each time an agent processes a task, an execution is recorded.

Method	Endpoint	Description
GET	/api/agent-base/{id}/executions	List executions for an agent

When to use: to monitor agent executions or build custom tracking dashboards.

---

Integrations

Integrations connect external tools (Git, DevOps, communicators, etc.) to Prodgy. The API allows you to manage these connections programmatically. Each integration has a scope: local (restricted to one product) or global (available to all workspaces).

Method	Endpoint	Description
GET	/api/integrations-base	List integrations (supports product_id query param)
GET	/api/integrations-base/{id}	Get integration details
POST	/api/integrations-base	Create integration
PUT	/api/integrations-base/{id}	Update integration
DELETE	/api/integrations-base/{id}	Delete integration
GET	/api/integrations-base/product/{productId}/active	List active integrations for a workspace

Multi-instance support: you can install multiple instances of the same integration type. When creating, send title (required display name) and optionally product_id to scope it to a specific product. The scope column is set automatically (local when product_id is provided, global otherwise). Local integrations override Global ones of the same type for AI agents (shadow mechanism).

When to use: to automatically provision integrations when setting up new workspaces or synchronize configurations between environments.

---

Knowledge Base

The knowledge base stores documents that agents use to generate contextualized responses via semantic search (RAG).

Method	Endpoint	Description
GET	/api/knowledge-base/{productId}	List knowledge bases for a workspace
POST	/api/knowledge-base/embeddings	Semantic search (vector only, no LLM)

When to use: to query the knowledge bases associated with a workspace and their documents.

---

Triggers

Triggers are automatic events that fire agent actions based on configured events, such as received webhooks or schedules.

Method	Endpoint	Description
POST	/api/agent-base/triggers/{triggerId}/execute	Execute a manual trigger
GET	/api/agent-base/triggers/manual/version/{versionId}	List manual triggers for a workflow version
GET	/api/agent-base/triggers/{triggerId}	Get trigger details

When to use: to execute triggers manually, list available triggers for a workflow version, or retrieve details of a specific trigger.

---

Webhooks

Webhooks allow external systems to send events to Prodgy, triggering automatic actions in agents.

Method	Endpoint	Description
POST	/api/webhook/{path}	Receive event via webhook
POST	/api/communicator/webhook/{id}	Communicator webhook (Slack, Google Chat)
POST	/api/communicator/botframework/{id}/messages	Microsoft Teams webhook

When to use: to integrate CI/CD pipelines, receive notifications from external tools, or connect communication platforms.

Note

For more details on webhooks, see the dedicated Webhooks page.

---

Knowledge Base Chat

Chat with the workspace’s knowledge base via AI, with real-time responses via streaming (Server-Sent Events). Supports conversation history per session.

Method	Endpoint	Description
POST	/api/assistant/chat	Send message and receive response via SSE
GET	/api/assistant/chat/history	Get session chat history

Authentication: Product API Token (X-API-Token or Authorization: Bearer prodgy_*).

Example with cURL:

curl -N -X POST https://<instance>/api/assistant/chat \
  -H "X-API-Token: prodgy_<token>" \
  -H "Content-Type: application/json" \
  -d '{"message": "How does onboarding work?", "session_id": "my-session-01"}'

SSE Events:

Event	Description
session	Session ID (for conversation continuity)
thinking	AI is processing the message
ai_response	AI response with sources and metadata
error	Error during processing
done	Stream complete

When to use: to integrate AI chat into external applications, build custom chatbots, or create Q&A interfaces based on the workspace’s knowledge base.

---

Storage (Files & Knowledge Base)

Manage knowledge base files — upload with automatic chunking and embedding generation, download, deletion, and listing.

Method	Endpoint	Description
POST	/api/knowledge-base/storage/upload	Upload file (chunking + embeddings)
GET	/api/knowledge-base/storage/file/{id}/download	Download file
DELETE	/api/knowledge-base/storage/file/{id}	Delete file
GET	/api/knowledge-base/storage/{knowledgeBaseId}	List items in a knowledge base

When to use: to programmatically upload documents to the knowledge base, download stored files, or manage knowledge base content via automation.

---

API Tokens

Manage access tokens programmatically. These endpoints require JWT authentication (user session).

Method	Endpoint	Description
POST	/api/api-tokens	Create token
GET	/api/api-tokens/product/{productId}	List product tokens
GET	/api/api-tokens/{id}	Get token by ID
PUT	/api/api-tokens/{id}	Update token
POST	/api/api-tokens/{id}/revoke	Revoke token
POST	/api/api-tokens/{id}/renew	Renew expiration
POST	/api/api-tokens/{id}/regenerate	Regenerate token
DELETE	/api/api-tokens/{id}	Delete token
GET	/api/api-tokens/{id}/audit-logs	Query audit logs
GET	/api/api-token/auth/validate	Validate token

Note

For complete details on authentication and token management, see the Authentication page.

---

Pagination

Some endpoints support pagination via query parameters:

Parameter	Type	Default	Description
page	integer	1	Page number
pageSize	integer	50	Items per page
limit	integer	100	Alternative result limit

---

Complete Reference

To consult all parameters, data types, request/response examples, and test endpoints directly in the browser, access the interactive documentation:

Swagger Documentation