Skip to main content
POST
/
v1
/
search
Search
curl --request POST \
  --url https://sdk.nimbleway.com/v1/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "Nike brand perception consumer reviews 2025",
  "deep_search": false,
  "focus": "social",
  "max_results": 10,
  "include_answer": false
}
'
{
  "answer": "The top web scraping tools in 2024 include...",
  "total_results": 10,
  "results": [
    {
      "title": "Top 10 Web Scraping Tools for 2024",
      "description": "Comprehensive guide to the best web scraping tools...",
      "url": "https://example.com/article1",
      "content": "Full parsed content from the page...",
      "metadata": {
        "published_date": "2024-01-15"
      }
    },
    {
      "title": "Web Scraping Tools Comparison",
      "description": "Compare features, pricing, and performance...",
      "url": "https://example2.com/comparison",
      "content": "Full parsed content from the page...",
      "metadata": {}
    }
  ],
  "request_id": "123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body model for the /search endpoint

​
query
string
required

Search query string

Minimum string length: 1
​
locale
string

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

Example:

"en-US"

​
country
string

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

Example:

"US"

​
output_format
enum<string>

Output format: plain_text, markdown, or simplified_html

Available options:
plain_text,
markdown,
simplified_html
​
max_results
integer

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

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

Search focus mode (e.g., 'general', 'news', 'shopping') or a list of explicit subagent names (e.g., ['amazon_serp', 'target_serp'])

Available options:
general,
news,
location,
coding,
geo,
shopping,
social,
academic
​
content_type
string[] | null

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

Maximum array length: 50
​
deep_search
boolean

Deep Mode (true, default): fetches full-page content for deeper analysis. Fast Mode (false): returns metadata only (title, snippet, URL) for quick, token-efficient results

​
include_answer
boolean

Generate an LLM-powered answer summary based on search result snippets

​
exclude_domains
string[] | null

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

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

List of domains to include in 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. Cannot be combined with start_date/end_date

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

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

Required range: 1 <= x <= 5

Response

Successful Response

Search API response containing search results with titles, descriptions, URLs, and content. Includes optional AI-generated answer when include_answer parameter is enabled. In Deep Search mode (deep_search=true), each result includes full extracted page content. In Fast Mode (deep_search=false), only URLs and metadata are returned.

​
total_results
integer
required

Total number of search results returned in this response

Example:

10

​
results
SearchResultModel · object[]
required

Array of search results, each containing title, description, URL, content (in Deep Search mode), and optional metadata

​
request_id
string
required

Unique identifier for tracking this search request

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
answer
string | null

AI-generated summary answer to your search query (only available when include_answer parameter is enabled). Returns null if disabled or if generation fails.

Example:

"The best web scraping tools in 2024 include..."