Skip to main content
POST
/
v1
/
search
Search
curl --request POST \
  --url https://gateway.webit.live/v1/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "locale": "en",
  "country": "US",
  "parsing_type": "plain_text",
  "num_results": 3,
  "search_engine": "google_search",
  "topic": "general",
  "deep_search": true,
  "include_answer": false,
  "include_domains": [
    "<string>"
  ],
  "exclude_domains": [
    "<string>"
  ],
  "start_date": "<string>",
  "end_date": "<string>",
  "time_range": "hour",
  "max_subagents": 3
}
'
{
  "total_results": 123,
  "results": [
    {
      "title": "<string>",
      "description": "<string>",
      "url": "<string>",
      "content": "<string>",
      "metadata": {
        "position": 123,
        "entity_type": "<string>",
        "country": "<string>",
        "locale": "<string>",
        "driver": "<string>"
      },
      "extra_fields": {}
    }
  ],
  "request_id": "<string>",
  "answer": "<string>"
}

Body

application/json

Request body model for the /search endpoint.

​
query
string
required

Search query string

Minimum string length: 1
​
locale
string
default:en
​
country
string
default:US
​
parsing_type
enum<string>

Enum representing the parsing types supported by Nimble

Available options:
plain_text,
markdown,
simplified_html
​
num_results
integer
default:3

Maximum number of results to return (actual count may be less)

Required range: 1 <= x <= 100
​
search_engine
enum<string>

⚠️ DEPRECATED: This parameter is ignored. Use 'focus' parameter instead.

Available options:
google_search,
google_sge,
bing_search,
yandex_search
​
topic
enum<string>

Enum representing the search focus/specialization. Controls which search engine and parameters are used internally.

Available options:
general,
news,
location,
coding,
geo,
shopping,
social
​
deep_search
boolean
default:true

If True, fetches and extracts full page content for each search result. If False, returns only metadata (title, snippet, URL)

​
include_answer
boolean
default:false

Generate LLM answer summary based on search result snippets (works with both deep_search=True and False)

​
include_domains
string[] | null

List of domains to include in search results. Maximum 50 domains.

Maximum array length: 50
​
exclude_domains
string[] | null

List of domains to exclude from search results. Maximum 50 domains.

Maximum array length: 50
​
start_date
string | null

Filter results after this date (format: YYYY-MM-DD or YYYY)

​
end_date
string | null

Filter results before this date (format: YYYY-MM-DD or YYYY)

​
time_range
enum<string>

Filter by recency: hour, day, week, month, or year. Takes precedence over start_date/end_date.

Available options:
hour,
day,
week,
month,
year
​
max_subagents
integer
default:3

Maximum number of subagents to execute in parallel for WSA focus modes (shopping, social, geo). Ignored for traditional SERP focus modes. Default: 3, Range: 1-5.

Required range: 1 <= x <= 5

Response

Successful Response

Response model from SearchService with results and optional LLM answer.

Note: request_id is always a valid UUID generated internally by the middleware, so no validation is needed.

​
total_results
integer
required

Number of results returned

​
results
ResultModel · object[]
required
​
request_id
string
required

Unique identifier for this request (UUID)

​
answer
string | null