Skip to main content
POST
Run a real-time web search built for AI agents and get back a ranked list of titled results with links and snippets. Query is required; narrow the result set with Count (up to 20), Filter (Sites to restrict, BlockHosts to exclude), Language, and TimeRange. The response wraps ResponseMetadata.RequestId and a Result object whose WebResults array holds each hit (Title, Url, Snippet, Summary, SiteName, PublishTime/PublishTimeUnix), alongside ResultCount, SearchContext, and TimeCost. Billed a flat $0.00528 per successful call; failed requests are not charged. Use it for RAG retrieval augmentation, competitive/PR monitoring, fact-checking, and content sourcing. ⚠️ Results carry links and snippets, not full page text — pair each result URL with post_byteplus_fetch to pull clean, structured page content.

Authorizations

Authorization
string
header
required

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

Body

application/json
Query
string
required

The search query. Required. Max 400 characters; the upstream engine also effectively caps around 50 words.

Maximum string length: 400
Example:

"OpenAI news"

Count
integer
default:10

Number of results to return. Optional; default 10, maximum 20.

Required range: x <= 20
Example:

10

Filter
object

Optional result filter. Both fields are pipe-separated strings of full domains (max 5 each).

Language
string

Optional language hint in the upstream format, e.g. EN, ZH-HANS, ZH-HANT.

Example:

"EN"

TimeRange

Optional recency window. One of the named windows OneDay / OneWeek / OneMonth / OneYear, or a custom range "YYYY-MM-DD..YYYY-MM-DD". Omit for no time filter. NOTE: values like "week"/"month" are silently ignored upstream.

Available options:
OneDay,
OneWeek,
OneMonth,
OneYear
Example:

"OneWeek"

Response

200 - application/json

Search completed successfully. Result holds the ranked web results.

ResponseMetadata
object

Upstream request metadata.

Result
object

Search result payload.