logoQuerit.ai
loading

POST /v1/search

请求参数

请求头

Content-TypestringRequired

application/json

AuthorizationstringRequired

Bearer 鉴权参数。例如：Bearer {Your API KEY}。您可以在 API Key 管理页面获取自己的 API KEY。

请求体参数

querystringRequired
Your search query term.
countintegerOptional
The maximum of search results returned in response. Defaults to 10; the maximum is 100.
fromintegerOptional
Result-set offset. Defaults to 0. For example, from=5 with count=10 returns results [5,15).
chunksPerDocintegerOptional
Return the number of summary chunks. Defaults to 1 chunk if not specified. Free and PAYG plans support up to 1 chunk; Enterprise supports up to 3 chunks.
needContentbooleanOptional
Whether to return the content of each result, split into sentences. Defaults to false. When set to true, the content is returned in the sentence field of each result; the field is omitted for results whose content is unavailable.
filtersobject {6}Optional
Filter conditions, used to further refine the search results.
sitesobject {2}Optional
Site filtering, specify which websites to include or exclude in the results. Up to 20 sites in total.
includearray[string]Optional
List of websites to include, only fetch data from these sites (empty means no restriction).
excludearray[string]Optional
List of websites to exclude, do not fetch data from these sites.
timeRangeobject {1}Optional
Time range filtering, specify the date or time period for the results.
datestringOptional
d[number]: Request results from the past specified number of days. w[number]: Request results from the past specified number of weeks. m[number]: Request results from the past specified number of months. y[number]: Request results from the past specified number of years. YYYY-MM-DDtoYYYY-MM-DD: Request results within a specified date range, for example, 2022-04-01to2022-07-30 (single day is also supported).
geoobject {1}Optional
Geolocation-based filtering.
countriesobject {1}Optional
Country filtering, specify which countries to include in the results. Available options:"argentina"、"australia"、"brazil"、"canada"、"colombia"、"france"、"germany"、"india"、"indonesia"、"japan"、"mexico"、"nigeria"、"philippines"、"south korea"、"spain"、"united kingdom"、"united states".
includearray[string]Optional
List of countries to include, only return results from these countries.
languagesobject {1}Optional
Language filtering, specify which languages to include in the results. Available options:"english"、"japanese"、"korean"、"german"、"french"、"spanish"、"portuguese" .
includearray[string]Optional
List of languages to include, only return results in these languages.
complianceScenestringOptional
Compliance scope for the result set. "abroad" for overseas compliance (default), "domestic" for domestic compliance, or "all" for no restriction.
verticalstringOptional
Enable vertical search for dedicated domains. When set to a specific parameter, the search will return the relevant content for the requirement using the corresponding data source. If not specified, a generic search is used. Values supported: - code: Start vertical search for code Default: not specified (universal search)
docobject {1}Optional
Response-content controls. Use it to opt into extra payload that is omitted by default.
includeobject {1}Optional
Extra content to include in each result.
imagesbooleanOptional
Whether to return webpage images. Defaults to false; images are returned only when set to true.
sortobject {1}Optional
Sorting controls. When omitted, the default relevance-based sorting strategy is used.
pageAgestringOptional
Sort by page publish or update time instead of the default relevance order.
1{
2    "query": "video",
3    "count": 20,
4    "from": 0,
5    "chunksPerDoc": 3,
6    "needContent": false,
7    "filters": {
8        "sites": {
9            "include": [],
10            "exclude": []
11        },
12        "timeRange": {
13            "date": ""
14        },
15        "geo": {
16            "countries": {
17                "include": []
18            }
19        },
20        "languages": {
21            "include": []
22        },
23        "complianceScene": "abroad",
24        "vertical": ""
25    },
26    "doc": {
27        "include": {
28            "images": false
29        }
30    },
31    "sort": {
32        "pageAge": ""
33    }
34}

响应参数

tookstringRequired
The server-side response time for this request.
error_codeintegerRequired
Error code, used to identify the specific type of error. Consistent with HTTP response status codes.
error_msgstringRequired
Error message, provides details about the error.
search_idintegerRequired
A unique request reference you can give to customer support to help them address problems with your specific request.
query_contextobject {1}Required
Information about the search query.
querystringRequired
The search query that was executed.
resultsobject {1}Required
Search result set.
resultarray[object] {7}Required
urlstringOptional
The URL of the search result.
page_agestringOptional
A plaintext representing the age of the web search result, displayed in UTC+0.
titlestringOptional
The title of the search result.
snippetstringOptional
A brief snippet from the web page.
site_namestringOptional
The website name used for the URL.
site_iconstringOptional
The favicon used for the URL.
sentencearray[string]Optional
The webpage text of the search result, split into sentences. Only returned when needContent is set to true, and only for results whose webpage text is available. This field may be absent for some results in the same response; treat a missing field as no webpage text.
1{
2    "took": "string",
3    "error_code": 200,
4    "error_msg": "string",
5    "search_id": 0,
6    "query_context": {
7        "query": "string"
8    },
9    "results": {
10        "result": [
11            {
12                "url": "string",
13                "page_age": "string",
14                "title": "string",
15                "snippet": "string",
16                "site_name": "string",
17                "site_icon": "string",
18                "sentence": [
19                    "string"
20                ]
21            }
22        ]
23    }
24}