Create Crawl Job
Create a crawl job to crawl the given URL with specified depth and page limits.
Headers
Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.
Body
URL to a page of documentation that the agent will have access to in order to interact with users.
Maximum depth for crawling (1-5), defaults to 3.
1 <= x <= 5Maximum number of pages to crawl (1-10,000), defaults to 1000.
1 <= x <= 10000If set, only URLs that match this pattern are included.
2048List of URLs to crawl from sitemap (optional, overrides automatic URL discovery).
If set, the created document or folder will be placed inside the given folder.
Whether to enable auto-sync for this URL document.
Whether to automatically remove the document if the URL becomes unavailable. Only applicable when auto-sync is enabled.
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.
1 <= x <= 180Response
Successful Response
discovery, sitemap The folder path segments leading to the root folder, from root to parent folder.