API docs
Chat Button
Add AI chat to your Redocly API Registry documentation.
Overview
The Redocly API registry offers API reference docs generated from OpenAPI definitions.
Load the script files
Add the below scripts to the index.html
file:
<script src="https://unpkg.com/@inkeep/widgets-embed@0.2.278/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
// Embed the widget using the `Inkeep.embed()` function.
const inkeepWidget = Inkeep().embed({
componentType: "ChatButton",
properties: {
chatButtonType: "ICON_TEXT",
baseSettings: {
apiKey: "YOUR_API_KEY",
integrationId: "YOUR_INTEGRATION_ID",
organizationId: "YOUR_ORGANIZATION_ID",
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
botAvatarSrcUrl: "/img/logo.svg", // use your own bot avatar
quickQuestions: [
"Example question 1?",
"Example question 2?",
"Example question 3?",
],
},
},
});
For a full list of customizations, check out the Chat Button documentation.