Get an External Source

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

Access and Registration

Authentication

Scope

km-external-sources:read

Body Response

200 (The details of the specified external source)

ParameterTypeDescription
detailsobjectSpecific details of the knowledge base.
"details" subdivides into:
    • "description" (string) - The description of the knowledge base.
      Example: This is a description.
    • "knowledge_type" (string) - The type of the external source.
      <= 255 characters Allowed value: CUSTOM
      Example: CUSTOM
    • "name" (string) - The name of the external source. Example:
      External source XPTO.
    • "knowledge_segments" (string) The knowledge segments of the external source, separated by commas. Example: sales, vip.
    • "ring_groups"(array [string]) - The ring groups associated with the external source. Example: ["agents"]
    • "metadata" (dictionary [string]) A set of arbitrary key-value pairs with additional data about the external source. Example:
      {"third_party_id":"ded93bd5-d854-4078-839a-9ef5779865a5","source":"Custom External"}
idstringThe ID of the external source.
Example: 486d70ae-62ad-4115-a1fd-39ceb87aaa5d
enabledbooleanDetermines if the data source should be indexed or not.

401 (unauthorized), 403 (forbidden), 404 (not found), 500 (internal server error)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]

"fields" subdivides into:

"name" (string)

"description" (string)

yes (name and description)
🚧

Troubleshooting

If 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.

Path Params
string
required
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json