skilld
All skills
brave avatar

/suggest

@2827ed3 official
by Brave Softwarebrave/brave-search-skills182 stars
17

USE FOR query autocomplete/suggestions. Fast (<100ms). Returns suggested queries as user types. Supports rich suggestions with entity info. Typo-resilient.

Ask your Agent

Use this Skill: https://skilld.dev/gh/brave/brave-search-skills/suggest

This session only. Nothing lands on disk.

SKILL.md

≈41 tokens always: the name and description. ≈843 when used: this file.

Suggest / Autocomplete

Requires API Key: Get one at https://api.search.brave.com

Plan: Included in the Suggest plan. See https://api-dashboard.search.brave.com/app/subscriptions/subscribe

Quick Start (cURL)

Basic Suggestions

curl -s "https://api.search.brave.com/res/v1/suggest/search?q=how+to+" \
  -H "Accept: application/json" \
  -H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}"

With All Parameters

curl -s "https://api.search.brave.com/res/v1/suggest/search" \
  -H "Accept: application/json" \
  -H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}" \
  -G \
  --data-urlencode "q=albert" \
  --data-urlencode "country=US" \
  --data-urlencode "lang=en" \
  --data-urlencode "count=10" \
  --data-urlencode "rich=true"

Endpoint

GET https://api.search.brave.com/res/v1/suggest/search

Authentication: X-Subscription-Token: <API_KEY> header

Optional Headers:

  • Accept-Encoding: gzip — Enable response compression

Parameters

Parameter Type Required Default Description
q string Yes — Suggest search query (1-400 chars, max 50 words)
lang string No en Language preference (2+ char language code, e.g. fr, de, zh-hans)
country string No US Search country (2-letter country code or ALL)
count int No 5 Number of suggestions (1-20). Actual results may be fewer
rich bool No false Enhance with entity info (title, description, image). Paid Search plan required

Response Fields

Field Type Description
type string Always "suggest"
query.original string The original suggest search query
results array List of suggestions (may be empty)
results[].query string Suggested query completion
results[].is_entity bool? Whether the suggested enriched query is an entity (rich only)
results[].title string? The suggested query enriched title (rich only)
results[].description string? The suggested query enriched description (rich only)
results[].img string? The suggested query enriched image URL (rich only)

Fields with null values are excluded from the response. Non-rich results contain only the query field.

Rich Response Example (rich=true)

{
  "type": "suggest",
  "query": { "original": "albert" },
  "results": [
    {
      "query": "albert einstein",
      "is_entity": true,
      "title": "Albert Einstein",
      "description": "German-born theoretical physicist",
      "img": "https://imgs.search.brave.com/..."
    },
    { "query": "albert einstein quotes", "is_entity": false }
  ]
}

Use Cases

  • Search-as-you-type UI: Real-time autocomplete dropdown. Debounce 150-300ms.
  • Query refinement for RAG: Expand partial/ambiguous queries before calling web-search or llm-context.
  • Entity detection: Use rich=true to detect entities with title, description, and image for preview cards.
  • Typo-tolerant input: Get clean suggestions from misspelled input without separate spellcheck.

Notes

  • Latency: Designed for <100ms response times
  • Country/lang: Hints for suggestion relevance, not strict filters
  • Typo handling: Suggestions handle common typos without separate spellcheck

Source: SKILL.md on GitHub

Third-party checks

2 warnings16d5 checks · Risk SAFE
  • Gen Agent Trust Hub16d

    The skill provides clear and standard documentation for interacting with Brave's query autocomplete and suggestions API. It does not introduce any security issues or operational risks.

  • Socket16d

    No alerts

  • Snyk16d

    Risk: MEDIUM · 1 issue

  • Runlayer7mo

    1/1 file flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Provenance

Signed by skilld at 2827ed3. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 months ago.

Activeupdated 8 months ago

Topics

  • API
  • brave-search
  • autocomplete
  • suggestions
  • search
  • entity-detection
  • query-refinement

README badge

README badge for brave/brave-search-skills/suggest

What it does

Provides query autocomplete suggestions via the Brave Search API with sub-100ms latency, optionally enriched with entity metadata (title, description, image). Handles typos and supports language and country targeting for search-as-you-type UIs and RAG query refinement workflows.

Generated from the current SKILL.md.

Frequently asked

What API key do I need and what plan covers this?
You need a Brave Search API key from https://api.search.brave.com. The Suggest endpoint is included in the Suggest plan; rich suggestions with entity info require the paid Search plan.
How fast does this return results?
The endpoint is designed for sub-100ms response times, suitable for real-time search-as-you-type UI with 150-300ms debouncing.
What languages and regions does this support?
You can specify language via the `lang` parameter (e.g. en, fr, zh-hans) and region via `country` (2-letter code or ALL). These are hints for relevance, not strict filters.
Does this handle typos in the input query?
Yes. Suggestions automatically handle common typos without requiring a separate spellcheck step.
What information does the rich mode return?
With `rich=true`, suggestions include entity detection, title, description, and image URL for entity results. This requires the paid Search plan.

Generated from the current SKILL.md. These answers refresh after source changes.