Skip to main content

Route Reference

This page is a high-level route map. It is not a complete public API contract.

Workspace Routes

Route familyPurpose
/api/account/settingsLoad and save workspace settings.
/api/account/api-keysCreate, list, and revoke reserved workspace API keys.
/api/account/csatCompatibility analytics route returning typed survey responses.
/api/account/surveys/emailSend enabled email surveys.
/api/account/widget-analyticsLoad widget event analytics.
/api/support-agent/runsLoad support-agent run analytics.
/api/support-agentsManage workspace agents.
/api/support-agents/[id]/learnRun context learning for an agent.
/api/api-sourcesManage API context sources.
/api/clientsLoad aggregated client records.
/api/client-portal/issuesCustomer-safe portal issue list and creation for valid portal sessions.
/api/client-portal/issues/[issueId]Customer-safe portal issue detail and messages for valid portal sessions.
/api/issuesManage support issues.
/api/notesManage internal notes.

Public Routes

Route familyPurpose
/api/widget/messagesCustomer widget conversation flow.
/api/widget/eventsWidget event tracking.
/api/widget/presenceCustomer presence heartbeat.
/api/widget/csatWidget survey responses.
/api/surveys/email-responseSigned email survey response capture.
/api/email/inbound/resendInbound email webhook.
/api/discord/eventsDiscord event handling.
Routes listed here may require authentication, workspace permissions, signed tokens, provider webhooks, or public widget keys depending on the route family.