Webflow
Add AI Search to your Webflow site
What is Webflow
Webflow is a visual web development platform that enables users to design, build, and launch websites without the need for coding.
Get an API key
- Go to the Inkeep Dashboard
- Select your project under Projects
- Go to the Integrations tab
- Click on Create integration
- Select Web
- Provide a Name and URL (optional) for the integration
- Click on Create
- Click the Example < /> button to get your API key and view suggested settings
Connect the script
- Navigate to Site settings (not the designer)
- Open the Custom code tab
- Add the below to the Head code section
<script id="inkeep-script" src="https://unpkg.com/@inkeep/uikit-js@0.3.12/dist/embed.js" type="module" defer></script>
Creating the container
Next, you need to add a container for the widget. You can do this using the built-in Webflow designer.
Add the placeholder
Add a container to your navigation bar where the search bar will be placed:
Set the container ID
Set the ID of the container to inkeepSearchBar
:
Configure the widget
Go back to Site settings and navigate to Custom code. Add the below in the Footer code section.
<script type="text/javascript" defer>
const widgetContainer = document.getElementById("inkeepSearchBar");
const addInkeepWidget = function () {
const inkeepScript = document.getElementById("inkeep-script");
inkeepScript.addEventListener("load", () => {
const inkeepWidget = Inkeep().embed({
componentType: "SearchBar",
targetElement: widgetContainer,
properties: {
baseSettings: {
apiKey: "INKEEP_API_KEY", // required
integrationId: "INKEEP_INTEGRATION_ID", // required
organizationId: "INKEEP_ORGANIZATION_ID", // required
primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
organizationDisplayName: "Inkeep",
// ...optional settings
theme: {
stylesheetUrls: ['/path/to/stylesheets'], // optional
// ...optional settings
},
},
modalSettings: {
// optional settings
},
searchSettings: {
// optional settings
},
aiChatSettings: {
// optional settings
botAvatarSrcUrl: "https://mydomain.com/mylogo", // use your own bot avatar
quickQuestions: [
"Example question 1?",
"Example question 2?",
"Example question 3?",
],
},
},
});
});
};
addInkeepWidget(); // initialize the widget
</script>
Press Save to apply your settings.
For a full list of customizations, check out the Search Bar documentation.