{
"openapi": "3.0.1",
"info": {
"title": "Brave Search API | Web, Image & Video Results",
"description": "Extract structured web, image, and video search results from Brave Search. Up to 100 web results, 200 images, and 60 videos per query. Filter by 38 countries, time period, and safety level.",
"version": "0.0",
"x-build-id": "7nwUHFbTcjwFX0EcX"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/clearpath~brave-search-api/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-clearpath-brave-search-api",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/clearpath~brave-search-api/runs": {
"post": {
"operationId": "runs-sync-clearpath-brave-search-api",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/clearpath~brave-search-api/run-sync": {
"post": {
"operationId": "run-sync-clearpath-brave-search-api",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"required": [
"query"
],
"properties": {
"query": {
"title": "Search query",
"type": "string",
"description": "Enter any search term, just like you would on Brave Search."
},
"maxResults": {
"title": "Max web results",
"minimum": 1,
"maximum": 200,
"type": "integer",
"description": "Maximum number of web search results to return (1–200).
This only controls web links. Other sections (discussions, news, locations, etc.) are always returned in full.",
"default": 100
},
"includeExtras": {
"title": "Include bonus sections",
"type": "boolean",
"description": "Include discussions (Reddit, forums), news clusters, knowledge panels, FAQ answers, inline videos, and rich widgets (weather, stocks, currency) alongside web results.
Free — bonus sections are included at no extra cost. Disable to get web links only.",
"default": true
},
"includeLocations": {
"title": "Include locations",
"type": "boolean",
"description": "Include local business results when Brave detects a location-relevant query (e.g. \"restaurants in Berlin\").
Each location includes address, phone number, rating, reviews, price range, opening hours, and coordinates. Can return 30+ results for local queries.
Free — locations are included at no extra cost.",
"default": true
},
"includeImages": {
"title": "Include images",
"type": "boolean",
"description": "Fetch dedicated image results alongside web results. Returns up to 200 images per query.
Free — you only pay for web results, images are included at no extra cost.",
"default": false
},
"includeVideos": {
"title": "Include videos",
"type": "boolean",
"description": "Fetch dedicated video results alongside web results. Returns up to ~60 videos per query.
Free — you only pay for web results, videos are included at no extra cost.",
"default": false
},
"country": {
"title": "Country & language",
"enum": [
"us",
"gb",
"de",
"fr",
"es",
"it",
"nl",
"pt",
"br",
"ca",
"au",
"in",
"jp",
"kr",
"cn",
"ru",
"pl",
"se",
"no",
"dk",
"fi",
"at",
"ch",
"be",
"ie",
"nz",
"mx",
"ar",
"cl",
"co",
"za",
"il",
"ae",
"sa",
"tr",
"cz",
"hu",
"ro",
"ua"
],
"type": "string",
"description": "Controls both the result region and language.
For example, de returns German-language results, fr returns French.",
"default": "us"
},
"timeFilter": {
"title": "Time filter",
"enum": [
"",
"pd",
"pw",
"pm",
"py"
],
"type": "string",
"description": "Only return results published within the selected time period.",
"default": ""
},
"safesearch": {
"title": "Safe search",
"enum": [
"off",
"moderate",
"strict"
],
"type": "string",
"description": "Content safety filter. Moderate is the default.",
"default": "off"
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}