Brave

Brave gives you access to the same powerful, independent search index that powers the privacy-first search engine trusted by millions

Categories: Helpers

Type: brave/v1

Connections

Version: 1

API Key

Properties

Name	Label	Type	Description	Required
api_token	API token	STRING		true

Connection Setup

Go to https://api-dashboard.search.brave.com/app/keys
Log in to your account.
Subscribe into a plan.
Click on Generate a new API key and name it.
Copy the API key. Use these credentials to create a connection in ByteChef.

Actions

Web Search

Name: webSearch

Search the web for relevant content.

Properties

Name	Label	Type	Description	Required
q	Search Query	STRING	The user’s search query term. Query can not be empty. Maximum of 400 characters and 50 words in the query.	true
count	Count	INTEGER	The number of search results returned in response. The maximum is 20. The actual number delivered may be less than requested. Combine this parameter with offset to paginate search results.	false
offset	Offset	INTEGER	The zero based offset that indicates number of search result pages (count) to skip before returning the result. The actual number delivered may be less than requested.	false
safesearch	Safe Search	STRING Options off, moderate, strict	The level of safe search filtering applied to the query.	false
freshness	Freshness	STRING Options pd, pw, pm, py	Filters search results by when they were discovered.	false
result_filter	Result Filter	STRING	A comma delimited string of result types to include in the search response.	false
summary	Summary	BOOLEAN Options true, false	This parameter enables summary key generation in web search results.	false
operators	Operators	BOOLEAN Options true, false	Whether to apply search operators.	false
country	Country	STRING Options ALL, US, GB, AR, AT, BE, BR, CA, CL, DK, FI, FR, DE, GR, HK, IN, ID, IT, JP, KR, MY, MX, NL, NZ, NO, CN, PL, PT, PH, RU, SA, ZA, ES, SE, CH, TW, TR	The 2 character country code where the search results come from.	false
search_lang	Search Language	STRING Options en, en-gb, eu, ar, bn, bg, ca, zh-hans, zh-hant, hr, cs, da, nl, et, fi, fr, gl, de, el, gu, ge, he, hi, hu, is, it, jp, kn, ko, lv, lt, ms, ml, mr, nb, pl, pt-br, pt-pt, pa, ro, ur, sr, sk, sl, es, sv, ta, te, th, tr, uk, vi	The 2 or more character language code for which the search results are provided.	false

Example JSON Structure

{
  "label" : "Web Search",
  "name" : "webSearch",
  "parameters" : {
    "q" : "",
    "count" : 1,
    "offset" : 1,
    "safesearch" : "",
    "freshness" : "",
    "result_filter" : "",
    "summary" : false,
    "operators" : false,
    "country" : "",
    "search_lang" : ""
  },
  "type" : "brave/v1/webSearch"
}

Properties

Name	Type	Description
query	OBJECT Properties {STRING(original)}
discussions	OBJECT Properties {[{STRING(title), STRING(url), STRING(description)}](results)}
faq	OBJECT Properties {[{STRING(question), STRING(answer), STRING(url), STRING(title)}](results)}
infobox	OBJECT Properties {[{STRING(title), STRING(url), STRING(description)}](results)}
locations	OBJECT Properties {[{STRING(title), STRING(url), STRING(description)}](results)}
news	OBJECT Properties {[{STRING(title), STRING(url), STRING(description)}](results)}
videos	OBJECT Properties {[{STRING(title), STRING(url), STRING(description)}](results)}
web	OBJECT Properties {[{STRING(title), STRING(url), STRING(description)}](results)}
summarizer	OBJECT Properties {STRING(key)}

Output Example

{
  "query" : {
    "original" : ""
  },
  "discussions" : {
    "results" : [ {
      "title" : "",
      "url" : "",
      "description" : ""
    } ]
  },
  "faq" : {
    "results" : [ {
      "question" : "",
      "answer" : "",
      "url" : "",
      "title" : ""
    } ]
  },
  "infobox" : {
    "results" : [ {
      "title" : "",
      "url" : "",
      "description" : ""
    } ]
  },
  "locations" : {
    "results" : [ {
      "title" : "",
      "url" : "",
      "description" : ""
    } ]
  },
  "news" : {
    "results" : [ {
      "title" : "",
      "url" : "",
      "description" : ""
    } ]
  },
  "videos" : {
    "results" : [ {
      "title" : "",
      "url" : "",
      "description" : ""
    } ]
  },
  "web" : {
    "results" : [ {
      "title" : "",
      "url" : "",
      "description" : ""
    } ]
  },
  "summarizer" : {
    "key" : ""
  }
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

On this page