Skip to content

Conversation

@JulienLavocat
Copy link
Contributor

@JulienLavocat JulienLavocat commented Nov 3, 2025

Description of Changes

Following discussions about having our Inkeep's API key being public, I added a comment to all the places where we use it saying that this is OK and a link to the documentation.

As per Inkeep's documentation:

When you embed your AI assistant in websites where the user is not authenticated, like in your public docs, help center, or marketing site, the web browser is considered a "public client". Since many of these clients often don't have a backend, the most practical way to use the AI assistant is for UI components to talk directly to the Inkeep service.
While it is up to your company's own policies and best practices, in these scenarios, the Inkeep API key is generally ok to be included in the source code of your web page that is exposed in the browser. This is similar to how Algolia's search service or Sentry's error logging works.

https://docs.inkeep.com/cloud/ui-components/public-api-keys#public-clients

API and ABI breaking changes

None

Expected complexity level and risk

1

Testing

Ran the docs locally to ensure that the comment isn't visible on the markdown pages

@JulienLavocat JulienLavocat added this pull request to the merge queue Nov 4, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Nov 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants