Extract Async
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Request body model for the /extract endpoint
Target URL to scrape
"https://example.com/page"
Country used to access the target URL, use ISO Alpha-2 Codes
"US"
State used to access the target URL (US and CA only), use ISO Alpha-2 Codes
"NY"
City used to access the target URL
"new_york"
LCID standard locale used for the URL request. Alternatively, user can use 'auto' for automatic locale based on geo-location
"en-US"
Whether to render JavaScript content using a browser. Use 'auto' to let Nimble automatically select the optimal driver configuration per target domain.
true
Whether to parse the response content
Custom extraction recipe defining what data to extract and how to structure it. Each property represents a field in the output.
Response format
html, markdown, screenshot, headers, links Browserless drivers available for web extraction. Use 'auto' to let Nimble automatically select the optimal driver per target domain (equivalent to render: 'auto').
vx6, vx8, vx8-pro, vx10, vx10-pro, auto "vx8"
Customize automatic driver selection: maps driver configuration names to the number of attempts (0-10) to spend on each before escalating to the next (0 skips it). Key order defines the escalation order; at least one configuration must have attempts > 0. Providing it opts the request into 'auto' driver selection. Ignored when a specific driver is set.
Intercept and capture network requests made by the page
Array of actions to perform sequentially during browser rendering
Browser type to emulate
chrome, firefox "chrome"
Operating system to emulate
windows, mac os, linux, android, ios "windows"
Whether to disable browser-based rendering
false
Device type for browser emulation
desktop, mobile, tablet "desktop"
User-defined tag for request identification
"campaign-2024-q1"
Whether to emulate XMLHttpRequest behavior
true
Whether to use HTTP/2 protocol
true
Expected HTTP status codes for successful requests
-9007199254740991 <= x <= 9007199254740991200
201
Referrer policy for the request
random, no-referer, same-origin "no-referrer"
HTTP method for the request
GET, POST, PUT, PATCH, DELETE "GET"
Storage type for async results. Use s3 for Amazon S3 and gs for Google Cloud Platform.
s3, gs "s3"
Repository URL where output will be saved. Format: s3://Your.Bucket.Name/your/object/name/prefix/ - Output will be saved as TASK_ID.json
"s3://Your.Repository.Path/"
A URL to callback once the data is delivered. The API will send a POST request with task details (without the requested data) when the task completes.
"https://your.callback.url/path"
When set to true, the response saved to storage_url will be compressed using GZIP format. If false or not set, response will be saved uncompressed.
false
Custom name for the stored object instead of the default task ID
"my task"