The following licenses are required to use the Knowledge Access APIs:
| Tier | Tier Name | Named Users | Description |
|---|---|---|---|
| Tier 1 | Starter | Up to 10 | Designed for small-scale implementations or pilot environments |
| Tier 2 | Growth | Up to 1000 | Suitable for mid-scale deployments requiring moderate scalability |
| Tier 3 | Enterprise | Greater than 1000 | Supports large-scale environments with extended configuration options |
The following Resources have predefined limits for specific access attributes for Starter, Growth and Enterprise use.
| Resource | Limits | Starter | Growth | Enterprise |
|---|---|---|---|---|
| Article Reference | Number of attachments used in any article | 25 | 50 | 50 |
| Number of custom attributes in an article | 10 | 25 | 50 | |
| Number of publish views used in an article version | 20 | 20 | 20 | |
| Topic Reference | User-defined topics in a department | 1000 | 5000 | 50000 |
| Depth of topics | 5 | 20 | 20 | |
| Topics at any level | 500 | 2500 | 2500 | |
| Number of custom attributes in a topic | 10 | 10 | 10 | |
| Portal Reference | Tag categories in a portal | 15 | 15 | 15 |
| Topics to be included in a portal | 100 | 500 | 5000 | |
| Number of articles to display in announcements | 10 | 25 | 25 | |
| Usage links and link groups setup for a portal | 5 | 10 | 25 |
The Search API is a hybrid search service that combines semantic understanding with keyword precision to deliver fast, contextual, and relevant results from your enterprise knowledge base. It enables secure, role-aware access to articles, FAQs, and documentation across customer, agent, and employee interfaces. Each query returns a ranked list of results with snippets, metadata, and relevance scores.
The search query string. The string must be escaped as required by the URL syntax rules.
The ID of the user profile.
The language that describes the details of a resource. Resources available in different languages may differ from each other.
If lang is not passed, then the portal's default language is used.
An object where each key is a Category Tag ID (numeric string),
and each value is an array of Tag IDs for that category. Note:
An array of topic IDs. It is used to restrict search results to specific topics.
One or more comma-separated names for article custom attributes defined by the user to be returned.
Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
curl -i -X GET \
'https://api.egain.cloud/knowledge/portalmgr/v4/PROD-1000/search?q=What+is+a+loan%3F&%24filter%5BuserProfileID%5D=PROD-1030&%24lang=en-US&PROD-1234=PROD-2000%2CPROD-2003&PROD-2005=PROD-2007&%24filter%5BtopicIds%5D=string&articleCustomAdditionalAttributes=string&%24pagenum=1&%24pagesize=20' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'{ "searchResults": { "article": [ … ] } }