For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Maak een crawltaak om de opgegeven URL te crawlen met de opgegeven diepte- en paginalimieten.
Headers
xi-api-keystringOptional
Request
This endpoint expects an object.
urlstringRequired
URL naar een documentatiepagina waartoe de agent toegang heeft om met gebruikers te communiceren.
max_pagesintegerOptional1-10000Defaults to 1000
Maximumaantal pagina’s dat moet worden gecrawld (1-10.000), standaard 1000.
patternstring or nullOptional<=2048 characters
Als dit is ingesteld, worden alleen URL's opgenomen die met dit patroon overeenkomen.
sitemap_urlslist of strings or nullOptional
Lijst met URL’s uit de sitemap die moeten worden gecrawld (optioneel, overschrijft automatische URL-detectie).
parent_folder_idstring or nullOptional
Als dit is ingesteld, wordt het gemaakte document of de gemaakte map in de opgegeven map geplaatst.
enable_auto_syncbooleanOptionalDefaults to false
Of automatisch synchroniseren voor dit URL-document moet worden ingeschakeld.
auto_removebooleanOptionalDefaults to false
Of het document automatisch moet worden verwijderd als de URL niet meer beschikbaar is. Alleen van toepassing wanneer automatisch synchroniseren is ingeschakeld.
auto_discoverbooleanOptionalDefaults to false
Ontdek en voeg tijdens automatische synchronisatie automatisch nieuwe pagina’s toe die zijn gelinkt vanaf al gecrawlde pagina’s. Vereist enable_auto_sync=true.
minimum_frequency_daysinteger or nullOptional1-180
Minimale frequentie (in dagen) waarmee de onderliggende in aanmerking komende documenten worden vernieuwd. Het werkelijke interval kan korter zijn, maar nooit langer. Standaard is dit 7, aangescherpt tot de frequentie van de bovenliggende map als die strenger is. Alleen van toepassing wanneer automatische synchronisatie is ingeschakeld.
max_depthintegerOptionalDefaults to 3Deprecated
Verouderd - dit veld heeft geen effect en wordt in een toekomstige versie verwijderd.
Response
Geslaagde response
idstring
typeenumDefaults to discovery
Allowed values:
root_folder_idstring
statusstring
created_atinteger
folder_pathlist of objectsOptional
De segmenten van het mappad naar de hoofdmap, van de hoofdmap naar de bovenliggende map.
