Project.md

Project

Properties

Name	Type	Description	Notes
id	String	Unique project identifier
name	String	Project name
domain	URI	Website domain URL
userId	String	User who owns the project
prompt	String	Natural language prompt for crawling	[optional]
searchQuery	String	Search query for targeted crawling	[optional]
sitemapMode	SitemapModeEnum	How to handle sitemaps	[optional]
includeSubdomains	Boolean	Whether to include subdomains	[optional]
ignoreQueryParams	Boolean	Whether to ignore URL query parameters	[optional]
maxDiscoveryDepth	Integer	Maximum crawl depth	[optional]
excludePaths	List<String>	Paths to exclude from crawling	[optional]
includePaths	List<String>	Specific paths to include	[optional]
crawlEntireDomain	Boolean	Whether to crawl the entire domain	[optional]
allowExternalLinks	Boolean	Whether to allow external links	[optional]
maxPages	Integer	Maximum number of pages to crawl	[optional]
crawlDelay	Integer	Delay between crawl requests (ms)	[optional]
crawlMaxConcurrency	Integer	Maximum concurrent crawl requests	[optional]
onlyMainContent	Boolean	Whether to extract only main content	[optional]
customHeaders	Map<String, String>	Custom headers for crawling	[optional]
waitFor	Integer	Wait time for page load (ms)	[optional]
blockAds	Boolean	Whether to block ads	[optional]
proxyMode	ProxyModeEnum	Proxy mode for crawling	[optional]
useReranking	Boolean	Whether to use AI reranking	[optional]
enableChangeTracking	Boolean	Whether to enable change tracking	[optional]
createdAt	OffsetDateTime	Project creation timestamp
updatedAt	OffsetDateTime	Last update timestamp
count	ProjectCount		[optional]

Enum: SitemapModeEnum

Name	Value
INCLUDE	"include"
EXCLUDE	"exclude"
ONLY	"only"

Enum: ProxyModeEnum

Name	Value
AUTO	"auto"
RESIDENTIAL	"residential"
DATACENTER	"datacenter"