Share Knowledge bases with the API

The following guide explains how to create an API key in ajan and share a Knowledge base with the API key.

Before You Start

• API key: An admin needs to create the API key and share the Knowledge base with the API key. Invite an admin as an editor to your Knowledge base with the "Share" button in the top right corner if you are not a ajan admin. A workspace admin can still grant Viewer or Editor to a workspace key when the Knowledge base already allows API search.
• Knowledge bases: The Knowledge Folder API manages resources that appear as Knowledge bases in the Library.

How to create an API key

1. Navigate to ajan

1. Navigate to the workspace settings.

1. Click on "API" under products.

1. Create a new API key.

1. Enter a name and click "Create API key"

1. Copy your API Key to the clipboard.

1. Click "Done"

1. Leave the settings by clicking on "Settings" on the top left.

How to share a Knowledge base with the API

1. Open the Library from the left sidebar, or go to Settings → Workspace → Library to manage Knowledge bases from the admin view.
2. Open the Knowledge base you want to share with the API.
3. Click Share.

1. Click the Add people and groups field.
2. Type the name of an admin and select them in the dropdown.
3. Select Editor to give them Editor permissions for this Knowledge base, then click Share.
4. Ask the admin to open the Knowledge base Share dialog.
5. In the Add people, groups and API keys field, search for the API key and select it. The key still appears when the Knowledge base already allows API search.
6. Select the API access role. Choose Viewer for search access or Editor for upload, sharing, and rename access.
7. Click Share.

To grant, change, or revoke access from an Editor workspace key, use Share Knowledge base access.