IntegrationsRedoclyApi docs

Add Chat Button to Redocly API Reference

Integrate Inkeep's chat button into your Redocly API Reference for real-time API documentation assistance.

Overview

The Redocly API registry offers API reference docs generated from OpenAPI definitions.

Get an API key

Follow these steps to create an API key for your web integration.

Load the script files

Add the below scripts to the index.html file:

<script
  src="https://cdn.jsdelivr.net/npm/@inkeep/cxkit-js@0.5/dist/embed.js"
  type="module"
  defer
></script>
<script src="addInkeep.js" type="module" defer></script>

Create the addInkeep.js script

Create an addInkeep.js file in your docs folder.

touch docs/addInkeep.js

Now, configure the chat button component.

addInkeep.js
// Initialize the widget using the Inkeep.ChatButton() function.
const inkeepWidget = Inkeep.ChatButton({
  baseSettings: {
    apiKey: "INKEEP_API_KEY", // required
    primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
    organizationDisplayName: "Inkeep",
    // ...optional settings
  },
  modalSettings: {
    // optional settings
  },
  searchSettings: {
    // optional settings
  },
  aiChatSettings: {
    // optional settings
    aiAssistantAvatar: "/img/logo.svg", // use your own AI assistant avatar
    exampleQuestions: [
      "Example question 1?",
      "Example question 2?",
      "Example question 3?",
    ],
  },
});

For a full list of customizations, check out the Chat Button documentation.

On this page