Proxying a web search for the playground¶

Note

The Admin API requires no token. The Admin API is typically protected at the network level.

Send the request as GET to the path /admin/v1/playground/search.

Description¶

Proxies a query to the Brave Search API and returns the top 5 organic results. Intended for use by the playground UI's web-search feature.

The following parameters are available:

Parameter	In	Type	Required	Description
`q`	query	`string`	yes	Search query string.

Example of the response body:

{
  "query": "string",
  "results": [
    {
      "title": "string",
      "url": "string",
      "snippet": "string"
    }
  ]
}

The endpoint answers the request with the following status codes:

Status code	Description
`200`	Search results.
`400`	Invalid request body or missing required field (Admin API).
`502`	Brave Search API request failed.