Primeros pasosKnowledge BaseCrawl jobs

Create crawl job

Create a crawl job to crawl the given URL with specified depth and page limits.

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.
max_pagesintegerOpcional1-10000Valor predeterminado: 1000

Maximum number of pages to crawl (1-10,000), defaults to 1000.

patternstringOpcional<=2048 characters
If set, only URLs that match this pattern are included.
sitemap_urlslist of stringsOpcional

List of URLs to crawl from sitemap (optional, overrides automatic URL discovery).

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.

auto_discoverbooleanOpcionalValor predeterminado: false

Automatically discover and add new pages linked from already-crawled pages during auto-sync. Requires enable_auto_sync=true.

minimum_frequency_daysintegerOpcional1-180

Minimum frequency (in days) at which the underlying eligible documents are 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.

max_depthintegerOpcionalValor predeterminado: 3Deprecated

Deprecated - this field is a no-op and will be removed in a future version.

Respuesta

Successful Response
idstring
typeenumValor predeterminado: discovery
Valores permitidos:
root_folder_idstring
statusstring
created_atinteger
folder_pathlist of objectsOpcional
The folder path segments leading to the root folder, from root to parent folder.

Errores

422
Crawl Jobs Create Request Unprocessable Entity Error