Brave AI Grounding API
Query Parameters
# Chat Completions API Request
Model of Chat Completions API (POST /res/v1/chat/completions) request JSON body. The request will include the question to be answered.
Note: The following parameters are the ones supported by the Brave AI Grounding API integration. When more parameters are supported they will be added to this document.
| Field | Type | Required | Description |
|---|---|---|---|
| messages | list [ ChatCompletionsMessage ] | true | The messages to use for the chat completion. The value is a list of ChatCompletionsMessage response models. |
| model | string | false | The model to use for the chat completion. The value can be (default) or |
| stream | bool | false | Whether to stream the response. The value is |
| country | string | false | The country backend to use for the chat completion. The value is Note: This parameter is passed in |
| language | string | false | The language to use for the chat completion. The value is Note: This parameter is passed in |
| enable_entities | bool | false | Whether to enable entities in the chat completion. The value is Note: This parameter is passed in |
| enable_citations | bool | false | Whether to enable citations in the chat completion. The value is Note: This parameter is passed in |
| enable_research | bool | false | Whether to enable research mode. Enabling this allows the model to perform multiple searches. The value is Note: This parameter is passed in |
# ChatCompletionsMessage
A message to use for the chat completion. Required to be length of 1 (single user message).
| Field | Type | Required | Description |
|---|---|---|---|
| role | string | true | The role of the message. Only |
| content | string | true | The content of the message. The value is the question to be answered. |