Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

Tavily é uma API de busca projetada para aplicações de IA. O OpenClaw a expõe de duas formas:
  • como o provedor web_search para a ferramenta genérica de busca
  • como ferramentas explícitas de Plugin: tavily_search e tavily_extract
A Tavily retorna resultados estruturados otimizados para consumo por LLMs, com profundidade de busca configurável, filtragem por tópico, filtros de domínio, resumos de resposta gerados por IA e extração de conteúdo de URLs (incluindo páginas renderizadas por JavaScript).
PropriedadeValor
ID do Plugintavily
AutenticaçãoTAVILY_API_KEY ou config apiKey
URL basehttps://api.tavily.com (padrão)
Ferramentas incluídastavily_search, tavily_extract

​
Primeiros passos

1

Obtenha uma chave de API

Crie uma conta da Tavily em tavily.com e, em seguida, gere uma chave de API no painel.
2

Configure o Plugin e o provedor

{
  plugins: {
    entries: {
      tavily: {
        enabled: true,
        config: {
          webSearch: {
            apiKey: "tvly-...", // optional if TAVILY_API_KEY is set
            baseUrl: "https://api.tavily.com",
          },
        },
      },
    },
  },
  tools: {
    web: {
      search: {
        provider: "tavily",
      },
    },
  },
}
3

Verifique se a busca é executada

Acione uma web_search a partir de qualquer agente ou chame tavily_search diretamente.
Escolher Tavily no onboarding ou em openclaw configure --section web habilita automaticamente o Plugin Tavily incluído.

​
Referência das ferramentas

Use isto quando quiser controles de busca específicos da Tavily em vez do web_search genérico.
ParâmetroTipoRestrições / padrãoDescrição
querystringobrigatórioString da consulta de busca. Mantenha abaixo de 400 caracteres.
search_depthenumbasic (padrão), advancedadvanced é mais lento, mas tem maior relevância.
topicenumgeneral (padrão), news, financeFiltre por família de tópicos.
max_resultsinteger1-20Número de resultados.
include_answerbooleanpadrão falseInclua um resumo de resposta gerado por IA pela Tavily.
time_rangeenumday, week, month, yearFiltre os resultados por recência.
include_domainsstring array(nenhum)Inclua apenas resultados destes domínios.
exclude_domainsstring array(nenhum)Exclua resultados destes domínios.
Compromisso da profundidade de busca:
ProfundidadeVelocidadeRelevânciaMelhor para
basicMais rápidaAltaConsultas de uso geral (padrão).
advancedMais lentaMais altaPesquisa precisa e apuração de fatos.

​
tavily_extract

Use isto para extrair conteúdo limpo de uma ou mais URLs. Lida com páginas renderizadas por JavaScript e oferece suporte a fragmentação focada em consulta para extração direcionada.
ParâmetroTipoRestrições / padrãoDescrição
urlsstring arrayobrigatório, 1-20URLs das quais extrair conteúdo.
querystring(opcional)Reclassifique os trechos extraídos por relevância para esta consulta.
extract_depthenumbasic (padrão), advancedUse advanced para páginas pesadas em JS, SPAs ou tabelas dinâmicas.
chunks_per_sourceinteger1-5; requer queryTrechos retornados por URL. Gera erro se definido sem query.
include_imagesbooleanpadrão falseInclua URLs de imagens nos resultados.
Compromisso da profundidade de extração:
ProfundidadeQuando usar
basicPáginas simples. Tente isto primeiro.
advancedSPAs renderizadas por JS, conteúdo dinâmico, tabelas.
Divida listas maiores de URLs em várias chamadas tavily_extract (máximo de 20 por solicitação). Use query mais chunks_per_source para obter apenas conteúdo relevante em vez de páginas completas.

​
Escolhendo a ferramenta certa

NecessidadeFerramenta
Busca rápida na web, sem opções especiaisweb_search
Busca com profundidade, tópico, respostas de IAtavily_search
Extrair conteúdo de URLs específicastavily_extract
A ferramenta genérica web_search com Tavily como provedor oferece suporte a query e count (até 20 resultados). Para controles específicos da Tavily (search_depth, topic, include_answer, filtros de domínio, intervalo de tempo), use tavily_search.

​
Configuração avançada

O cliente Tavily procura sua chave de API nesta ordem:
  1. plugins.entries.tavily.config.webSearch.apiKey (resolvida por meio de SecretRefs).
  2. TAVILY_API_KEY do ambiente do gateway.
tavily_extract gera um erro de configuração se nenhum dos dois estiver presente.
Substitua plugins.entries.tavily.config.webSearch.baseUrl se você encaminhar a Tavily por meio de um proxy. O padrão é https://api.tavily.com.
tavily_extract rejeita chamadas que passam chunks_per_source sem uma query. A Tavily classifica os trechos por relevância da consulta, portanto o parâmetro não tem sentido sem uma.

​
Relacionados

Visão geral do Web Search

Todos os provedores e regras de detecção automática.

Firecrawl

Busca mais scraping com extração de conteúdo.

Exa Search

Busca neural com extração de conteúdo.

Configuração

Esquema de configuração completo para entradas de Plugin e roteamento de ferramentas.