Appendix

Appendices

Appendix A: Complete API Reference (summary)

Auth legend: K = API Key, J = JWT, A = Admin, Anon = AllowAnonymous, D = Delegation, HMAC = webhook signature, T = MCP controller token.

Method	Endpoint	Auth	Purpose
GET	/health	Anon	Liveness
GET	/api/features	Anon	Capability flags
GET	/api/auth/options	Anon	Login modes
POST	/api/auth/login	Anon	Local login
GET	/api/auth/google	Anon	Google OAuth start
POST	/api/auth/refresh	Anon	Refresh JWT
POST	/api/auth/logout	Anon	Revoke refresh
POST	/api/auth/apikey	J	Create API key
GET	/api/auth/apikey	J	List API keys
PUT	/api/auth/changepassword	J	Change password
POST	/api/ai/query	K	Text query
POST	/api/ai/queryImage	K	Vision
POST	/api/ai/queryDocument	K	Document Q&A
POST	/api/ai/queryAudio	K	Batch STT
WS	/api/ai/realtime/transcribe	K	Live STT
POST	/api/ai/chat	K	Chat + MCP/KB
POST	/api/ai/vote/{requestId}	K	Feedback
POST	/api/ai/vote/chat/{chatId}/{messageIndex}	K	Chat feedback
GET	/api/ai/logs	K	Project logs
GET	/api/ai/assistants	K	Azure assistants
GET	/api/ai/download-blob / /view-blob	K	Blob access
GET/POST	/v1/models, /v1/chat/completions, /v1/audio/transcriptions, /v1/embeddings	K	OpenAI compat
GET	/api/chat/sessions, /api/chat/conversation/{id}	J/K	Chat history
GET	/api/chatadmin/…	A	Admin chat history
CRUD	/api/project…	J/A	Projects & members
*	/api/projects/{id}/federation/…	A	Federation
POST	/api/delegations/exchange	K	Delegation token
CRUD	/api/prompt…	J/A	Prompts
CRUD	/api/provider…	J/A	Providers
CRUD	/api/knowledge-bases…	A	Internal KB admin
GET	/api/projects/{id}/knowledge-bases	J	KB picker
CRUD	/api/mcp-servers…	J/A	MCP servers
*	/api/mcp-catalog…	A	Catalog
*	/api/mcp-servers/{id}/definition…	A/J	Definitions & creds
*	/api/mcp-instances…	J/D	Managed instances
*	/api/mcp-runtime…	A	Runtime profiles
*	/api/mcp-runtime-proxy/{id}/mcp/	T	Data plane
*	/api/integrations…	J	User OAuth/PAT
CRUD	/api/agents…	J/A	Agents & grants
CRUD	/api/agent-environments…	A	Environments
*	/api/agent-runs…	A	Headless runs + SSE
*	/api/sessions…	J	Interactive sessions + SSE
*	/api/scheduled-tasks…	J	Autonomous tasks
*	/api/automations…	J	Automations & grants
*	/api/automation-events…	J	Event inbox / test
*	/api/automation-approvals…	J	Approvals
POST	/api/integration-events/{provider}/{connectionId}	HMAC	Webhook gateway
*	/api/integrations/pipedream…	J	Pipedream Connect
*	/api/integrations/github…	J	GitHub App
GET	/api/cost/…	J	Cost analytics
GET	/api/dashboard/…	J	Dashboard
GET	/api/security/status	A	Security status
POST	/api/security/csp-report	Anon	CSP reports

Appendix B: Rate Limits

Default: no global platform rate limit is guaranteed in every deployment. Automations expose maxEventsPerHour / maxConcurrentRuns per automation. Clients should still implement polite client-side throttling and backoff on 429/503.

Appendix C: SDK Libraries

Language	Suggestion
C#	Official Kroov.Sdk NuGet (v3.0+) — AI, MCP, agents, sessions, automations, Pipedream; see src/Kroov.Sdk/README.md
JavaScript/TypeScript	fetch / axios
Python	requests / httpx
Any OpenAI SDK	Point base URL at {host}/v1 with API key as Bearer

Appendix D: Changelog

Version	Date	Changes
2.0	Aug 2026	Full refresh: feature flags; ApiKey-only /api/ai/*; providerId on image/document; OpenAI /v1; Knowledge Bases; MCP definitions/diagnostics/proxy; Agents, presets, environments, runs; interactive sessions; scheduled tasks; automations / Pipedream / approvals / webhooks; GitHub App; federation; security/AD; corrected vote field isThumbsUp; expanded appendix
1.1	May 2026	Live realtime transcription WebSocket; optional language / auto-detect for batch and live audio
1.0	Jan 2026	Initial API release (AI query/chat + early MCP section)

---