Project.md

Project

Properties

Name	Type	Description	Notes
id	str	Unique project identifier
name	str	Project name
domain	str	Website domain URL
user_id	str	User who owns the project
prompt	str	Natural language prompt for crawling	[optional]
search_query	str	Search query for targeted crawling	[optional]
sitemap_mode	str	How to handle sitemaps	[optional]
include_subdomains	bool	Whether to include subdomains	[optional]
ignore_query_params	bool	Whether to ignore URL query parameters	[optional]
max_discovery_depth	int	Maximum crawl depth	[optional]
exclude_paths	List[str]	Paths to exclude from crawling	[optional]
include_paths	List[str]	Specific paths to include	[optional]
crawl_entire_domain	bool	Whether to crawl the entire domain	[optional]
allow_external_links	bool	Whether to allow external links	[optional]
max_pages	int	Maximum number of pages to crawl	[optional]
crawl_delay	int	Delay between crawl requests (ms)	[optional]
crawl_max_concurrency	int	Maximum concurrent crawl requests	[optional]
only_main_content	bool	Whether to extract only main content	[optional]
custom_headers	Dict[str, str]	Custom headers for crawling	[optional]
wait_for	int	Wait time for page load (ms)	[optional]
block_ads	bool	Whether to block ads	[optional]
proxy_mode	str	Proxy mode for crawling	[optional]
use_reranking	bool	Whether to use AI reranking	[optional]
enable_change_tracking	bool	Whether to enable change tracking	[optional]
created_at	datetime	Project creation timestamp
updated_at	datetime	Last update timestamp
count	ProjectCount		[optional]

Example

from rankvectors.models.project import Project

# TODO update the JSON string below
json = "{}"
# create an instance of Project from a JSON string
project_instance = Project.from_json(json)
# print the JSON string representation of the object
print(Project.to_json())

# convert the object into a dict
project_dict = project_instance.to_dict()
# create an instance of Project from a dict
project_from_dict = Project.from_dict(project_dict)

[Back to Model list] [Back to API list] [Back to README]