Knowledge Folder API Overview
List, share, rename, upload, manage, and search Knowledge bases programmatically
The Knowledge Folder API lets you list Knowledge bases a workspace key can use, manage access, and rename them. You can also upload, manage, and search files programmatically. Uploaded files are processed, embedded, and made available for semantic search. The API manages resources that appear as Knowledge bases in the Library.
Before You Start
- API key scope: Requires an API key with the
KNOWLEDGE_FOLDER_APIscope. The Knowledge base must be shared with the API key, and write operations require the Editor role. Use List Knowledge bases to discover ids the key can already use. See Share Knowledge bases with the API.
Base URL
https://api.ajan.ioAvailable Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET | /knowledge | List Knowledge bases |
POST | /knowledge/{folderId}/access | Grant Knowledge base access |
PATCH | /knowledge/{folderId}/access | Change Knowledge base access |
DELETE | /knowledge/{folderId}/access | Revoke Knowledge base access |
PATCH | /knowledge/{folderId}/folder | Update a Knowledge base |
POST | /knowledge/{folderId} | Upload a file to a Knowledge base |
GET | /knowledge/{folderId}/list | List files in a Knowledge base |
PATCH | /knowledge/{folderId} | Update a file in a Knowledge base |
DELETE | /knowledge/{folderId}/{attachmentId} | Delete a file from a Knowledge base |
POST | /knowledge/search | Search across Knowledge bases |
Guides
- Share Knowledge bases with the API: create an API key and share a Knowledge base with it