Web Search

The Web Search is a specialized search engine for large language models. Building upon traditional search engine capabilities like web crawling and ranking, it enhances intent recognition to return results better suited for LLM processing (including webpage titles, URLs, summaries, site names, favicons etc.).

POST /paas/v4/web_search

cURL

cURL

curl --request POST \
  --url https://api.z.ai/api/paas/v4/web_search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "search_engine": "search-prime",
  "search_query": "<string>",
  "count": 25,
  "search_domain_filter": "<string>",
  "request_id": "<string>",
  "user_id": "<string>"
}
'

import requests

url = "https://api.z.ai/api/paas/v4/web_search"

payload = {
    "search_engine": "search-prime",
    "search_query": "<string>",
    "count": 25,
    "search_domain_filter": "<string>",
    "request_id": "<string>",
    "user_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    search_engine: 'search-prime',
    search_query: '<string>',
    count: 25,
    search_domain_filter: '<string>',
    request_id: '<string>',
    user_id: '<string>'
  })
};

fetch('https://api.z.ai/api/paas/v4/web_search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api.z.ai/api/paas/v4/web_search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"search_engine\": \"search-prime\",\n  \"search_query\": \"<string>\",\n  \"count\": 25,\n  \"search_domain_filter\": \"<string>\",\n  \"request_id\": \"<string>\",\n  \"user_id\": \"<string>\"\n}")
  .asString();

200

{
  "id": "<string>",
  "created": 123,
  "search_result": [
    {
      "title": "<string>",
      "content": "<string>",
      "link": "<string>",
      "media": "<string>",
      "icon": "<string>",
      "refer": "<string>",
      "publish_date": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Use the following format for authentication: Bearer

Headers

Accept-Language · enum<string> · default: en-US,en

Config desired response language for HTTP requests.

Available options: en-US,en

Example:

"en-US,en"

Body

application/json

search_engine · enum<string> · default: search-prime · required

The search engine code to call. search-prime: Z.AI Premium Version Search Engine

Available options: search-prime

Example:

"search-prime"

search_query · string · required

The content to be searched.

count · integer

The number of results to return Fillable range: 1-50, maximum 50 results per single search Default is 10 Supported search engines: search_pro_jina.

Required range: 1 <= x <= 50

search_domain_filter · string

Used to limit the scope of search results and only return content from specified whitelist domains. Whitelist: Directly enter the domain name (e.g., www.example.com) Supported search engines: search_pro_jina

search_recency_filter · enum<string>

Search for webpages within a specified time range. Default is noLimit Fillable values: oneDay: within one day oneWeek: within one week oneMonth: within one month oneYear: within one year noLimit: no limit (default) Supported search engines: search_pro_jina

Available options: oneDay, oneWeek, oneMonth, oneYear, noLimit

request_id · string

Passed by the user side, needs to be unique; used to distinguish each request, 6–64 characters. If not provided by the user side, the platform will generate one by default.

Required string length: 6 - 64

user_id · string

Unique ID for the end user, 6–128 characters. Avoid using sensitive information.

Required string length: 6 - 128

Response

200

application/json

Processing successful

id · string

Task ID.

created · integer

Request creation time, Unix timestamp in seconds.

search_result · object[]

Search results.

Hide child attributes

search_result. title · string

Title.

search_result. content · string

Content summary.

search_result. link · string

Result URL.

search_result. media · string

Website name.

search_result. icon · string

Website icon.

search_result. refer · string

Index number.

search_result. publish_date · string

Website publication date.