Autom

Brave Search

GET
/v1/brave/search

Search Brave Search via API and retrieve structured organic results with pagination.

Credit cost: 1 credit per call

Autorización

ApiKeyAuth
headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Parámetros de consulta

query*string

The search query you want to run on Brave Search.

page?number

Page number for pagination.

Default"1"
gl?string

Country code, for example us, fr, gb, de.

Default"us"
hl?string

Language code, for example en, fr, de.

Default"en"
fields?string

Comma-separated list of response fields to return, with dot notation for nested fields (e.g. name,location.city).

is_async?boolean

Run the request as a background job: the API answers 202 with a job_id to poll on GET /v1/jobs/{id}.

Defaultfalse
soft_fail?boolean

Return HTTP 200 even when the request fails; the error is in the error field of the body.

Defaultfalse

Cuerpo de la respuesta

Successful response

application/json
  1. response
organic_results?array<>
search_parameters?
Example Request
curl -X GET 'https://api.autom.dev/v1/brave/search?query=string'
Example Response
{  "organic_results": [    {      "link": "https://www.anthropic.com/",      "title": "Anthropic",      "domain": "www.anthropic.com",      "snippet": "Anthropic is an AI safety company. Claude is its assistant.",      "position": 1    },    {      "link": "https://docs.anthropic.com/",      "title": "Anthropic documentation",      "domain": "docs.anthropic.com",      "snippet": "Documentation for the Claude API and the Anthropic platform.",      "position": 2    }  ],  "search_parameters": {    "q": "anthropic",    "gl": "us",    "hl": "en",    "page": 1,    "engine": "brave"  }}