Suggest

Suggest

curl --request GET \
  --url https://api.aisa.one/apis/v1/brave/suggest/search \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/brave/suggest/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/brave/suggest/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/brave/suggest/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/brave/suggest/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "query": {
    "original": "<string>"
  },
  "results": [],
  "type": "suggest"
}

GET

https://api.aisa.one

apis

brave

suggest

Suggest

curl --request GET \
  --url https://api.aisa.one/apis/v1/brave/suggest/search \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/brave/suggest/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/brave/suggest/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/brave/suggest/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/brave/suggest/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "query": {
    "original": "<string>"
  },
  "results": [],
  "type": "suggest"
}

Request contract

Method and path: GET /apis/v1/brave/suggest/search
Availability: enabled
Request URL template: https://api.aisa.one/apis/v1/brave/suggest/search
accept: header; optional
api-version: header; optional
cache-control: header; optional
user-agent: header; optional
count: query; optional
country: query; optional
lang: query; optional
q: query; required
rich: query; optional
Runtime facts: 8627d7bc05db287888574873d586ce7dca25f9fa7b4a266cb71760e824597bfc

Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

{
  "operationId": "any_brave_search_apis_v1_brave_suggest_search",
  "method": "GET",
  "path": "/apis/v1/brave/suggest/search",
  "servers": [
    {
      "url": "https://api.aisa.one"
    }
  ],
  "parameters": [
    {
      "deprecated": false,
      "description": "The default supported media type is application/json.",
      "examples": {
        "0": {
          "value": "application/json"
        }
      },
      "in": "header",
      "name": "accept",
      "required": false,
      "schema": {
        "allOf": [
          {
            "enum": [
              "application/json",
              "*/*"
            ],
            "title": "Accept",
            "type": "string"
          },
          {
            "default": "application/json"
          }
        ],
        "description": "The default supported media type is application/json.",
        "examples": [
          "application/json"
        ],
        "title": "Media type"
      }
    },
    {
      "deprecated": false,
      "description": "The API version to use.                 This is denoted by the format <code>YYYY-MM-DD</code>.                 Default is the latest that is available. Read                 more about <a href=\"/documentation/guides/versioning\">API versioning</a>.",
      "in": "header",
      "name": "api-version",
      "required": false,
      "schema": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "description": "The API version to use.                 This is denoted by the format <code>YYYY-MM-DD</code>.                 Default is the latest that is available. Read                 more about <a href=\"/documentation/guides/versioning\">API versioning</a>.",
        "title": "API version"
      }
    },
    {
      "deprecated": false,
      "description": "Brave Search will return cached content by default.                 To prevent caching set the Cache-Control header to <code>no-cache</code>.                 This is currently done as best effort.",
      "in": "header",
      "name": "cache-control",
      "required": false,
      "schema": {
        "anyOf": [
          {
            "const": "no-cache",
            "enum": [
              "no-cache"
            ],
            "title": "CacheControl",
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "description": "Brave Search will return cached content by default.                 To prevent caching set the Cache-Control header to <code>no-cache</code>.                 This is currently done as best effort.",
        "title": "Cache control"
      }
    },
    {
      "deprecated": false,
      "description": "The user agent originating the request.                 Brave search can utilize the user agent to provide a different                 experience depending on the device as described by the string.                 The user agent should follow the commonly used browser agent                 strings on each platform. For more information on curating user agents,                 see <a href=\"https://www.rfc-editor.org/rfc/rfc9110.html#name-user-agent\">RFC 9110</a>.",
      "examples": {
        "Android": {
          "description": "Android",
          "value": "Mozilla/5.0 (Linux; Android 12) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.5060.71 Mobile Safari/537.36"
        },
        "Windows": {
          "description": "Windows",
          "value": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36"
        },
        "iOS": {
          "description": "iOS",
          "value": "Mozilla/5.0 (iPhone; CPU iPhone OS 15_5 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/103.0.5060.63 Mobile/15E148 Safari/604.1"
        },
        "macOS": {
          "description": "macOS",
          "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36"
        }
      },
      "in": "header",
      "name": "user-agent",
      "required": false,
      "schema": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "type": "null"
          }
        ],
        "description": "The user agent originating the request.                 Brave search can utilize the user agent to provide a different                 experience depending on the device as described by the string.                 The user agent should follow the commonly used browser agent                 strings on each platform. For more information on curating user agents,                 see <a href=\"https://www.rfc-editor.org/rfc/rfc9110.html#name-user-agent\">RFC 9110</a>.",
        "title": "User agent"
      }
    },
    {
      "deprecated": false,
      "description": "The number of suggestion search results returned in response. The actual number of results delivered may be less than requested. Minimum is 1, maximum is 20. The default is 5.",
      "in": "query",
      "name": "count",
      "required": false,
      "schema": {
        "default": 5,
        "description": "The number of suggestion search results returned in response. The actual number of results delivered may be less than requested. Minimum is 1, maximum is 20. The default is 5.",
        "maximum": 20,
        "minimum": 1,
        "title": "Count",
        "type": "integer"
      }
    },
    {
      "deprecated": false,
      "description": "The suggest search query country, where potentially the results could come from. The country string is limited to 2 character country codes of supported countries. This is a just a hint for calculating suggest responses.",
      "in": "query",
      "name": "country",
      "required": false,
      "schema": {
        "allOf": [
          {
            "enum": [
              "AR",
              "AU",
              "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",
              "GB",
              "US",
              "ALL"
            ],
            "title": "SearchCountry",
            "type": "string"
          },
          {
            "default": "US"
          }
        ],
        "description": "The suggest search query country, where potentially the results could come from. The country string is limited to 2 character country codes of supported countries. This is a just a hint for calculating suggest responses."
      }
    },
    {
      "deprecated": false,
      "description": "The suggest search language preference, where potentially the results could come from. The 2 or more character language code for which the suggest search results are provided. This is a just a hint for calculating suggest responses.",
      "in": "query",
      "name": "lang",
      "required": false,
      "schema": {
        "allOf": [
          {
            "enum": [
              "ar",
              "eu",
              "bn",
              "bg",
              "ca",
              "zh-hans",
              "zh-hant",
              "hr",
              "cs",
              "da",
              "nl",
              "en",
              "en-gb",
              "et",
              "fi",
              "fr",
              "gl",
              "de",
              "el",
              "gu",
              "he",
              "hi",
              "hu",
              "is",
              "it",
              "ja",
              "jp",
              "kn",
              "ko",
              "lv",
              "lt",
              "ms",
              "ml",
              "mr",
              "nb",
              "pl",
              "pt-br",
              "pt-pt",
              "pa",
              "ro",
              "ru",
              "sr",
              "sk",
              "sl",
              "es",
              "sv",
              "ta",
              "te",
              "th",
              "tr",
              "uk",
              "vi"
            ],
            "title": "Language",
            "type": "string"
          },
          {
            "default": "en"
          }
        ],
        "description": "The suggest search language preference, where potentially the results could come from. The 2 or more character language code for which the suggest search results are provided. This is a just a hint for calculating suggest responses."
      }
    },
    {
      "deprecated": false,
      "description": "The user’s suggest search query term. Query can not be empty. The max query length is 400 characters, and the word limit is 50 words.",
      "in": "query",
      "name": "q",
      "required": true,
      "schema": {
        "description": "The user’s suggest search query term. Query can not be empty. The max query length is 400 characters, and the word limit is 50 words.",
        "maxLength": 400,
        "minLength": 1,
        "title": "The user's suggest search query term.",
        "type": "string"
      }
    },
    {
      "deprecated": false,
      "description": "Whether to enhance suggestions with rich results. This requires a paid autosuggest subscription.",
      "examples": {
        "Exclude rich suggestions": {
          "value": false
        },
        "Include rich suggestions": {
          "value": true
        }
      },
      "in": "query",
      "name": "rich",
      "required": false,
      "schema": {
        "default": false,
        "description": "Whether to enhance suggestions with rich results. This requires a paid autosuggest subscription.",
        "title": "Rich",
        "type": "boolean"
      }
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "x-aisa-status": "enabled",
  "x-aisa-pricing": {
    "cost_contract": "fixed_success",
    "customer_multiplier": 1.0,
    "customer_pricing": "provider_cost_multiplier",
    "default_request_estimate_usd": 0.0005,
    "estimate_source": "profile_seed",
    "evidence_source": "request_snapshot"
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  }
}

