From API key to production crawl

Fetch a single URL through a headless browser. The request is charged to the calling organization and tallied against the URL's host for the day. The response returns either the fetched document directly or a JSON envelope containing cost metadata and any AI-generated answer.

When to use it: Use this endpoint for one-off page retrieval when you need rendered content, proxy routing, or AI extraction. For bulk or asynchronous workloads, prefer the job-based flow. Use premium for hostile targets, disable js only when you know the page is server-rendered, and set wait_until to domcontentloaded or load for pages that keep persistent connections open.

Notes

• The response format branches on content type: text/html for a bare document, application/json when ai_query is present or a screenshot accompanies the page. Do not assume JSON from status alone.
• js=true is the default; disabling it on a client-rendered site returns an empty page and still charges credits. Verify the target serves meaningful HTML before turning it off.
• country requires an ISO 3166-1 alpha-2 code (es, not spain); city requires country, doubles the cost, and must match the pool's spelling exactly (new_york, not new york).

Runs a custom recipe—a JSON array of blocks executed in order against a page. Unlike GET /crawl, you define the blocks, enabling form submission, pagination, field extraction, and other multi-step interactions. Query options (premium, country, js, etc.) control the browser session; the request body contains only the recipe.

When to use it: Use when GET /crawl is insufficient—any crawl requiring clicks, text input, multi-page navigation, or structured data extraction beyond a single page load.

• First block is overridden: blocks[0].details.source supplies the starting URL only; waitUntil, adblock, javascript, images, viewport, userAgent, and proxy settings are derived from query parameters, not your block definition.
• Body fields are strict: Any field outside blocks, name, or expectedOutput returns 422; place all options in the query string.
• Flat pricing: 30 credits regardless of block count, premium, country, or city—cost is per browser session, not per-request complexity.

Retrieves the result of an asynchronous crawl job that previously returned 202 Accepted. Use this endpoint after /crawl indicates a job is still running and you need to poll for completion.

When to use it: Call when /crawl responds with 202 and you need the final result, or when you want to monitor a long-running crawl's progress without consuming credits. Suitable for any polling strategy; no rate limits apply.

• Authentication: Authorization header only. Query parameter ?key= is rejected.
• Privacy by design: Other organizations' job IDs return 404, identical to nonexistent IDs. Job IDs are scoped to your organization prefix.
• No credit headers: 200 responses omit credits_charged and credit headers; collection is always free regardless of outcome.

Sends a prompt to ChatGPT through a browser automation and returns the response as structured JSON nodes—paragraphs, headings, lists, tables, product lists—each preserving citations. The crawler types the prompt into ChatGPT's web interface, waits for the streamed reply, and parses it. No OpenAI API key is required; this drives the public website directly.

When to use it. Use when you need ChatGPT's output with citation metadata intact, or when you lack API access to the underlying model. For simple text extraction from static pages, /crawl is cheaper and faster. This endpoint is priced flat at 30 credits regardless of proxy options.

Notes

• Prompts are typed character-by-character: the 1000-character limit is a hard ceiling, and long prompts consume significant wait time before generation begins.
• A 202 response means the job is still running; collect it from /crawl/{job}, but expect the answer nested under data[0].conversation rather than top-level conversation.
• Failed or unanswered prompts refund credits (credits_charged: 0), though the attempt is still logged against chatgpt.com.

Captures a full-page screenshot of a URL and returns it as a base64-encoded JPEG. Uses the same request parameters as /crawl — same URL, same fetch options, same ai_query — but returns a photographic rendering of the entire scroll height rather than HTML.

When to use it: Use when you need to visually preserve or inspect a page exactly as a browser renders it, including full scroll height, rather than extracting its markup. Useful for archival, visual regression, compliance capture, or any workflow where the rendered appearance matters more than the underlying structure. The flat 30-credit pricing makes costs predictable regardless of proxy tier, geolocation, or AI query usage.

Notes

• images defaults to true (opposite of /crawl), since pages photographed without images show empty boxes where assets belong.
• Response payloads grow large: long pages run to several megabytes, and base64 encoding adds ~33% overhead; consider constraining viewport and reviewing timeouts for tall targets.
• Asynchronous jobs return 202 — collect completed screenshots from /crawl/{job} under data.screenshots[0], not the top-level screenshot field used by synchronous 200 responses.