← 返回
沟通协作 Key 中文

Answers

USE FOR AI-grounded answers via OpenAI-compatible /chat/completions. Two modes: single-search (fast) or deep research (enable_research=true, thorough multi-s...
用于通过OpenAI兼容的/chat/completions接口提供基于AI的回答。提供两种模式:单次搜索(快速)或深度研究(设置enable_research=true,进行详尽的多步搜索)。
0xrichyrich
沟通协作 clawhub v1.0.0 1 版本 100000 Key: 需要
★ 0
Stars
📥 560
下载
💾 16
安装
1
版本
#latest

概述

Answers — AI Grounding

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

>

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

When to Use

Use CaseSkillWhy
------
Quick factual answer (raw context)llm-contextSingle search, returns raw context for YOUR LLM
Fast AI answer with citationsanswers (single-search)streaming, citations
Thorough multi-search deep researchanswers (research mode)Iterative deep research, synthesized cited answer

This endpoint (/res/v1/chat/completions) supports two modes:

  • Single-search (default): Fast AI-grounded answer from a single search. Supports enable_citations.
  • Research (enable_research=true): Multi-iteration deep research with progress events and synthesized cited answer.

Quick Start (cURL)

Blocking (Single-Search)

curl -X POST "https://api.search.brave.com/res/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}" \
  -d '{
    "messages": [{"role": "user", "content": "How does the James Webb Space Telescope work?"}],
    "model": "brave",
    "stream": false
  }'

Streaming with Citations (Single-Search)

curl -X POST "https://api.search.brave.com/res/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}" \
  -d '{
    "messages": [{"role": "user", "content": "What are recent breakthroughs in fusion energy?"}],
    "model": "brave",
    "stream": true,
    "enable_citations": true
  }'

Research Mode

curl -X POST "https://api.search.brave.com/res/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "X-Subscription-Token: ${BRAVE_SEARCH_API_KEY}" \
  -d '{
    "messages": [{"role": "user", "content": "Compare quantum computing approaches"}],
    "model": "brave",
    "stream": true,
    "enable_research": true,
    "research_maximum_number_of_iterations": 3,
    "research_maximum_number_of_seconds": 120
  }'

Endpoint

POST https://api.search.brave.com/res/v1/chat/completions

Authentication: X-Subscription-Token: header (or Authorization: Bearer )

SDK Compatible: Works with OpenAI SDK via base_url="https://api.search.brave.com/res/v1"

Two Modes

FeatureSingle-Search (default)Research (enable_research=true)
------
SpeedFastSlow
Searches1Multiple (iterative)
StreamingOptional (stream=true/false)Required (stream=true)
Citationsenable_citations=true (streaming only)Built-in (in tag)
Progress eventsNoYes ( tags)
Blocking responseYes (stream=false)No

Parameters

Standard Parameters

ParameterTypeRequiredDefaultDescription
----------
messagesarrayYes-Single user message (exactly 1 message)
modelstringYes-Use "brave"
streamboolNotrueEnable SSE streaming
countrystringNo"US"Search country (2-letter country code or ALL)
languagestringNo"en"Response language
safesearchstringNo"moderate"Search safety level (off, moderate, strict)
max_completion_tokensintNonullUpper bound on completion tokens
enable_citationsboolNofalseInclude inline citation tags (single-search streaming only)
web_search_optionsobjectNonullOpenAI-compatible; search_context_size: low, medium, high

Research Parameters

ParameterTypeRequiredDefaultDescription
----------
enable_researchboolNofalseEnable research mode
research_allow_thinkingboolNotrueEnable extended thinking
research_maximum_number_of_tokens_per_queryintNo8192Max tokens per query (1024-16384)
research_maximum_number_of_queriesintNo20Max total search queries (1-50)
research_maximum_number_of_iterationsintNo4Max research iterations (1-5)
research_maximum_number_of_secondsintNo180Time budget in seconds (1-300)
research_maximum_number_of_results_per_queryintNo60Results per search query (1-60)

Constraints (IMPORTANT)

ConstraintError
----
enable_research=true requires stream=true"Blocking response doesn't support 'enable_research' option"
enable_research=true incompatible with enable_citations=true"Research mode doesn't support 'enable_citations' option"
enable_citations=true requires stream=true"Blocking response doesn't support 'enable_citations' option"

OpenAI SDK Usage

Blocking (Single-Search)

from openai import OpenAI

client = OpenAI(
    base_url="https://api.search.brave.com/res/v1",
    api_key="your-brave-api-key",
)

