Skip to main content
GET
Perform Smart Search

Authorizations

Authorization
string
header
required

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

Headers

Pragma
string

Input value: no-cache. When no-cache is provided, the response results will not be cached and each request is independent; if not provided, the response results for the same query term will be cached for 10 minutes

Query Parameters

blockWebsites
string

The value must be in host address format (e.g., baijiahao.baidu.com). Excludes results from the specified site(s).

contentTimeout
number
default:0

Timeout for reading long abstracts. If reading exceeds this time, it will terminate and no long abstract will be returned for that result. Defaults to 0 (seconds), maximum 10s.

Required range: x <= 10
contentType
enum<string>
default:TEXT

The format of the long abstract (content) to return. Options::- HTML- MARKDOWN- TEXT(default)

Available options:
HTML,
MARKDOWN,
TEXT
count
enum<integer>
default:10

The number of search results to return. Defaults to 10, maximum 50. Enumerated values: 10 / 20 / 30 / 40 / 50 The actual number returned may be less than requested. Use this parameter with the offset parameter for pagination.

Available options:
10,
20,
30,
40,
50
Required range: x <= 50
enableContent
boolean
default:false

ontrols whether to return long abstract content: -true: Return long abstracts -false: Do not return long abstracts Defaults to false

freshness
enum<string>

Filter search results by time range: - Day (past 24 hours) -Week (past 7 days) - Month (past 30 days)

Available options:
Day,
Week,
Month
mainText
boolean
default:false

Controls whether to return key fragments of dynamic abstracts:true: Return key fragmentsfalse:Do not return key fragmentsDefault false

offset
integer
default:0

The zero-based offset indicating how many results to skip before returning. Defaults to 0. Use with the count parameter for pagination. There is no upper limit for offset; setting a large value may result in no results being returned.

Required range: x >= 0
q
string
required

The user's search query term, which cannot be empty.

Minimum string length: 1
sites
string

The value must be in host address format (e.g., baijiahao.baidu.com). Returns results only from the specified site(s).

Response

Official typed response table; required fields and undeclared array item types are not inferred.

queryContext
object
webPages
object