BytePlus
Web search and page content retrieval.
AI-oriented real-time web search.
Run a real-time web search built for AI agents and return a ranked list of titled results with links and snippets. Query is required; narrow the result set with Count (≤ 20), Filter (restrict to Sites or exclude BlockHosts), Language, and TimeRange. The response wraps ResponseMetadata.RequestId and a Result list of web results. Use it for RAG retrieval augmentation, competitive/PR monitoring, fact-checking, and content sourcing; pair each result URL with post_byteplus_fetch to pull full page content.
- 类型: stringQuery最大长度:400必填
The search query. Required. Max 400 characters; the upstream engine also effectively caps around 50 words.
- 类型: integerCount最大值:20
Number of results to return. Optional; default 10, maximum 20.
- 类型: objectFilter
Optional result filter. Both fields are pipe-separated strings of full domains (max 5 each).
- Block类型: string
Hosts Exclude results from these full domains. Pipe-separated, max 5, e.g. "reddit.com|quora.com".
- Sites类型: string
Restrict results to these full domains. Pipe-separated, max 5, e.g. "bytedance.com|byteplus.com". (Sending an array returns 10400 Invalid Parameter.)
- 类型: stringLanguage
Optional language hint in the upstream format, e.g. EN, ZH-HANS, ZH-HANT.
- Time
Range 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.
- 类型: string 枚举
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.
值- One
Day - One
Week - One
Month - One
Year
- 类型: object200
Search completed successfully.
Resultholds the ranked web results.- 类型: objectResponse
Metadata Upstream request metadata.
- Action类型: string
- Region类型: string
- Request类型: string
Id Unique identifier for this request.
- Service类型: string
- Version类型: string
- 类型: objectResult
Search result payload.
- Choices类型: array object[] | null 可为 null
Reserved; null unless applicable.
空对象 - Log类型: string
Id Upstream log id (equals ResponseMetadata.RequestId).
- Result类型: integer
Count Number of web results returned.
- Search类型: object
Context Echo of the resolved query context.
- Origin类型: string
Query - Search类型: string
Type
- Time类型: integer
Cost Upstream processing time in milliseconds.
- Usage类型: object 可为 null
Reserved; null unless applicable.
- Web类型: array object[]
Results Ranked list of web results.
- Id类型: string
Opaque result id.
- Logo类型: string
Url Signed site logo URL (time-limited).
- Publish类型: string
Time Publish time in ISO 8601 (may be empty).
- Publish类型: integer
Time Unix Publish time as Unix seconds (0 if unknown).
- Site类型: string
Name Source site name (may be empty).
- Snippet类型: string
Short text snippet from the page.
- Sort类型: integer
Id 1-based rank of the result.
- Summary类型: string
Longer summary of the page content.
- Title类型: string
Result title.
- Url类型: string
Result URL.
application/json - 400
The request could not be processed. Check the request parameters.
- 401
A valid Felo API key is required.
- 402
The request cannot proceed because a billing requirement is not met.
- 403
The account is not permitted to perform this operation.
- 429
A request or spending limit has been reached.
- 502
The service could not complete the request.
- 503
The API or billing service is temporarily unavailable.
- 504
The service timed out while processing the request.
- default
The operation failed. Keep the response request ID when contacting Felo support.
curl https://openapi.felo.ai/v1/beta/byteplus/web-search \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"Query": "OpenAI news"
}'
{
"ResponseMetadata": {
"RequestId": "20260904155503A787EC832774768DC56F",
"Action": "",
"Version": "",
"Service": "",
"Region": ""
},
"Result": {
"ResultCount": 3,
"WebResults": [
{
"Id": "19b903d59c017bbb04c7832574500d49",
"SortId": 1,
"Title": "OpenAI News | OpenAI",
"SiteName": "OpenAI",
"Url": "https://openai.com/news/",
"Snippet": "Stay up to speed on the rapid advancement of AI technology and the benefits it offers to humanity.",
"Summary": "Stay up to speed on the rapid advancement of AI technology and the benefits it offers to humanity.",
"PublishTime": "2026-09-03T07:50:20+08:00",
"PublishTimeUnix": 1788393020,
"LogoUrl": "https://p16-bpsearch-sign.ibyteimg.com/...<signed>"
}
],
"SearchContext": {
"OriginQuery": "OpenAI latest news",
"SearchType": "web"
},
"TimeCost": 935,
"LogId": "20260904155503A787EC832774768DC56F",
"Choices": null,
"Usage": null
}
}