nimble search — reference
Real-time web search with 8 focus modes. Returns results with titles, URLs, and optionally full content and AI answers.
Table of Contents
Parameters
| Parameter |
Type |
Default |
Description |
query |
string |
required |
Search query |
search_depth |
string |
deep |
Content depth: lite | fast | deep — see depth table below |
focus |
string or array |
general |
Focus mode (see table below) or array of specific agent names e.g. ["amazon_serp", "target_serp"] |
include_answer |
bool |
false |
AI-synthesized answer (premium — retry without if 402/403) |
max_results |
int |
10 |
Result count (1–100) |
output_format |
string |
— |
plain_text | markdown | simplified_html |
include_domains |
array |
— |
Restrict to these domains (max 50) |
exclude_domains |
array |
— |
Exclude these domains (max 50) |
time_range |
string |
— |
hour | day | week | month | year — cannot combine with dates |
start_date / end_date |
string |
— |
Date range YYYY-MM-DD — cannot combine with time_range |
content_type |
string |
— |
File type filter: pdf, docx, xlsx, documents, spreadsheets, presentations — only with general focus |
max_subagents |
int |
— |
Parallel agents for shopping/social/geo/location (1–5) |
country |
string |
— |
ISO Alpha-2 geo-targeted results (e.g. US) |
locale |
string |
— |
Language code (e.g. en, fr, de) |
deep_search |
bool |
— |
Deprecated — use search_depth instead. true = deep, false = lite. Still works for backward compat. |
CLI uses hyphens (--search-depth, --include-answer). SDK uses underscores (search_depth, include_answer).
Search depth modes
| Mode |
Content |
Speed |
Best for |
lite |
Metadata only (title, URL, snippet) |
Fastest |
High-volume pipelines, URL discovery, quick filtering |
fast |
Rich cached content |
Fast |
AI agents, RAG, chatbots — quality content without scrape latency |
deep |
Full real-time page content |
Slowest |
Research, due diligence, tasks requiring complete source material |
Default for AI agent use: prefer fast — richest content-to-latency ratio.
Focus modes
| Mode |
Best for |
Example query |
general |
Broad web (default) |
"best practices for X" |
coding |
Docs, code, Stack Overflow, GitHub |
"how to implement X in Python" |
news |
Current events, breaking news |
"EU AI Act enforcement 2026" |
academic |
Research papers, scholarly articles |
"transformer attention mechanisms paper" |
shopping |
Products, price comparisons |
"best wireless headphones under $200" |
social |
People, LinkedIn, X, YouTube |
"Jane Doe Head of Engineering" |
geo |
Geographic and regional data |
"tech companies in Berlin" |
location |
Local businesses, restaurants |
"italian restaurants San Francisco" |
CLI
# Fast depth — rich content, low latency (best for agents)
nimble search --query "React server components" --search-depth fast
# Lite — metadata only, fastest
nimble search --query "OpenAI announcements" --focus news --search-depth lite
# Deep — full real-time page scrape
nimble search --query "EU AI Act" --focus news --search-depth deep \
--start-date 2025-01-01 --end-date 2025-12-31
# With AI answer + domain filter
nimble search --query "Python asyncio best practices" \
--focus coding --search-depth fast --include-answer \
--include-domain '["docs.python.org", "realpython.com"]'
# Extract just URLs
nimble --transform "results.#.url" search --query "React tutorials" --search-depth lite
Python SDK
from nimble_python import Nimble
nimble = Nimble(api_key=os.environ["NIMBLE_API_KEY"])
# Fast depth — best default for AI agent use
resp = nimble.search(query="React server components", search_depth="fast")
# Lite — scan many results quickly
resp = nimble.search(
query="OpenAI announcements",
focus="news",
search_depth="lite",
time_range="week",
)
# Deep — full content for research
resp = nimble.search(
query="EU AI Act enforcement",
focus="news",
search_depth="deep",
include_answer=True,
)
# Custom focus — explicit agent array
resp = nimble.search(
query="best wireless headphones",
focus=["amazon_serp", "walmart_serp"],
search_depth="fast",
max_results=10,
)
results = resp.results # list of result objects
answer = resp.answer # AI summary (if include_answer=True)
Response structure
| Field |
Type |
Description |
total_results |
int |
Total results returned |
results |
array |
Search results |
results[].title |
string |
Page title |
results[].description |
string |
Snippet |
results[].url |
string |
Page URL |
results[].content |
string |
Page content — cached (fast) or real-time scraped (deep) |
results[].metadata.position |
int |
Result rank |
results[].metadata.entity_type |
string |
e.g. OrganicResult |
answer |
string |
AI summary (if include_answer=True) |
request_id |
UUID |
Request identifier |
1---2name: nimble-search3description: Reference for nimble search command. Load when searching the live web. Contains: all flags, 8 focus modes.4---56# nimble search — reference78Real-time web search with 8 focus modes. Returns results with titles, URLs, and optionally full content and AI answers.910## Table of Contents1112- [Parameters](#parameters)13- [Search depth modes](#search-depth-modes)14- [Focus modes](#focus-modes)15- [CLI](#cli)16- [Python SDK](#python-sdk)17- [Response structure](#response-structure)1819---2021## Parameters2223| Parameter | Type | Default | Description |24| ------------------------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------- |25| `query` | string | required | Search query |26| `search_depth` | string | `deep` | Content depth: `lite` \| `fast` \| `deep` — see depth table below |27| `focus` | string or array | `general`| Focus mode (see table below) or array of specific agent names e.g. `["amazon_serp", "target_serp"]` |28| `include_answer` | bool | `false` | AI-synthesized answer (premium — retry without if 402/403) |29| `max_results` | int | `10` | Result count (1–100) |30| `output_format` | string | — | `plain_text` \| `markdown` \| `simplified_html` |31| `include_domains` | array | — | Restrict to these domains (max 50) |32| `exclude_domains` | array | — | Exclude these domains (max 50) |33| `time_range` | string | — | `hour` \| `day` \| `week` \| `month` \| `year` — cannot combine with dates |34| `start_date` / `end_date` | string | — | Date range `YYYY-MM-DD` — cannot combine with `time_range` |35| `content_type` | string | — | File type filter: `pdf`, `docx`, `xlsx`, `documents`, `spreadsheets`, `presentations` — only with `general` focus |36| `max_subagents` | int | — | Parallel agents for shopping/social/geo/location (1–5) |37| `country` | string | — | ISO Alpha-2 geo-targeted results (e.g. `US`) |38| `locale` | string | — | Language code (e.g. `en`, `fr`, `de`) |39| `deep_search` | bool | — | **Deprecated** — use `search_depth` instead. `true` = `deep`, `false` = `lite`. Still works for backward compat. |4041CLI uses hyphens (`--search-depth`, `--include-answer`). SDK uses underscores (`search_depth`, `include_answer`).4243---4445## Search depth modes4647| Mode | Content | Speed | Best for |48| ------ | -------------------------------- | -------- | --------------------------------------------------------------- |49| `lite` | Metadata only (title, URL, snippet) | Fastest | High-volume pipelines, URL discovery, quick filtering |50| `fast` | Rich cached content | Fast | AI agents, RAG, chatbots — quality content without scrape latency |51| `deep` | Full real-time page content | Slowest | Research, due diligence, tasks requiring complete source material |5253**Default for AI agent use:** prefer `fast` — richest content-to-latency ratio.5455---5657## Focus modes5859| Mode | Best for | Example query |60| ---------- | ----------------------------------- | ---------------------------------------- |61| `general` | Broad web (default) | "best practices for X" |62| `coding` | Docs, code, Stack Overflow, GitHub | "how to implement X in Python" |63| `news` | Current events, breaking news | "EU AI Act enforcement 2026" |64| `academic` | Research papers, scholarly articles | "transformer attention mechanisms paper" |65| `shopping` | Products, price comparisons | "best wireless headphones under $200" |66| `social` | People, LinkedIn, X, YouTube | "Jane Doe Head of Engineering" |67| `geo` | Geographic and regional data | "tech companies in Berlin" |68| `location` | Local businesses, restaurants | "italian restaurants San Francisco" |6970---7172## CLI7374```bash75# Fast depth — rich content, low latency (best for agents)76nimble search --query "React server components" --search-depth fast7778# Lite — metadata only, fastest79nimble search --query "OpenAI announcements" --focus news --search-depth lite8081# Deep — full real-time page scrape82nimble search --query "EU AI Act" --focus news --search-depth deep \83 --start-date 2025-01-01 --end-date 2025-12-318485# With AI answer + domain filter86nimble search --query "Python asyncio best practices" \87 --focus coding --search-depth fast --include-answer \88 --include-domain '["docs.python.org", "realpython.com"]'8990# Extract just URLs91nimble --transform "results.#.url" search --query "React tutorials" --search-depth lite92```9394## Python SDK9596```python97from nimble_python import Nimble98nimble = Nimble(api_key=os.environ["NIMBLE_API_KEY"])99100# Fast depth — best default for AI agent use101resp = nimble.search(query="React server components", search_depth="fast")102103# Lite — scan many results quickly104resp = nimble.search(105 query="OpenAI announcements",106 focus="news",107 search_depth="lite",108 time_range="week",109)110111# Deep — full content for research112resp = nimble.search(113 query="EU AI Act enforcement",114 focus="news",115 search_depth="deep",116 include_answer=True,117)118119# Custom focus — explicit agent array120resp = nimble.search(121 query="best wireless headphones",122 focus=["amazon_serp", "walmart_serp"],123 search_depth="fast",124 max_results=10,125)126127results = resp.results # list of result objects128answer = resp.answer # AI summary (if include_answer=True)129```130131---132133## Response structure134135| Field | Type | Description |136| -------------------------------- | ------ | ------------------------------------------------------------ |137| `total_results` | int | Total results returned |138| `results` | array | Search results |139| `results[].title` | string | Page title |140| `results[].description` | string | Snippet |141| `results[].url` | string | Page URL |142| `results[].content` | string | Page content — cached (`fast`) or real-time scraped (`deep`) |143| `results[].metadata.position` | int | Result rank |144| `results[].metadata.entity_type` | string | e.g. `OrganicResult` |145| `answer` | string | AI summary (if `include_answer=True`) |146| `request_id` | UUID | Request identifier |