Add an Embedded AI Chat to your ReadMe docs

What is ReadMe

ReadMe is a platform for creating interactive API documentation.

If your pricing tier does not include custom JS, you can instead create a dedicated standalone page as part of your landing page site or application and add an Ask AI link to it from the ReadMe navigation bar.

Get an API key

1. Go to the Inkeep Dashboard
2. Select your project under Projects
3. Go to the Integrations tab
4. Click on Create integration
5. Select Web
6. Provide a Name.
7. Specify a URL for where this integration will be used.
8. For production API keys, leave Enforce referrer URL checked.
9. Click on Create
10. Click the Example < /> button to get your API key and view suggested settings

For local or staging API keys, see here.

Create a standalone chat page

Use the following guides to create a standalone chat page:

• React

• Javascript

Create 'Ask AI' navigation link

1. Navigate to Appearance tab and open Site Navigation.

2. Click on the Add link button and select Link URL from the dropdown.

3. Add the url for your Ask AI page.

4. Press Save to apply your settings.