Search the web in real time and get back titles, links, and snippets.GET https://openapi.dataeyes.ai/v1/search
POST is also supported, with the same parameters in a JSON body.Request parameters#
| Parameter | Type | Required | Description |
|---|
q | string | Yes | Search query. Anything beyond 2,048 characters is truncated |
num | integer | No | Number of results. Default 10, maximum 50 |
range, fileType, includeSite, and excludeSite are reserved parameters and have no effect in the current version.
Request examples#
Response#
{
"code": 0,
"data": {
"originalQuery": "OpenAI API",
"webPages": [
{
"score": 0,
"name": "OpenAI API Platform",
"url": "https://platform.openai.com/",
"displayUrl": "",
"siteName": "",
"siteIcon": "",
"snippet": "Explore developer resources, tutorials, API docs, and dynamic examples ...",
"datePublished": ""
}
]
},
"message": "success"
}
| Field | Description |
|---|
originalQuery | The query that was actually executed |
webPages[].name | Page title |
webPages[].url | Page URL |
webPages[].snippet | Snippet |
webPages[].datePublished | Publish time; empty string if unavailable |
webPages[].displayUrl, siteName, siteIcon, score | Reserved fields; may be empty |
Billing#
Each successful request consumes 1 search credit. If you also need the page content, use Search and Read.