AI Assistant

The AI Assistant is a chat panel in the editor that can draft, edit, organize, and publish content across your documents from a plain-language request. For example, you can ask it to "draft a getting-started guide for our API", "rewrite the troubleshooting topics in a friendlier tone", or "move all release notes into a Release notes folder". It can also read web pages, images, and your published knowledge base to ground what it writes.

Category: Authoring · Status: Beta · Plan: all plans · Requires: nothing

Turn on the AI Assistant

The AI Assistant needs two steps: installing the addon and switching it on.

1. An Owner or Admin installs AI Assistant from the Addons page.
2. The Owner opens Organization Settings and selects the AI Assistant tab, which appears once the addon is installed.
3. Turn on Enable the AI assistant for this organization.
4. Under AI provider, choose the AI model provider that powers the assistant: OpenAI (the default), Gemini, Claude, or FlowKoi. Sonat manages the API keys, so you don't need an account with the provider.
5. Select Save.

Use the assistant

1. Select the robot icon (AI Assistant) in the top bar, or the round robot button in the lower-right corner. The panel opens on the right side of the page.
2. Check the Working on chip at the top of the panel. It shows what the assistant focuses on: the open topic, the open document, or All documents.
3. Type your request and press Enter. Use Shift+Enter for a new line. If you aren't sure where to begin, pick a suggestion under Start with, such as Draft a new document or Publish my drafts. A suggestion fills in the message box so you can adjust it before sending.
4. Follow the progress in the activity card, which lists each step the assistant takes, such as "Drafted Installation" or "Published Installation". When the run ends, the What changed card lists every topic it touched, with Open and View live links.

To stop a run, select Stop. Steps that already finished are kept, and nothing more is written.

The Advanced switch at the top of the panel uses a slower, more capable agent. Turn it on for complex or long tasks where quality matters more than speed.

You can also ask a question from the editor's global search: type your question and choose Ask AI about "…". The answer comes from your published documentation.

How changes are applied

The assistant applies most changes to your documents directly, including publishing when you ask it to. The exception is the topic you have open: if a rich text, Markdown, or Custom HTML topic is open, changes to that topic come back as a proposed change for you to review first. You apply or discard it the same way as in the AI Editor. Changes to any other topic are applied directly.

Because the assistant can publish, ask it to leave topics as drafts if you want to review them before readers see them. Every change is recorded in each topic's version history, so you can revert it.

Permissions

Any member of your organization can use the assistant. It never does more than the person using it could do, and it never acts with more than Writer permissions. For example, a Reader's assistant can read and answer questions, but it can't change content.

Limits

• A single request can take about 80 steps. If a large task reaches that limit, the assistant says so. Reply "continue" and it picks up where it left off.
• If a reply is cut off because it is too long, reply "continue" to get the rest.
• The AI can make mistakes. Review what it writes before you publish important content.

If you need a person, select Support team in the panel to open live chat.

If you uninstall it

The robot icon, the floating button, the Ask AI search option, and the AI Assistant settings tab disappear. The AI Editor, Proofread, and Custom HTML addons depend on the AI Assistant, so they are uninstalled too. Content the assistant created stays as it is, and your provider choice is kept for when you reinstall.

Troubleshooting

• "The AI Assistant add-on isn't installed for your organization." Ask an Owner or Admin to install it from the Addons page.
• "Your organization hasn't turned on the AI Assistant." Ask the Owner to switch it on in Organization Settings > AI Assistant.
• "Could not save AI assistant settings." Only the organization's Owner can change these settings.