Member Junction
    Preparing search index...

    Class TavilySearchAction

    Action that searches the web through Tavily, a search API built for LLM consumption: results arrive as extracted page content rather than as snippets plus links to go fetch.

    Two things distinguish it from the other search actions in this package. Topic: 'news' gives a date-filtered news index with PublishedDate on every result, which is what makes recency-sensitive questions answerable. And IncludeAnswer returns a synthesized answer alongside the results, so a caller that only needs the conclusion does not have to run its own summarization pass.

    Authentication is Authorization: Bearer <key>. Tavily also still accepts an api_key field in the request body, but that form is legacy and puts the credential in the payload, so it is not used here.

    // Basic search
    await runAction({
      ActionName: 'Tavily Search',
      Params: [{ Name: 'Query', Value: 'association management software trends' }]
    });

    // Recent news, with a synthesized answer
    await runAction({
      ActionName: 'Tavily Search',
      Params: [
        { Name: 'Query', Value: 'nonprofit membership dues changes' },
        { Name: 'Topic', Value: 'news' },
        { Name: 'Days', Value: 7 },
        { Name: 'IncludeAnswer', Value: true }
      ]
    });

    // Advanced depth, restricted to two domains
    await runAction({
      ActionName: 'Tavily Search',
      Params: [
        { Name: 'Query', Value: 'IRS Form 990 filing requirements' },
        { Name: 'SearchDepth', Value: 'advanced' },
        { Name: 'IncludeDomains', Value: ['irs.gov', 'councilofnonprofits.org'] }
      ]
    });

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    InternalRunAction Run

    Constructors

    Methods

    • Executes the Tavily search.

      Parameters

      • params: RunActionParams

        The action parameters containing:

        • Query: Search query text (required)
        • SearchDepth: 'basic' (default) or 'advanced'. Advanced costs more Tavily credits per call and returns better-extracted content
        • Topic: 'general' (default) or 'news'. 'news' is the only topic that returns publication dates and the only one Days applies to
        • Days: For Topic 'news', how far back to search (default 3 at Tavily)
        • MaxResults: 1-20 (default 10)
        • IncludeAnswer: Return a synthesized answer alongside results (default false)
        • IncludeRawContent: Return full page text per result (default false) — this can be very large, so it is off unless asked for
        • IncludeDomains: Only return results from these domains
        • ExcludeDomains: Never return results from these domains

      Returns Promise<ActionResultSimple>

      Search results, and the synthesized answer when requested

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods