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.
help.larkfield.example
Larkfield HelpGuidesBillingStatus
How can we help?
reset two-factor for a member
An admin can reset two-factor for a member from Settings, Members, Security.
admin-guide.pdfp. 31Members re-enroll on their next sign-in.
admin-guide.pdfp. 32Larkfield Admin GuideChapter 7
7.2 Two-factor recovery
When a member loses their device, an admin can reset two-factor from Settings, Members, Security.
The member re-enrolls on next sign-in.
31
On this page
Try it
Search our public SDK and API guides, then follow a citation to its source. This page's preview adds Markdown rendering, suggested queries and source links; the packaged SearchEmbed shows each passage as plain text with its file and page, and searches your project.
For every request and response field, see the search reference.
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.
Choose a surface
Import a React component or register custom elements. One project can power search, chat and document viewing.
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 aprojectID, slug or name (default: your organization's default project).ViewerEmbedtakes a document ID and no key: serve it through your own same-origin, authenticated proxy. See authentication and API setup.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.
| Component | Connects to | What it shows |
|---|---|---|
SearchEmbedLive above | Project | Ranked passages with document and page citations. |
ChatEmbed | Project | An answer written from the project's documents. |
ViewerEmbed | Document, through your authenticated proxy | The 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.