Add AI Search to your Next.js app
What is Next.js
Next.js is a React full-stack app development framework. You can use Inkeep's React component library to Add AI Search & Chat functionality to apps or documentation and marketing sites built with Next.js.
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.
- Specify a URL for where this integration will be used.
- For production API keys, leave Enforce referrer URL checked.
- Click on Create
- Click the Example < /> button to get your API key and view suggested settings
For local or staging API keys, see here.
Copy and add the apiKey
, integrationId
and organizationId
to your environment variables:
Install the component library
Customize your settings
Create a useInkeepSettings.ts
file that will contain a hook that will return the configuration for Inkeep component(s).
Make sure to add your Inkeep identifiers to your environment settings.
Define the component
Next, create an InkeepSearchBar.tsx
component file for our Search Bar
component.
For Next.js apps that use App Router, use the "use client"
directive at the top of the file to load the widget client side.
For a full list of customizations, check out the Search Bar documentation.