Type Alias TavilyCrawlParams

TavilyCrawlParams: {
    allowExternal?: undefined | boolean;
    categories?: undefined | CrawlCategory[];
    excludeDomains?: undefined | string[];
    excludePaths?: undefined | string[];
    extractDepth?: undefined | ExtractDepth;
    format?: undefined | "markdown" | "text";
    includeImages?: undefined | boolean;
    include_favicon?: undefined | boolean;
    instructions?: undefined | string;
    limit?: undefined | number;
    maxBreadth?: undefined | number;
    maxDepth?: undefined | number;
    selectDomains?: undefined | string[];
    selectPaths?: undefined | string[];
    url: string;
}

Type declaration

  • OptionalallowExternal?: undefined | boolean

    Allow crawling external domains.

    Default

    undefined
  • Optionalcategories?: undefined | CrawlCategory[]

    Only crawl URLs containing these categories.

    Default

    undefined
  • OptionalexcludeDomains?: undefined | string[]

    Exclude these domains.

    Default

    undefined
  • OptionalexcludePaths?: undefined | string[]

    Exclude these paths.

    Default

    undefined
  • OptionalextractDepth?: undefined | ExtractDepth

    The depth of the extractions. It can be "basic" or "advanced".

  • Optionalformat?: undefined | "markdown" | "text"

    The format of the respose. It can be "markdown" or "text"

    Default

    "markdown"
  • OptionalincludeImages?: undefined | boolean

    Include images in the crawl results.

    Default

    false
  • Optionalinclude_favicon?: undefined | boolean

    Whether to include the favicon URL for each result.

    Default

    false
  • Optionalinstructions?: undefined | string

    Natural language instructions to guide the crawler

    Default

    undefined
  • Optionallimit?: undefined | number

    The maximum number of pages to crawl.

    Default

    100
  • OptionalmaxBreadth?: undefined | number

    The maximum number of pages to crawl per level.

    Default

    50
  • OptionalmaxDepth?: undefined | number

    The maximum number of hops from the starting URL.

    Default

    3
  • OptionalselectDomains?: undefined | string[]

    Only crawl these domains.

    Default

    undefined
  • OptionalselectPaths?: undefined | string[]

    Only crawl URLs containing these paths.

    Default

    undefined
  • url: string

    The URL to start crawling from.

    Example: "https://example.com"

Settings

Member Visibility