Skip to main content
Available from version 1.51
Feature in Alpha
Enable web search capabilities in chats powered by Brave Search.

Configuration

KeyDefaultValuesDescription
enabledfalsetrue | falseEnable web search capabilities in chats

Requirements

Web Extract Required: This feature requires Web Extract to be enabled.
Brave Search API Required: You need a valid Brave Search API key to use this feature.

How to Obtain a Brave Search API Key

  1. Visit the Brave Search API website
  2. Create an account or sign in
  3. Subscribe to a plan
    • Go to the Subscriptions tab in the left menu
    • Choose a “Data for Search” plan based on your needs:
  4. Generate your API key
    • Navigate to API Keys in the left menu
    • Click “Add API Key”
    • Name your key (e.g., “Zylon Web Search Integration”)
    • Select the subscription plan to associate with the key
    • Copy and save your API key securely

Brave API Configuration

Web Search requires a Brave Search API provider configuration with the following parameters:
ParameterTypeRequiredDescription
apiKeystringYesYour Brave Search API subscription token
rateLimitnumberYesRequests per second based on your subscription tier

Rate Limit Tiers

Based on your Brave Search API subscription tier:
  • Free AI: 1.0 (1 query/second, up to 2,000 queries/month)
  • Base AI: 20.0 (up to 20 queries/second, up to 20M queries/month)
  • Pro AI: 50.0 (up to 50 queries/second, unlimited queries/month)
  • Enterprise: Custom rate limits

Example Configuration

features:
    webExtract:
        enabled: true
    webSearch:
        enabled: true
external:
    brave:
        apiKey: YOUR_BRAVE_API_KEY_HERE
        rateLimit: 1.0

Getting Started

  1. Sign up for a Brave Search API key at brave.com/search/api
  2. Configure the apiKey and rateLimit according to your subscription tier
  3. Enable both webExtract and webSearch features
  4. The Web Search functionality will be available in your chats