Skip to main content
A scrape can produce several outputs from one fetched page. Request an array of format names or an object of enabled formats:
If you omit formats, the API requests Markdown. In a format object, omitted or false outputs are disabled. Select at least one output. Outputs you did not request are null in the response.

​
Available outputs

Use screenshot@fullPage through a format array. In a format object, enable screenshot and set screenshotParams.fullPage: true.

​
Choose only what you need

Start with Markdown for a reading or retrieval workflow. Add links to inspect related pages, HTML when document structure matters, or screenshots when visual state matters. Assets and branding are useful when your application needs page media or visual identity. Extra outputs have no current credit surcharge, but images and HTML can increase payload size. Screenshots, branding, and assets require JavaScript rendering. See browser rendering for compatible settings. A successful scrape produces every requested output. The current API does not return a mixture of successful and failed format results. Structured JSON extraction, summaries, and partial-result modes are not available.

​
Content and capture settings

Use content filtering to focus on useful sections. Choose screenshot encoding and delivery independently of the text outputs. All outputs share the source metadata described in Scrape API. Request fields accept camelCase and snake_case. Use the implemented API reference for full request and response schemas; settings shown only in the Draft API are not a guarantee of current support.