Primeros pasosKnowledge BaseDocuments

Create knowledge base document from URL

Create a knowledge base document generated by scraping the given webpage.

Encabezados

xi-api-keystringOpcional

Solicitud

This endpoint expects an object.
urlstringRequerido
URL to a page of documentation that the agent will have access to in order to interact with users.
namestringOpcional>=1 character

A custom, human-readable name for the document.

parent_folder_idstringOpcional
If set, the created document or folder will be placed inside the given folder.
enable_auto_syncbooleanOpcionalValor predeterminado: false

Whether to enable auto-sync for this URL document.

auto_removebooleanOpcionalValor predeterminado: false

Whether to automatically remove the document if the URL becomes unavailable. Only applicable when auto-sync is enabled.

minimum_frequency_daysintegerOpcional1-180

Minimum frequency (in days) at which the document is refreshed. The actual interval may be shorter, never longer. Defaults to 7, tightened to the parent folder’s frequency if that is stricter. Only applicable when auto-sync is enabled.

Respuesta

Successful Response
idstring
namestring
folder_pathlist of objectsOpcional
The folder path segments leading to this entity, from root to parent folder.

Errores

422
Documents Create from URL Request Unprocessable Entity Error