Embed Your Docs
Show your docs pages and AI Assistant inside your own product, so users get help without leaving the screen they're on.
The embed puts your Documentation.AI docs and AI Assistant inside your own product or website. Users read a docs page, or ask a question, without leaving the screen they're on.
What you can add
Docs in your page
A docs page inside any screen of your product, at its full height.
AI chat
Answers from your docs, with citations, right in your page.
Help button and Ask AI bar
A floating panel that opens from a button or a question bar.
Help links
Any button or link in your product opens the right docs page beside it.
How it works
- Create an embed key in the dashboard. Its publishable key goes in your page and works only on the sites you list.
- Add the script to your page and call
init()with the key. - Place widgets: docs pages, the AI Assistant, or both.
Docs pages load from your docs site, so they look exactly like your docs. If your docs have private pages, your server also signs users in. See Private docs.
What you need
- A published Documentation.AI docs site.
- The Admin role in your Documentation.AI organization, to create embed keys.
- If your docs are served at a path on your own domain, such as
example.com/docs, a few extra rules in your reverse proxy. See Docs on a subpath.