Guide
Tip
API tokens allow external applications to securely connect to Prodgy, accessing resources such as agents, integrations, and knowledge base via REST API.
API tokens are authentication credentials that allow external systems to access product resources via API. Each token is linked to a specific product and can be configured with an expiration date.
To manage a workspace’s API tokens:
Go to the workspace configuration page (gear button in the navbar)
Click the API Tokens tab
To create a new API token:
Click Create Token
Fill in the fields:
Field Required Description Token name Yes Custom identifier for the token Expiration No Expiration date and time (optional)
Click Create
The full token will be displayed in the dialog
Each token is displayed as a card with the following information:
Information Description Name Token identifier Prefix First 8 characters of the token (e.g., prod_abc...) Created at Creation date and time Expiration Expiration date and time, or “Never” if not set Usage Number of API calls made with the token Status Active or Inactive
Each token has the following actions:
Action Description Copy Copies the token prefix to the clipboard Regenerate Generates a new token, invalidating the previous one Activate/Deactivate Toggles the token status between active and inactive Revoke Permanently deactivates the token
Status Description Active Functional token, can be used for API calls Inactive Deactivated token, does not accept API calls Expired Token past expiration date (automatically inactive) Revoked Token was explicitly revoked by the user
With a valid API token, you can access the following resources:
Resource Endpoint Operations Agents /api/agent-baseList, install, update, delete Agent Executions /api/agent-base/{id}/executionsList Webhooks /api/webhook/*Send events Integrations /api/integrations-baseList, create, update, delete Knowledge Base /api/knowledge-baseList, search Triggers /api/agent-base/triggersList, execute, details Assistant Chat /api/assistant/chatChat (SSE), history Storage /api/knowledge-base/storageUpload, download, delete, list
Never share tokens in public repositories or source code
Use descriptive names to easily identify the purpose of each token
Configure expiration dates whenever possible
Revoke tokens that are no longer in use
Use one token per application for easier tracking and revocation