Skip to content

Embeddable search and chat

Your users search your documents without leaving your product.

Add document search, a source viewer and grounded chat to your own product. Connect a project, mount a React component or custom element, and show every passage next to its source.

Developer previewReact, Web Components and TypeScriptPackage source on GitHub

On this page

Add it to your product

Use the prebuilt components where they fit, and keep your own layout, navigation and application logic. The Node SDK guide covers keys and uploads.

  1. Choose a surface

    Import a React component or register custom elements. One project can power search, chat and document viewing.

  2. Connect a project

    Pass your API origin, a browser key with the search scope (add chat for ChatEmbed) limited to your allowed websites, and optionally a project ID, slug or name (default: your organization's default project). ViewerEmbed takes a document ID and no key: serve it through your own same-origin, authenticated proxy. See authentication and API setup.

  3. Keep the source in view

    Show cited passages, answers and source pages without sending people out of your product. See the search and chat reference.

Choose a component

Start with one component and add the next where it helps your users.

ComponentConnects toWhat it shows
SearchEmbedLive aboveProjectRanked passages with document and page citations.
ChatEmbedProjectAn answer written from the project's documents.
ViewerEmbedDocument, through your authenticated proxyThe document's Markdown artifact (or its first artifact) with page and chunk counts, rendered inside your interface.

Live project or portable bundle. Search a live project through the API, or publish an offline search bundle with local query embeddings. See the offline search guide.

Jump to