Hoppa till navigering

Skapa crawlningsjobb

Skapa ett genomsökningsjobb för att genomsöka den angivna URL:en med angivet djup och sidgränser.

Headers

xi-api-keystringValfri

Förfrågan

This endpoint expects an object.
urlstringObligatorisk

URL till en dokumentationssida som agenten har åtkomst till för att kunna interagera med användare.

max_pagesintegerValfri1-10000Standard är 1000

Maximalt antal sidor att genomsöka (1–10 000). Standardvärdet är 1 000.

patternstring or nullValfri<=2048 characters

Om angivet inkluderas endast URL:er som matchar detta mönster.

sitemap_urlslist of strings or nullValfri

Lista över URL:er från webbplatskartan som ska genomsökas (valfritt, åsidosätter automatisk upptäckt av URL:er).

parent_folder_idstring or nullValfri
Om angivet placeras det skapade dokumentet eller den skapade mappen i den angivna mappen.
enable_auto_syncbooleanValfriStandard är false

Om automatisk synkronisering ska aktiveras för detta URL-dokument.

auto_removebooleanValfriStandard är false

Om dokumentet ska tas bort automatiskt om URL:en blir otillgänglig. Gäller endast när automatisk synkronisering är aktiverad.

auto_discoverbooleanValfriStandard är false

Identifiera och lägg automatiskt till nya sidor som länkas från redan genomsökta sidor under automatisk synkronisering. Kräver enable_auto_sync=true.

minimum_frequency_daysinteger or nullValfri1-180

Minsta frekvens (i dagar) för när de underliggande kvalificerade dokumenten uppdateras. Det faktiska intervallet kan vara kortare, men aldrig längre. Standardvärdet är 7 och begränsas av överordnad mapps frekvens om den är striktare. Gäller endast när automatisk synkronisering är aktiverad.

max_depthintegerValfriStandard är 3Deprecated

Föråldrat – det här fältet har ingen effekt och tas bort i en framtida version.

Svar

Lyckat svar
idstring
typeenumStandard är discovery
Tillåtna värden:
root_folder_idstring
statusstring
created_atinteger
folder_pathlist of objectsValfri

Mappsökvägens segment som leder till rotmappen, från roten till överordnad mapp.

Fel

422
Unprocessable Entity Error