Basic
Search
Search the web across multiple engines and return ranked results, optional images, and full page content for selected results.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
query*string
Length
1 <= lengthsearch_service?string
Value in
- "google"
- "bing"
- "bingcn"
- "duckduckgo"
- "yahoo"
- "yandex"
- "youtube"
- "x"
- "reddit"
- "github"
- "arxiv"
- "wechat"
- "bilibili"
- "imdb"
- "wikipedia"
- ""
- "baidu"
- "360"
- "quark"
max_results?integer
Range
1 <= value <= 50Default
5page?integer
Range
1 <= value <= 100Default
1crawl_results?integer
Range
0 <= value <= 50Default
0image?boolean
Default
falseinclude_sites?array<string>
Default
[]exclude_sites?array<string>
Default
[]language?string
time_range?string
Value in
- "day"
- "week"
- "month"
- "year"
- ""
Response Body
application/json
application/json
application/json
application/problem+json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/search" \ -H "Content-Type: application/json" \ -d '{ "query": "string" }'{ "searchParameters": { "query": "string", "search_service": "google", "max_results": 5, "page": 1, "crawl_results": 0, "image": false, "include_sites": [], "exclude_sites": [], "language": "string", "time_range": "day" }, "results": [ { "title": "string", "link": "http://example.com", "snippet": "string", "content": "string", "published_date": "2026-09-03", "kind": "repo", "stars": 0, "language": "string", "num_comments": 0, "story_url": "http://example.com", "points": 0 } ], "images": [ "http://example.com" ]}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}{ "ok": false, "error": "string", "message": "string", "errors": [ { "field": "string", "message": "string", "code": "string" } ], "type": "http://example.com", "title": "string", "status": 0, "detail": "string"}