Type Alias TavilyExtractParams

TavilyExtractParams: {
    extract_depth?: undefined | "basic" | "advanced";
    format?: undefined | "markdown" | "text";
    include_favicon?: undefined | boolean;
    include_images?: undefined | boolean;
    urls: string | string[];
}

The parameters for the Tavily Extract API.

Type declaration

  • Optionalextract_depth?: undefined | "basic" | "advanced"

    The depth of the extraction process. "advanced" extraction retrieves more data, including tables and embedded content, with higher success but may increase latency. The cost for "advanced" extraction requests may be higher than "basic" extraction.

    Default

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

    The format of the extracted web page content. "markdown" returns content in markdown format. "text" returns plain text and may increase latency.

    Default

    "markdown"
  • Optionalinclude_favicon?: undefined | boolean

    Whether to include the favicon URL for each result.

    Default

    false
  • Optionalinclude_images?: undefined | boolean

    Include a list of images extracted from the URLs in the response.

    Default

    false
  • urls: string | string[]

    The URL or list of URLs to extract content from.

    Example: "https://en.wikipedia.org/wiki/Artificial_intelligence" or ["https://en.wikipedia.org/wiki/Artificial_intelligence", ...]

Settings

Member Visibility