Skip to content
DashboardWebsite

Support Assistant

Just want to do it in the dashboard? See the guide: Ask the support assistant or Turn on the support assistant.

The support assistant answers members’ questions in the dashboard using the documentation and read-only information about their org. Platform admins decide whether orgs can use it. Org admins choose its LLM connection and model and turn it on.

It uses each member’s permissions and never changes anything. It runs on the org’s LLM connection, and its calls count against the org’s monthly LLM budget. If it cannot answer, the member can send the conversation to support.

  1. Platform admin: allow it. In the dashboard: Platform Admin → Analysis → Support Assistant. Turn on Offer the support assistant (support.enabled). Set Support address (support.contact_email) to show the Contact support button. Without an address, members cannot escalate.

  2. Org admin: configure it. In the dashboard: Organization → Connections → Support Assistant. Choose an LLM connection and model, turn on Offer the support assistant, then select Save. A small, inexpensive model is enough.

When the assistant is available, members see a Help button in the dashboard header.

Platform admins can also change the deployment settings through PATCH /v1/admin/settings, using fields such as support_enabled and support_contact_email. Org admins can read and replace their settings with GET and PUT /v1/orgs/{org_id}/support-settings.

For each question, the assistant can search the docs and call these read-only tools. It runs a tool only when the member has the permission required for its dashboard page. Otherwise, it says who can check the information.

ToolReadsPermission
whoamiThe member’s org and roleNone
list_jobs, get_jobThe org’s latest analysis jobs, including status and errorjobs:list, jobs:read
list_llm_connectionsLLM connections: kind, address, enabled status, and whether a key is set. It never reads the key.llm_connections:read
list_packsInstalled packs and packs enabled for the organalysis:read
findings_summaryFinding counts by status and severity over the last 30 daysfindings:summary
integration_statusWhether GitHub, GitLab, and Jira are connected, and their review modelintegrations:manage

An answer links only to documentation pages returned by a search for that question.

A question uses up to support.max_steps model calls (6 by default). Each call returns one step, such as a docs search, a tool call, or an answer. Calls are recorded on the Usage page with the purpose support-assistant. If the monthly budget is spent, the assistant stops and reports that it cannot answer.

When the assistant cannot settle a question, it drafts a summary of the question, what it checked, and what remains unknown. The member can edit the summary and select Send to support. OpenTremor emails the summary and conversation to the support address. Nothing is sent until the member selects Send to support.

A platform admin can also download the deployment’s diagnostics: component versions and health check results. The full support bundle is not attached to the assistant’s email because it contains deployment configuration and data from other orgs. A platform admin can download it under Platform Admin → System → General → Download diagnostics and attach it to a support request.

For a self-hosted deployment, set the support address to your own help desk.

Only the member who started a conversation can see it. OpenTremor deletes it 30 days after its last message (support.conversation_days). The org export includes conversations, and closing the org deletes them.

The assistant searches support-index.json, which the docs build writes next to the pages. By default, it reads https://docs.opentremor.dev/support-index.json. A deployment without internet access can set support.docs_index_url to its own docs service, for example http://docs.internal.example/docs/support-index.json. The assistant reloads the index every 24 hours. If it cannot load the index, it answers from the org’s state alone.

KeyDefaultMeaning
support.enabledfalseWhether orgs may turn on the assistant
support.contact_emailNoneAddress for emailed escalations
support.docs_index_urlhttps://docs.opentremor.dev/support-index.jsonURL of the docs search index
support.conversation_days30Days a conversation is kept after its last message
support.max_steps6Maximum model calls per question