EmbedTroubleshooting

Troubleshooting

Find and fix embed problems, from error codes in the browser console to docs that don't appear or users who can't see private pages.

Start in your browser's console. The embed logs every problem there as [DocumentationAI] message (code), and fires the error event with the same code.

Error codes

CodeWhat it meansHow to fix it
origin_not_allowedThe page's origin isn't one of the key's allowed origins.Add the exact origin, including its port, in Settings > Embed with Edit. Changes apply within a few minutes.
publishable_key_invalidThe key is mistyped, revoked, or belongs to another docs site.Copy the key again from Settings > Embed. If it was revoked, create a new key.
publishable_key_expiredThe key's expiry date has passed.Create a new key. Expiry can't be extended.
invalid_tokenThe reader token was already used, is more than 60 seconds old, was mistyped, or was made with another embed key. On JWT sites, the JWT failed verification.Get a new token for every identify() call, and make sure your token endpoint's response isn't cached.
sign_in_not_enabledidentify() was called, but the docs site has no sign-in.If your docs are public, remove the identify() call. Otherwise set up Access Control.
auth_method_unsupportedA JWT was passed on a site that doesn't use JWT sign-in.Use a reader token.
site_not_foundYour docs site couldn't be found at its address.Check that your docs are published. On a subpath, check your proxy setup.
unexpected_errorSomething else, such as a network failure.Check your connection and your Content Security Policy.

Common problems

Still stuck?

Contact us with the console message, the page's address and your publishable key. Never send your secret key.

Next steps