Expose

Exposing an AI Assistant means making it reachable outside the QAnswer app — as a chat widget on your website, as a public link you can send to anyone, as a REST API for your own code, or through a tool your team already uses such as Slack or Confluence. Everything you need sits on the assistant's Expose tab.

Opening the Expose tab

Open an AI Assistant, then select Expose in the bar at the top of the assistant's page, next to Chat and Analytics.

The Chat, Analytics and Expose tabs on an AI Assistant's page
Note
The Expose tab is only available to users with write access to the assistant. With read-only access the tab is hidden.

The Expose page

The Expose page lists every available channel as a card. Selecting a card opens a short, numbered installation guide for that channel; the "Go Back" link at the top returns you to this list.

The Expose page showing the AI Assistant Library card and the built-in QAnswer channels
  • AI Assistant Library — publishes the assistant in the public QAnswer library so anyone can find and use it. This card is only shown to platform administrators.
  • Expose using QAnswer — the built-in channels, which need no external tools or accounts.
  • Third-party integrations — ready-made connectors for the platforms your team already works in.

Built-in channels

The channels under "Expose using QAnswer" are hosted by QAnswer itself:

  • Website chatbot — a chat-like widget you drop into any website with a script snippet.
  • Chat interface — a full-page public chat, shared as a link.
  • Search interface — a full-page public search over the assistant's data, shared as a link.
  • Report Generator — a public version of one of your report templates that other people can fill in and run.
  • REST API — programmatic access to the assistant for your own applications.
  • SPARQL interface, Entity linker interface and AI Spreadsheet — public interfaces for the corresponding specialised task types.
Warning
Which cards appear depends on the assistant's task type. A Chat assistant offers the website chatbot, the chat interface and the REST API; a Search assistant offers the search interface; a Report Generator assistant offers the report generator. Third-party integrations are only listed for Chat assistants. Change the task type under Task Type on the General tab of the assistant editor.

Third-party integrations

Below the built-in channels, the Third-party integrations section connects the assistant to an external platform. Most of these wrap the same website-chatbot widget in the host platform's own way of adding custom code.

The Third-party integrations card grid on the Expose page

Each card opens step-by-step instructions for that platform. The dedicated pages in this section of the documentation cover them in detail.

Access is set once, for the whole assistant

Every built-in channel contains the same "Choose your access" step. It is an assistant-level setting: whatever you pick there applies to all of the assistant's interfaces at once, not just the one you are configuring. It offers these options:

  • Public — anyone can use the assistant, without logging in or an API key.
  • Logged-in users — anyone with an account on this QAnswer platform, once logged in. The website chatbot does not offer it, since visitors to your website are not logged in to QAnswer.
  • Only with an API key — the assistant stays private and the integration gets in with an API key: one of the assistant's existing keys, or a new one generated on the spot.
Note
Below the options, a status message says whether the integration is ready. Until it is, the later steps of each guide — the export snippet and the public link — stay greyed out. Sharing with specific users, teams or organisations is separate and lives in the Share dialog opened from the Share button in the assistant's top bar.

The Expose add-on

Reaching an assistant from outside QAnswer requires the Expose add-on on the organization that owns the assistant. Without it:

  • the Expose page shows an "Expose add-on required" notice, and every channel card carries an "Expose add-on" badge. The channels still open, but read-only: each shows the same notice above its guide, and every step is greyed out and cannot be changed;
  • the assistant's API keys are refused: every widget, link, REST call or third-party integration that uses one gets HTTP 403 and the message "This API key belongs to an assistant whose organization does not have the Expose add-on, so it cannot be used outside QAnswer." The keys are not deleted and work again as soon as the organization has the add-on.
The Expose page of an assistant whose organization lacks the Expose add-on: the "Expose add-on required" notice with its "Get the add-on" button, above the channel cards, each with an "Expose add-on" badgeA channel guide opened without the Expose add-on: the "Expose add-on required" notice above the API access guide, which is greyed out so that no key can be generated

Sharing the assistant with users, teams and organizations inside QAnswer is not affected, and neither are assistants that belong to no organization.

Note
The notice's Get the add-on button opens the organization's billing page, where an organization admin can add Expose. See Plans & Billing.
Note
To create an AI Assistant first, see the Create an AI Assistant section.