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.

OpenClaw oferece suporte à Brave Search API como provedor web_search.

​
Obtenha uma chave de API

  1. Crie uma conta da Brave Search API em https://brave.com/search/api/
  2. No painel, escolha o plano Search e gere uma chave de API.
  3. Armazene a chave na configuração ou defina BRAVE_API_KEY no ambiente do Gateway.

​
Exemplo de configuração

{
  plugins: {
    entries: {
      brave: {
        config: {
          webSearch: {
            apiKey: "BRAVE_API_KEY_HERE",
            mode: "web", // or "llm-context"
            baseUrl: "https://api.search.brave.com", // optional proxy/base URL override
          },
        },
      },
    },
  },
  tools: {
    web: {
      search: {
        provider: "brave",
        maxResults: 5,
        timeoutSeconds: 30,
      },
    },
  },
}
As configurações de pesquisa específicas da Brave agora ficam em plugins.entries.brave.config.webSearch.*. O tools.web.search.apiKey legado ainda é carregado pelo shim de compatibilidade, mas não é mais o caminho de configuração canônico. webSearch.mode controla o transporte da Brave:
  • web (padrão): pesquisa web normal da Brave com títulos, URLs e trechos
  • llm-context: Brave LLM Context API com blocos de texto pré-extraídos e fontes para fundamentação
webSearch.baseUrl pode apontar solicitações da Brave para um proxy compatível com a Brave confiável ou Gateway. O OpenClaw acrescenta /res/v1/web/search ou /res/v1/llm/context à URL base configurada e mantém a URL base na chave de cache. Endpoints públicos devem usar https://; http:// é aceito apenas para hosts de proxy confiáveis de loopback ou de rede privada.

​
Parâmetros da ferramenta

​
query
string
obrigatório
Consulta de pesquisa.
​
count
number
padrão:"5"
Número de resultados a retornar (1–10).
​
country
string
Código ISO de país com 2 letras (por exemplo, US, DE).
​
language
string
Código de idioma ISO 639-1 para os resultados da pesquisa (por exemplo, en, de, fr).
​
search_lang
string
Código de idioma de pesquisa da Brave (por exemplo, en, en-gb, zh-hans).
​
ui_lang
string
Código de idioma ISO para elementos da interface.
​
freshness
'day' | 'week' | 'month' | 'year'
Filtro de tempo — day corresponde a 24 horas.
​
date_after
string
Somente resultados publicados após esta data (YYYY-MM-DD).
​
date_before
string
Somente resultados publicados antes desta data (YYYY-MM-DD).
Exemplos: 
// Country and language-specific search
await web_search({
  query: "renewable energy",
  country: "DE",
  language: "de",
});

// Recent results (past week)
await web_search({
  query: "AI news",
  freshness: "week",
});

// Date range search
await web_search({
  query: "AI developments",
  date_after: "2024-01-01",
  date_before: "2024-06-30",
});

​
Observações

  • O OpenClaw usa o plano Search da Brave. Se você tiver uma assinatura legada (por exemplo, o plano Free original com 2.000 consultas/mês), ela continua válida, mas não inclui recursos mais recentes como LLM Context ou limites de taxa mais altos.
  • Cada plano da Brave inclui $5/mês em crédito gratuito (renovável). O plano Search custa $5 por 1.000 solicitações, então o crédito cobre 1.000 consultas/mês. Defina seu limite de uso no painel da Brave para evitar cobranças inesperadas. Consulte o portal da Brave API para ver os planos atuais.
  • O plano Search inclui o endpoint LLM Context e direitos de inferência de IA. Armazenar resultados para treinar ou ajustar modelos exige um plano com direitos explícitos de armazenamento. Consulte os Termos de Serviço da Brave.
  • O modo llm-context retorna entradas de fontes fundamentadas em vez do formato normal de trechos da pesquisa web.
  • O modo llm-context oferece suporte a freshness e intervalos delimitados de date_after + date_before. Ele não oferece suporte a ui_lang; date_before sem date_after é rejeitado porque a Brave exige que intervalos personalizados de atualização incluam as datas inicial e final.
  • ui_lang deve incluir uma subtag de região como en-US.
  • Os resultados são armazenados em cache por 15 minutos por padrão (configurável via cacheTtlMinutes).
  • Valores personalizados de webSearch.baseUrl são incluídos na identidade de cache da Brave, portanto respostas específicas de proxy não colidem.
  • Habilite a flag de diagnóstico brave.http para registrar URLs/parâmetros de consulta de solicitações da Brave, status/tempo de resposta e eventos de acerto/erro/gravação do cache de pesquisa durante a solução de problemas. A flag nunca registra a chave de API nem os corpos das respostas, mas consultas de pesquisa podem ser sensíveis.

​
Relacionados