| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Scope
km-external-sources:read
Body Response
200 (List of external sources)
| Parameter | Type | Description |
|---|---|---|
| embedded | object | Contains the list of external sources. 1 - "knowledge_bases" (array)object) - List of external sources. 1.1- "details" (object) - Specific details of the external source. 1.1.1 - "description" (string) - The description of the external source. 1.1.2 - "knowledge_type" (string) - The type of the external source. 1.1.3 - "name" (string) - The name of the external source. Example: 1.1.4 - "knowledge_segments" (string) The knowledge segments of the external source, separated by commas. Example: sales,vip. 1.1.5- "ring_groups"(array [string]) - The ring groups associated with the knowledge base. Example: ["agents"] 1.1.6 - "metadata" (dictionary [string]) A set of arbitrary key-value pairs with additional data about the knowledge base. Example:
|
| count | integer | Number of external sources present in the page. |
| page | integer | Page number. |
| per_page | integer | Max number of external sources on each page. |
| total | integer | Total number of external sources. |
400 (bad request), 401 (Unauthorized access - invalid or unverifiable JWT), 403 (forbidden), 500 (internal server error)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
TroubleshootingIf you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.