Search API

Get clean, structured web content in plain text, markdown, or simplified HTML - powered by intelligent parsing and rendering technology.

The Nimble Search API provides intelligent web search and content extraction capabilities powered by advanced parsing and rendering technology. Get clean, structured content from any website in your preferred format.

Base URL

https://nimble-retriever.webit.live

Authentication

All API requests require authentication using a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY

You can find your API key in your Nimble dashboard under account settings.

---

Endpoints

POST /search

Execute web searches and retrieve clean, parsed content from the top results.

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token with your API key

Request Body Parameters

Parameter	Type	Required	Default	Description
query	string	Yes	-	The search query to execute
num_results	integer	No	3	Number of search results to return (max: 100)
parsing_type	enum	No	plain_text	Output format. Options: plain_text, markdown, simplified_html
locale	string	No	en	Locale for search results (e.g., en, fr, de)
country	string	No	US	Country code for search results (e.g., US, FR, GB)
render	boolean	No	true	Enable JavaScript rendering for dynamic content
driver	string	No	vx6	Browser driver version to use
wait	integer	No	null	Wait time in milliseconds before extracting content (useful for JavaScript-rendered pages)

Example Request

curl -X POST https://nimble-retriever.webit.live/search \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "latest AI trends 2025",
    "num_results": 5,
    "parsing_type": "markdown",
    "country": "US",
    "locale": "en"
  }'

Response

Success Response (200 OK)

{
  "message": "Request processed successfully",
  "body": [
    {
      "page_content": "# Latest AI Trends in 2025\n\nThe artificial intelligence landscape has evolved dramatically...",
      "metadata": {
        "title": "Top AI Trends Shaping 2025 - Tech Insights",
        "snippet": "Explore the latest artificial intelligence trends transforming industries in 2025...",
        "url": "https://example.com/ai-trends-2025",
        "position": 1,
        "entity_type": "OrganicResult",
        "country": "US",
        "locale": "en"
      }
    },
    {
      "page_content": "...",
      "metadata": {
        "title": "AI Revolution: What to Expect in 2025",
        "snippet": "From generative AI to autonomous systems...",
        "url": "https://example.com/ai-revolution",
        "position": 2,
        "entity_type": "OrganicResult",
        "country": "US",
        "locale": "en"
      }
    }
  ]
}

Error Responses

Status Code	Description
400	Missing required fields or invalid parameters
401	Invalid or expired API token
500	Internal server error

---

POST /extract

Extract and parse content from specific URLs with advanced rendering and parsing capabilities.

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token with your API key

Request Body Parameters

Parameter	Type	Required	Default	Description
links	array[string]	Yes	-	List of URLs to extract content from (max: 20)
parsing_type	enum	No	plain_text	Output format. Options: plain_text, markdown, simplified_html
locale	string	No	-	Locale for content extraction
country	string	No	-	Country code for content extraction
driver	string	No	vx6	Browser driver version to use
wait	integer	No	null	Wait time in milliseconds before extracting content
render	boolean	No	true	Enable JavaScript rendering

Example Request

curl -X POST https://nimble-retriever.webit.live/extract \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "links": [
      "https://example.com/article-1",
      "https://example.com/article-2"
    ],
    "parsing_type": "markdown",
    "driver": "vx10-pro",
    "wait": 2000
  }'

Response

Success Response (200 OK)

{
  "message": "Request processed successfully",
  "body": [
    {
      "page_content": "# Article Title\n\nClean, parsed content in markdown format...",
      "metadata": {
        "url": "https://example.com/article-1",
        "entity_type": "HtmlContent",
        "country": null,
        "locale": null
      }
    },
    {
      "page_content": "# Another Article\n\nMore parsed content...",
      "metadata": {
        "url": "https://example.com/article-2",
        "entity_type": "HtmlContent",
        "country": null,
        "locale": null
      }
    }
  ]
}

Error Responses

Status Code	Description
400	Missing required links field or invalid parameters
401	Invalid or expired API token
500	Internal server error

---

Parsing Types

The Search API supports three parsing formats to suit different use cases:

plain_text

Converts HTML to clean plain text with preserved line breaks. Scripts, styles, and images are removed. Best for:

• Text analysis and NLP tasks

• Content summarization

• Simple content extraction

Example output:

Latest AI Trends in 2025

The artificial intelligence landscape has evolved dramatically in recent years...

markdown

Converts HTML to markdown format, preserving headings, links, and basic formatting. Best for:

• Documentation extraction

• Content migration

• LLM-friendly input

• Human-readable output

Example output:

# Latest AI Trends in 2025

The artificial intelligence landscape has evolved dramatically...

## Key Developments
- Generative AI advances
- Autonomous systems

simplified_html

Strips unnecessary attributes and elements while maintaining HTML structure. Best for:

• Web scraping with structure preservation

• Custom parsing pipelines

• Lightweight HTML processing

Example output:

<h1>Latest AI Trends in 2025</h1>
<p>The artificial intelligence landscape...</p>
<ul>
<li>Generative AI advances</li>
<li>Autonomous systems</li>
</ul>