Cost and request rules

Published reference price: $0.0005 USD per successful request. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Default request reference estimate (USD): 0.0005
Cost contract: fixed_success
Published reference multiplier: 1.0
Settlement evidence source: request_snapshot

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

enum<string>

default:application/json

The default supported media type is application/json.

Available options:

application/json,

*/*

Example:

"application/json"

api-version

string | null

The API version to use. This is denoted by the format YYYY-MM-DD. Default is the latest that is available. Read more about API versioning.

cache-control

enum<string> | null

Brave Search will return cached content by default. To prevent caching set the Cache-Control header to no-cache. This is currently done as best effort.

Available options:

no-cache

Allowed value: "no-cache"

user-agent

string | null

The user agent originating the request. Brave search can utilize the user agent to provide a different experience depending on the device as described by the string. The user agent should follow the commonly used browser agent strings on each platform. For more information on curating user agents, see RFC 9110.

Query Parameters

count

integer

default:5

The number of suggestion search results returned in response. The actual number of results delivered may be less than requested. Minimum is 1, maximum is 20. The default is 5.

Required range: 1 <= x <= 20

country

enum<string>

default:US

The suggest search query country, where potentially the results could come from. The country string is limited to 2 character country codes of supported countries. This is a just a hint for calculating suggest responses.

Available options:

AR,

AU,

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,

GB,

US,

ALL

lang

enum<string>

default:en

The suggest search language preference, where potentially the results could come from. The 2 or more character language code for which the suggest search results are provided. This is a just a hint for calculating suggest responses.

Available options:

ar,

eu,

bn,

bg,

ca,

zh-hans,

zh-hant,

hr,

cs,

da,

nl,

en,

en-gb,

et,

fi,

fr,

gl,

de,

el,

gu,

he,

hi,

hu,

is,

it,

ja,

jp,

kn,

ko,

lv,

lt,

ms,

ml,

mr,

nb,

pl,

pt-br,

pt-pt,

pa,

ro,

ru,

sr,

sk,

sl,

es,

sv,

ta,

te,

th,

tr,

uk,

vi

string

required

The user’s suggest search query term. Query can not be empty. The max query length is 400 characters, and the word limit is 50 words.

Required string length: 1 - 400

rich

boolean

default:false

Whether to enhance suggestions with rich results. This requires a paid autosuggest subscription.

Response

Successful Response

query

OriginalQuery · object

required

Suggest search query string. Only the original query is returned.

Show child attributes

results

SuggestResult · object[]

The list of suggestions for the given query.

Show child attributes

type

enum<string>

default:suggest

Available options:

suggest

Allowed value: "suggest"

Overview

Models

Search & Research

Finance & Crypto

Social & Media

SEO & Web Intel

Sales & Email

Travel & Other

Request contract

Cost and request rules

Authorizations

Headers

Query Parameters

Response

​Request contract

​Cost and request rules

Authorizations

Headers

Query Parameters

Response

Request contract

Cost and request rules