tools

Stealth browser scraping for sites that block normal scrapers (Cloudflare, DataDome, bot detection). Use operation "scrape" for a one-call render of a single URL; create_context → create_page → cleanup remains for multi-step work that reuses one context. Operation "configure" only validates a stealthConfig and returns it with the defaults filled in — it stores nothing, so pass stealthConfig on each scrape or create_context call that should use it.

post/tools/stealth_mode

Request

  • Base URL: https://www.crawlforge.dev/api/v1
  • URL: https://www.crawlforge.dev/api/v1/tools/stealth_mode
  • Auth: API key in header X-API-Key

Request body

operation'scrape' | 'configure' | 'create_context' | 'create_page' | 'get_stats' | 'cleanup'

Stealth operation to perform. "scrape" creates a context, navigates to url, returns the requested formats and tears the context down, all in one billed call. "configure" validates stealthConfig and returns it with defaults filled in; nothing is stored. "create_context" / "create_page": a context to open pages in. "get_stats": the backend's open contexts, browser and proxy state. "cleanup": close the browser and every context.

engine'playwright' | 'camoufox'

Browser engine (camoufox only where installed on the backend)

contextIdstring

Browser context ID for page operations (from a create_context call)

urlToTeststring

URL to navigate to when creating a page

urlstring

URL to scrape. Required for operation "scrape"; the other operations use urlToTest instead.

wait_fornumber

Extra wait after page load, in ms (0-30000), for content that renders after DOMContentLoaded

verboseboolean

Return the full generated fingerprint from create_context instead of a summary

respect_robotsboolean

Respect the target site's robots.txt. Omitted, the compliant default (true) applies: a URL disallowed for CrawlForge is refused before any browser is launched and no credits are charged, and every navigation is checked the same way. The rule is matched against the CrawlForge product token even though the stealth browser presents a randomized User-Agent, so a site owner's "User-agent: CrawlForge" directive binds stealth traffic too. Setting this to false is honoured, returns a warning in the response, and is recorded against your API key.

max_inline_charsnumber

Largest result returned inline, in characters of its JSON (1000-10000000; env CRAWLFORGE_MAX_INLINE_CHARS sets the default). Over it, the result is stored for 1 hour and the response carries a preview, a result_handle, total_chars and truncated: true; read the rest with read_result (1 credit).

Response

The tool's result; 5 credits charged (see x-credits-note and x-extra for add-ons).

successtrue required
dataobject required

The tool's result. Its shape is tool-specific and documented on the tool's docs page (x-docs-url on the operation).

credits_usedinteger required

Credits charged for this call: the operation's x-credits, plus any add-on x-credits-note or x-extra describes.

credits_remaininginteger required

The account's credit balance after this call.

processing_timeinteger required

Server-side processing time in milliseconds.

warningsstring[]

Non-fatal notes: a robots.txt override that was recorded, a format that could not be produced, a redaction that changed the payload.

Changes

No recorded changes to this operation across all 1 revision of this API.