Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nimbleway.com/llms.txt

Use this file to discover all available pages before exploring further.

Ready-to-use code snippets for every Nimble API. Copy, paste, and run.
Prefer not to write code? Install the Nimble plugin and describe what you need in plain language — your AI assistant handles the rest. See the Quickstart Guide for prompt examples.

​
Installation

pip install nimble_python

​
Web Search Agents

Run pre-built agents for popular sites, or create one for any website: 
from nimble_python import Nimble

nimble = Nimble(api_key="YOUR-API-KEY")

result = nimble.agent.run(
    agent="amazon_pdp",
    params={
        "asin": "B08N5WRWNW"
    }
)

parsed = result.data.parsing["parsed"]
print(f"Product: {parsed['product_title']}")
print(f"Price: ${parsed['web_price']}")

​
Extract

Get clean HTML and structured data from any URL: 
from nimble_python import Nimble

nimble = Nimble(api_key="YOUR-API-KEY")

result = nimble.extract(
    url="https://www.example.com",
    render=True,
    formats=["html", "markdown"]
)

print(result.data.html)
Real-time web search with structured results: 
from nimble_python import Nimble

nimble = Nimble(api_key="YOUR-API-KEY")

result = nimble.search(
    query="latest developments in AI agents",
    max_results=5,
    include_answer=True
)

print(f"AI Answer: {result.answer}")
for r in result.results:
    print(f"- {r.title}: {r.url}")

​
Map

Fast URL discovery and site structure mapping: 
from nimble_python import Nimble

nimble = Nimble(api_key="YOUR-API-KEY")

result = nimble.map(
    url="https://www.example.com",
    sitemap="include"
)

for link in result.links:
    print(f"{link.title}: {link.url}")

​
Crawl

Extract content from entire websites: 
from nimble_python import Nimble

nimble = Nimble(api_key="YOUR-API-KEY")

result = nimble.crawl.run(
    url="https://docs.example.com",
    limit=10
)

print(f"Crawl started: {result.crawl_id}")
print(f"Tasks: {len(result.tasks)}")

​
Next steps

Web Search Agents

Learn about intelligent agents that work with any website

Extract Docs

Full Extract API documentation with all parameters

API Reference

Complete API reference for all endpoints

Install Plugin

Use Nimble in Claude Code or Cursor instead of writing code