Search

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

query*string

Length1 <= length <= 400

max_results?integer

Range1 <= value <= 20

Default10

include_domains?string|array<string>

exclude_domains?string|array<string>

freshness?string

Value in

"day"
"week"
"month"
"year"

start_date?string

Match^\d{4}-\d{2}-\d{2}$

end_date?string

Match^\d{4}-\d{2}-\d{2}$

search_depth?string

Default"basic"

Value in

"basic"
"advanced"

max_content_tokens?integer

Range100 <= value <= 32000

country?string

Length2 <= length <= 2

Response Body

`application/json`

curl -X POST "https://example.com/v1/search" \  -H "Content-Type: application/json" \  -d '{    "query": "string"  }'

{  "request_id": "string",  "query": "string",  "results": [    {      "type": "organic",      "position": -9007199254740991,      "title": "string",      "url": "string",      "domain": "string",      "content": "string",      "extra_snippets": [        "string"      ],      "raw_content": "string",      "published_date": "string",      "favicon": "string",      "disclosure": "string",      "rec_id": "string",      "incentive": {        "kind": "credit",        "code": "string",        "benefit": "string"      }    }  ],  "response_time_ms": 0,  "meta": {    "sponsored_count": 0,    "result_count": 0  }}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

429application/json

502application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`