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.

Look up which driver Nimble recommends for a given domain or agent — including detected antibot systems and whether JavaScript rendering is required. Use the result to set the driver parameter explicitly on Extract or Agent requests.
Nimble selects the optimal driver automatically on every request. Use Domain Knowledge when you want to understand the driver tier before running at scale, or to pin a specific tier for cost predictability.

​
Quick Start

​
Example Request

curl -X GET 'https://sdk.nimbleway.com/v1/domain-knowledge/driver?url=www.lowes.com' \
--header 'Authorization: Bearer <YOUR-API-KEY>'

​
Example Response

{
  "url": "www.lowes.com",
  "driver": "vx6",
  "antibots": ["akamai", "threatmetrix", "recaptcha", "akamai-sbsd"],
  "description": "Native Driver - non rendered fast request",
  "need_to_render": false
}
Agent lookup response: 
{
  "agent": "target_serp",
  "driver": "wsa-10m",
  "antibots": ["perimeterx", "f5-shape", "recaptcha"],
  "description": "Stealth Driver - stealth browser with advanced bypassing any site, for Agents managed by Nimble",
  "need_to_render": true
}

​
How it works

1

Submit a URL or agent name

Pass either a url (domain) or agent name as a query parameter. Exactly one must be provided.
2

Nimble resolves the driver

Nimble queries its domain knowledge database to identify the antibot systems protecting the target and returns the recommended driver.
3

Pin the driver on your Extract or Agent request

Use the returned driver value in the driver parameter of an Extract or Agent request to skip auto-detection and use the resolved tier directly.

​
Parameters

​
url
string
Target domain to resolve the driver for.Example: amazon.comMutually exclusive with agent — provide exactly one.
​
agent
string
Agent name to resolve the driver for.Example: amazon_pdpMutually exclusive with url — provide exactly one.

​
Response fields

FieldTypeDescription
driverstringRecommended driver (e.g. vx6, vx8, vx10, wsa-6m)
descriptionstringHuman-readable description of the driver
antibotsarrayAntibot systems detected on the domain (e.g. cloudflare, perimeterx, recaptcha)
need_to_renderbooleanWhether JavaScript rendering is required
urlstringEchoed input (present when url query param was used)
agentstringEchoed input (present when agent query param was used)

​
Using the result with Extract

Pass the resolved driver value directly to an Extract request to skip auto-detection.
If the resolved driver is a wsa-* value, use the equivalent vx driver instead when calling Extract. See the conversion table below.
Agent driverExtract driver
wsa-6 / wsa-6mvx6
wsa-8 / wsa-8mvx8
wsa-10 / wsa-10mvx10
cURL
# Step 1 — resolve the driver
curl -s -X GET 'https://sdk.nimbleway.com/v1/domain-knowledge/driver?url=www.lowes.com' \
--header 'Authorization: Bearer <YOUR-API-KEY>'

# Step 2 — use the resolved driver in Extract
curl -X POST 'https://sdk.nimbleway.com/v1/extract' \
--header 'Authorization: Bearer <YOUR-API-KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://www.lowes.com/pl/Drills/4294857312",
    "driver": "<DRIVER>"
}'

Extract

Use the resolved driver in Extract requests via the driver parameter

Agents

Resolve the driver for any pre-built or custom agent

Pricing

Understand how driver tiers affect request cost