Web Search

import { Agent, openai, createWebSearchTool } from '@runflow-ai/sdk';

const agent = new Agent({
  name: 'Research Agent',
  instructions: 'You help users research topics using the internet.',
  model: openai('gpt-4o'),
  tools: {
    search: createWebSearchTool({
      provider: 'tavily',
      apiKey: process.env.TAVILY_API_KEY,
    }),
  },
});

const result = await agent.process({
  message: 'What are the latest developments in AI agents?',
});

import { webSearch } from '@runflow-ai/sdk';

const results = await webSearch('Runflow AI platform', {
  provider: 'tavily',
  apiKey: process.env.TAVILY_API_KEY,
  maxResults: 5,
  searchDepth: 'advanced',
});

console.log(results.answer);   // AI-generated answer (Tavily)
console.log(results.results);  // Array of WebSearchResult

{
  query: "Runflow AI platform",
  answer: "Runflow is an AI agent platform...",  // Tavily only
  results: [
    {
      title: "Runflow - Build AI Agents",
      url: "https://runflow.ai",
      snippet: "Platform for building and deploying AI agents...",
      content: "Full page content...",  // When includeContent is true
      score: 0.95,
      publishedDate: "2026-03-01"
    }
  ]
}

createWebSearchTool({
  provider: 'tavily',
  apiKey: 'tvly-your-key',
})

createWebSearchTool({
  provider: 'tavily',
  connector: 'tavily-default',  // Connector instance slug
})

const results = await webSearch('latest news about AI', {
  provider: 'tavily',
  apiKey: process.env.TAVILY_API_KEY,
  maxResults: 5,
  searchDepth: 'basic',     // 'basic' or 'advanced'
  includeContent: false,    // Include full page content
});

const results = await webSearch('articles about building AI agents', {
  provider: 'exa',
  apiKey: process.env.EXA_API_KEY,
  maxResults: 5,
});

const results = await webSearch('Runflow AI', {
  provider: 'serper',
  apiKey: process.env.SERPER_API_KEY,
  maxResults: 5,
});

import { flow, webSearch } from '@runflow-ai/sdk';

const researchFlow = flow('research')
  .step('search', async ({ input }) => {
    const results = await webSearch(input.query, {
      provider: 'tavily',
      apiKey: process.env.TAVILY_API_KEY,
    });
    return { results: results.results };
  })
  .step('summarize', {
    agent: summaryAgent,
    prompt: ({ results }) =>
      `Summarize these search results:\n${JSON.stringify(results.search.results)}`,
  })
  .build();