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 |
A unique numeric interaction identifier from eGain.
The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.
Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.
The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.
A unique interaction identifier from other CRM applications.
Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.
The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.
curl -i -X GET \
'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/articlelists?%24lang=en-US' \
-H 'Accept-Language: en-US' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'x-egain-activity-id: 59237' \
-H 'x-ext-integration-id: string' \
-H 'x-ext-interaction-id: string'{ "articleList": [ { … }, { … }, { … } ] }
The Get Article Lists by ID API returns the details of a quick access Article list that is configured for a portal.
Only those articles in the quick access list articles are returned and are:
The ID of the portal being accessed.
A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
The ID of the topic. It is used to restrict to a specific topic.
The attributes of an Article to be returned in addition to the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.
These Article attributes are always returned:
| Name | Description |
|---|---|
| id | The ID of the Article. |
| name | The name of the Article. |
| articleType | The Article Type and its attributes. |
| createdBy | The ID, first name, middle name and last name of the user that created the Article. |
| createdDate | The date that the Article was created. |
| hasAttachments | True: The Article has one or more attachments. False: The Article does not have any attachments. |
| languageCode | The language code of the Article language. |
| modifiedBy | The ID, first name, middle name and last name of the user that last modified the Article. |
| modifiedDate | The date that the Article was last modified on. |
| link | The link object, used to retrieve the details of the Article. |
| versionId | The ID of the Article version that is returned. |
An additional attribute to be returned.
Additional attributes to be returned.
All additional attributes to be returned.
A unique numeric interaction identifier from eGain.
The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.
Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.
The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.
A unique interaction identifier from other CRM applications.
Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.
The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.
curl -i -X GET \
'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/articlelists/PROD-12345?%24filter%5BtopicId%5D=PROD-1067&articleResultAdditionalAttributes=averageRating&%24lang=en-US' \
-H 'Accept-Language: en-US' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'x-egain-activity-id: 59237' \
-H 'x-ext-integration-id: string' \
-H 'x-ext-interaction-id: string'Success
The ID of the article list.
An article list ID is either a 4-digit number or composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
The description of the article list. The maximum allowed article list description size is 1 KB.
An array of articles that belong to the article list.
{ "name": "Lending", "typeId": "50", "description": "Lending related articles in KB", "articles": [ { … } ], "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PROD-1000/articlelists/PROD-3258?%24lang=en-US" }, "id": "PROD-3258" }