v1

latestOpenAPI 3.1.02026-07-2658119246.0 KB
Search

Search

post/v2/search

Request body

content_typestring[] nullable

Filter by content type (only supported with focus=general). Supports semantic groups ('documents', 'spreadsheets', 'presentations') and specific formats ('pdf', 'docx', 'xlsx', etc.)

countrystring

Country code for geo-targeted results (e.g., 'US', 'GB', 'IL')

deep_searchboolean nullable

Deprecated. Use search_depth instead. true maps to 'deep', false maps to 'lite'.

end_datestring nullable

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

exclude_domainsstring[] nullable

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

include_domainsstring[] nullable

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

localestring

Language/locale code (e.g., 'en', 'fr', 'de')

max_resultsinteger

Maximum number of results to return. Actual count may be lower depending on availability.

max_subagentsinteger

Maximum number of subagents to execute in parallel for WSA focus modes (shopping, social, geo). Ignored for SERP focus modes.

output_format'plain_text' | 'markdown' | 'simplified_html'

Enum representing the parsing types supported by Nimble

querystring required

Search query string

search_depth'lite' | 'fast' | 'deep'

Controls content richness and latency of search results.

  • lite: Token-efficient metadata for high-volume pipelines (title, URL, description only)
  • fast: Rich content (~2K chars) optimized for AI agents
  • deep: Full page content via Webit scraping for comprehensive analysis
start_datestring nullable

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

time_range'hour' | 'day' | 'week' | 'month' | 'year'

Time range filters passed to Webit SERP API as 'time' parameter.

Response

Successful Response

request_idstring required

Unique identifier for this request (UUID)

serp_dataobject nullable

Cleaned SERP entities (e.g. KnowledgeGraph, TopStory, RelatedSearch). Only present for focus='serp'.

total_resultsinteger required

Number of results returned