Skip to main content
POST
/
v1
/
chat
/
completions
Error
A valid request URL is required to generate request examples
{
  "choices": [
    {
      "delta": {
        "content": "<string>",
        "role": "assistant"
      },
      "finish_reason": "stop"
    }
  ],
  "created": 123,
  "id": "<string>",
  "model": "brave-pro",
  "system_fingerprint": "<string>",
  "object": "chat.completion.chunk",
  "usage": {
    "completion_tokens": 123,
    "prompt_tokens": 123,
    "total_tokens": 123,
    "completion_tokens_details": {
      "reasoning_tokens": 123
    }
  }
}

Authorizations

​
x-subscription-token
string
header
required

The subscription token that was generated for the product.

Body

application/json
​
messages
UserMessage · object[]
required
Required array length: 1 element
​
model
enum<string>
default:brave-pro
Available options:
brave-pro,
brave
​
max_completion_tokens
integer | null
​
metadata
Metadata · object
​
seed
integer | null
​
stream
boolean
default:true
​
web_search_options
WebSearchOptions · object
​
country
string
default:us
​
language
string
default:en
​
safesearch
string
default:moderate
​
enable_entities
boolean
default:false
​
enable_citations
boolean
default:false
​
enable_research
boolean
default:false
​
research_allow_thinking
boolean
default:true
​
research_maximum_number_of_tokens_per_query
integer
default:8192
Required range: 1024 <= x <= 16384
​
research_maximum_number_of_queries
integer
default:20
Required range: 1 <= x <= 50
​
research_maximum_number_of_iterations
integer
default:4
Required range: 1 <= x <= 5
​
research_maximum_number_of_seconds
integer
default:180
Required range: 1 <= x <= 300
​
research_maximum_number_of_results_per_query
integer
default:60
Required range: 1 <= x <= 60

Response

Successful Response

​
choices
ChoiceChunk · object[]
required
​
created
integer
required
​
id
string
required
​
model
enum<string>
default:brave-pro
Available options:
brave-pro,
brave
​
system_fingerprint
string | null
​
object
enum<string>
default:chat.completion.chunk
Available options:
chat.completion.chunk
Allowed value: "chat.completion.chunk"
​
usage
OpenAIUsage · object