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.
Create a crawl job to crawl the given URL with specified depth and page limits.
Headers
xi-api-keystringOptional
Request
This endpoint expects an object.
urlstringRequired
URL to a page of documentation that the agent will have access to in order to interact with users.
max_pagesintegerOptional1-10000Defaults to 1000
Maximum number of pages to crawl (1-10,000), defaults to 1000.
patternstring or nullOptional<=2048 characters
If set, only URLs that match this pattern are included.
sitemap_urlslist of strings or nullOptional
List of URLs to crawl from sitemap (optional, overrides automatic URL discovery).
parent_folder_idstring or nullOptional
If set, the created document or folder will be placed inside the given folder.
enable_auto_syncbooleanOptionalDefaults to false
Whether to enable auto-sync for this URL document.
auto_removebooleanOptionalDefaults to false
Whether to automatically remove the document if the URL becomes unavailable. Only applicable when auto-sync is enabled.
auto_discoverbooleanOptionalDefaults to false
Automatically discover and add new pages linked from already-crawled pages during auto-sync. Requires enable_auto_sync=true.
minimum_frequency_daysinteger or nullOptional1-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_depthintegerOptionalDefaults to 3Deprecated
Deprecated - this field is a no-op and will be removed in a future version.
Response
Successful Response
idstring
typeenumDefaults to discovery
Allowed values:
root_folder_idstring
statusstring
created_atinteger
folder_pathlist of objectsOptional
The folder path segments leading to the root folder, from root to parent folder.
