Skip to main content
POST
Search AI Data

授权

Authorization
string
header
必填

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

请求体

application/json

Top-level parameters: highlights object form: filters sub-object: timeRange.date syntax: d[n] / w[n] / m[n] / y[n]: last n days / weeks / months / years, e.g. d7, m3 YYYY-MM-DDtoYYYY-MM-DD: a range, e.g. 2022-04-01to2022-07-30; a single day uses the same to form geo.countries.include allowed values: argentina, australia, brazil, canada, colombia, france, germany, india, indonesia, japan, mexico, nigeria, philippines, south korea, spain, united kingdom, united states. languages.include allowed values: english, japanese, korean, german, french, spanish, portuguese. vertical allowed values: code, finance. Lowercase and strictly enumerated; omit the field for universal search.

query
string
必填

Search term. Supports long natural-language descriptions

count
integer

Maximum number of results returned. Default: server default (value unspecified).

chunksPerDoc
integer
默认值:1

Summary chunks per document. Free / PAYG support up to 1; Enterprise up to 3. Deprecated — still available, but migrate to highlights

highlights

Request relevant fragments from the body text. true extracts against the original query at the length the model judges best; the object form takes query and maxCharacters, see below

needContent
boolean
默认值:false

Whether to return body text. When true, body text lands in each result's sentence field (sentence array)

filters
object

Filter conditions, see below

响应

Official response table. Fields on each results.result[] item: url, title, snippet, page_age (plaintext UTC+0 time), site_name, site_icon, sentence (string[], present only when needContent: true and body text is available), highlights (string[], present only when highlights is set on the request and body text is available). Every result field is optional. Some results in the same response may have no sentence or highlights. Treat a missing field as "body text unavailable," not as an error.

took
string

Server-side processing time

error_code
integer

Error code, consistent with the HTTP status code; 200 on success

error_msg
string

Error detail

search_id
integer

Unique request identifier; give it to support when reporting an issue

query_context
object
results
object