response = client.chat.completions.create(
    model="brave",
    messages=[{"role": "user", "content": "How does the James Webb Space Telescope work?"}],
    stream=False,
)
print(response.choices[0].message.content)

Streaming with Citations (Single-Search)

from openai import OpenAI

client = OpenAI(
    base_url="https://api.search.brave.com/res/v1",
    api_key="your-brave-api-key",
)

stream = client.chat.completions.create(
    model="brave",
    messages=[{"role": "user", "content": "What are the current trends in renewable energy?"}],
    stream=True,
    extra_body={"enable_citations": True}
)

for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="")

Research Mode

from openai import AsyncOpenAI

client = AsyncOpenAI(
    base_url="https://api.search.brave.com/res/v1",
    api_key="your-brave-api-key",
)

stream = await client.chat.completions.create(
    model="brave",
    messages=[{"role": "user", "content": "Compare quantum computing approaches"}],
    stream=True,
    extra_body={
        "enable_research": True,
        "research_maximum_number_of_iterations": 3,
        "research_maximum_number_of_seconds": 120
    }
)

async for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

Response Format

Blocking Response (stream=false, single-search only)

Standard OpenAI-compatible JSON:

{
  "id": "chatcmpl-...",
  "object": "chat.completion",
  "choices": [{"message": {"role": "assistant", "content": "The James Webb Space Telescope works by..."}, "index": 0, "finish_reason": "stop"}],
  "usage": {"prompt_tokens": 10, "completion_tokens": 50, "total_tokens": 60}
}

Streaming Response

SSE response with OpenAI-compatible chunks:

data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[{"delta":{"content":"Based on"},"index":0}]}

data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[{"delta":{"content":" recent research"},"index":0}]}

data: [DONE]

Streaming Tags by Mode

Single-Search (with enable_citations=true)

TagPurpose
----
Inline citation references
JSON cost/billing data

Research Mode

TagPurposeKeep?
------
Generated search queriesDebug
URL counts (verbose)Debug
URL selection reasoningDebug
Stats: time, iterations, queries, URLs analyzed, tokensMonitor
Knowledge gaps identifiedYes
Final synthesized answer (only the final answer is emitted; intermediate drafts are dropped)Yes
JSON cost/billing data (included at end of streaming response)Yes

Usage Tag Format

The tag contains JSON-stringified cost and token data:

<usage>{"X-Request-Requests":1,"X-Request-Queries":8,"X-Request-Tokens-In":15000,"X-Request-Tokens-Out":2000,"X-Request-Requests-Cost":0.005,"X-Request-Queries-Cost":0.032,"X-Request-Tokens-In-Cost":0.075,"X-Request-Tokens-Out-Cost":0.01,"X-Request-Total-Cost":0.122}</usage>

Use Cases

  • Chat interface integration: Drop-in OpenAI SDK replacement with web-grounded answers. Set base_url="https://api.search.brave.com/res/v1".
  • Deep research / comprehensive topic research: Use research mode (enable_research=true) for complex questions needing multi-source synthesis (e.g., "Compare approaches to nuclear fusion").
  • OpenAI SDK drop-in: Same SDK, same streaming format — just change base_url and api_key. Works with both sync and async clients.
  • Cited answers: Enable enable_citations=true in single-search mode for inline citation tags, or use research mode which automatically includes citations in its answer.

Notes

  • Timeout: Set client timeout to at least 30s for single-search, 300s (5 min) for research
  • Single message: The messages array must contain exactly 1 user message
  • Cost monitoring: Parse the tag from streaming responses to track costs

版本历史

共 1 个版本

  • v1.0.0 当前
    2026-03-30 07:01 安全 安全

安全检测

腾讯云安全 (Keen)

安全,无风险
查看报告

腾讯云安全 (Sanbu)

安全,无风险
查看报告

🔗 相关推荐

ai-intelligence

Nudge Marketplace

0xrichyrich
{"answer":"在Nudge市场浏览、提交和管理AI智能体,该健康平台使用$NUDGE代币及x402支付协议。"}
★ 1 📥 1,830
communication-collaboration

Himalaya

lamelas
{"answer":"通过IMAP/SMTP管理邮件的CLI。可在终端使用 `himalaya` 收发、回复、转发、搜索及整理邮件。支持多账户与MML(MIME元语言)编写邮件。"}
★ 68 📥 45,596
communication-collaboration

imap-smtp-email

gzlicanyi
使用IMAP/SMTP读取和发送邮件;检查新/未读邮件、获取内容、搜索邮箱、标记已读/未读、发送带附件的邮件。支持...
★ 114 📥 52,449