AI app on Vareons: install, usage dashboard, and provider keys
The AI app is the id ai-copilot marketplace card opening /dashboard/ai-usage: a token-monitoring dashboard for the month and last thirty days with prompt logs, CSV export, insights, and tool audit, plus a separate provider-keys page for saving and testing.
Last verified: 2026-09-19
The app installs from the /dashboard/apps marketplace with an Install button on the "Artificial Intelligence" card marked Featured and described as the AI Copilot assistant, after which an Open button leads to /dashboard/ai-usage. The card carries a Free badge because the catalog billing type is free.
The usage dashboard starts with a "System Performance" header describing real-time token monitoring, a "Last 30 Days" button toggling between month and thirty-day windows, an "Add API Key" button navigating to /dashboard/ai-usage/api-keys, and an "Export Report" button downloading the ai-copilot-usage-30d.csv file. Four KPI cards follow: total tokens used, total cost (shown as a dash with a pricing-integration-pending note), average tokens per request, and active models.
The logs table shows the AI prompt, output result, tokens, model, and time and date, with All-logs, High-usage, and Errors filters and five items per page, followed by a "Copilot tool audit" table with tool, duration, outcome, and confirmation (Yes or No), then a token-usage-distribution chart and an "Enterprise Insights" panel with the efficiency score. Data loads through five parallel requests — summary, prompts, insights, distribution, and tool audit — against GET /api/ai-copilot/usage/* endpoints.
The keys page is titled "AI Copilot provider keys" with a provider list (OpenAI and others), a paste-key field, a save button, a saved-or-not-configured status with masked preview, and a per-row test-connection button. Saving first requests a challenge through GET /api/ai-copilot/settings/challenge, then posts to POST /api/ai-copilot/settings with provider, key, and challenge, so the key is encrypted in a per-tenant AES-256-GCM envelope and never displayed in full.
Data is stored in the AICopilotPromptLog model for prompts, exports, and insights, AICopilotUsageRollup for summaries, and AICopilotTenantKey for encrypted keys, alongside key audit logs, confirmation tokens, server sessions, and live-editor drafts.
Setup steps in Vareons
Install the app from the marketplace
Open /dashboard/apps, press Install on the AI card, then press Open to reach /dashboard/ai-usage.
Monitor the usage
Review the KPI cards and the logs table with its filters and pagination, and switch the range between month and thirty days.
Export the report
Press Export Report to download a CSV of the selected period's requests for external review or archiving.
Add a provider key
From the Add API Key button go to the keys page, pick the provider, paste the key, then save.
Test the connection
After saving, press Test connection per provider to confirm the key works before relying on it.
Frequently asked questions
Is the AI app free?
Yes, the card carries a Free badge in the marketplace and installation needs no purchase. External provider keys follow their own providers' pricing.
Why does the cost show a dash?
Because pricing integration is currently pending; the card shows a dash with that note while token numbers stay accurate.
How do I export the usage log?
From the Export Report button the dashboard downloads an ai-copilot-usage-30d.csv file with the selected period and filter.
Is my full key shown after saving?
No, only a masked preview appears with a saved status; the full key is encrypted in a per-tenant envelope and never displayed.
What is the tool audit table?
A log of the last twenty Copilot tool executions showing tool, duration, outcome, and confirmation state (Yes or No) for reviewing what the assistant did.
Troubleshooting
1) Empty dashboard: confirm the app is installed and refresh; data loads through five parallel requests. 2) Key save fails: retry; saving needs a fresh challenge from GET /api/ai-copilot/settings/challenge. 3) Connection test fails: re-copy the complete key from the provider dashboard and check for stray spaces. 4) CSV not downloading: try a narrower filter or shorter range, then export again.
Important limitations
• Total cost is indicative and pending pricing integration. • Prompt logs paginate at five items per page. • Tool audit keeps only the last twenty executions. • Keys are per-tenant and never shared across stores.