> ## Documentation Index > Fetch the complete documentation index at: https://aisa.one/docs/llms.txt > Use this file to discover all available pages before exploring further. # BytePlus 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. Billed at a flat $0.00528 per successful call; failed requests are not charged. ## OpenAPI ````yaml openapi/zh/byteplus-search.json POST /apis/v1/byteplus/web-search openapi: 3.1.0 info: description: '' title: BytePlus SearchInfinity (AI Web Search + Fetch) version: '1' x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-configured-paths: - /apis/v1/byteplus/fetch - /apis/v1/byteplus/web-search x-aisa-document: facts_hash: c16ecc545c8cc9a9ae1f102ab63e1f1de53b3d6dc3ff4d52260a9c721fc97877 generator_version: '2' protocol_version: '1' schema_version: '1' composer_version: '13' response_pending: [] document_hash: sha256:0b383c6d98172273ceb9a10076c44f9f043e3d9101c94b5d7f4ad41b54470ddf x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-provider: byteplus-search x-aisa-catalogs: byteplus-search: title: BytePlus SearchInfinity (AI Web Search + Fetch) description: '' x-aisa-document: facts_hash: c16ecc545c8cc9a9ae1f102ab63e1f1de53b3d6dc3ff4d52260a9c721fc97877 generator_version: '2' protocol_version: '1' schema_version: '1' x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote servers: - url: https://api.aisa.one security: - bearerAuth: [] paths: /apis/v1/byteplus/web-search: post: tags: - byteplus summary: BytePlus Web Search description: >- 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. Billed at a flat $0.00528 per successful call; failed requests are not charged. operationId: post_byteplus_web_search requestBody: required: true content: application/json: schema: type: object properties: Query: type: string description: >- The search query. Required. Max 400 characters; the upstream engine also effectively caps around 50 words. example: OpenAI news maxLength: 400 Count: type: integer description: >- Number of results to return. Optional; default 10, maximum 20. maximum: 20 example: 10 default: 10 Filter: type: object description: >- Optional result filter. Both fields are pipe-separated strings of full domains (max 5 each). properties: Sites: type: string description: >- Restrict results to these full domains. Pipe-separated, max 5, e.g. "bytedance.com|byteplus.com". (Sending an array returns 10400 Invalid Parameter.) example: bytedance.com|byteplus.com BlockHosts: type: string description: >- Exclude results from these full domains. Pipe-separated, max 5, e.g. "reddit.com|quora.com". example: reddit.com|quora.com Language: type: string description: >- Optional language hint in the upstream format, e.g. EN, ZH-HANS, ZH-HANT. example: EN TimeRange: description: >- 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. oneOf: - type: string enum: - OneDay - OneWeek - OneMonth - OneYear - type: string pattern: ^\d{4}-\d{2}-\d{2}\.\.\d{4}-\d{2}-\d{2}$ description: Custom range, e.g. 2026-08-01..2026-09-01. example: OneWeek required: - Query examples: basic: summary: Minimal query value: Query: OpenAI news filtered: summary: Query with count, domain filter, language and time window value: Query: OpenAI product launch Count: 10 Filter: Sites: openai.com|bytedance.com BlockHosts: reddit.com Language: EN TimeRange: OneWeek responses: '200': description: >- Search completed successfully. `Result` holds the ranked web results. content: application/json: schema: type: object properties: ResponseMetadata: type: object description: Upstream request metadata. properties: RequestId: type: string description: Unique identifier for this request. Action: type: string Version: type: string Service: type: string Region: type: string Result: type: object description: Search result payload. properties: ResultCount: type: integer description: Number of web results returned. WebResults: type: array description: Ranked list of web results. items: type: object properties: Id: type: string description: Opaque result id. SortId: type: integer description: 1-based rank of the result. Title: type: string description: 结果标题。 SiteName: type: string description: Source site name (may be empty). Url: type: string description: 结果 URL。 Snippet: type: string description: Short text snippet from the page. Summary: type: string description: Longer summary of the page content. PublishTime: type: string description: Publish time in ISO 8601 (may be empty). PublishTimeUnix: type: integer description: Publish time as Unix seconds (0 if unknown). LogoUrl: type: string description: Signed site logo URL (time-limited). SearchContext: type: object description: Echo of the resolved query context. properties: OriginQuery: type: string SearchType: type: string TimeCost: type: integer description: Upstream processing time in milliseconds. LogId: type: string description: Upstream log id (equals ResponseMetadata.RequestId). Choices: type: - array - 'null' description: Reserved; null unless applicable. items: type: object Usage: type: - object - 'null' description: Reserved; null unless applicable. examples: success: summary: Live gateway 200 response value: 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/... SearchContext: OriginQuery: OpenAI latest news SearchType: web TimeCost: 935 LogId: 20260904155503A787EC832774768DC56F Choices: null Usage: null default: content: application/json: schema: {} description: >- Error response; upstream passthrough responses may use provider formats components: securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.