Skip to content

Scrape Response Fields

/v2/scrape returns a JSON payload:

{ "success": true, "data": { "markdown": "...", "metadata": { "title": "...", "statusCode": 200 } } }
FieldTypeNotes
successbooleanWhether the request succeeded
dataobjectThe result object (see below)

Which keys appear depends on formats. See Output Formats.

FieldTypeNotes
markdownstringClean Markdown
htmlstringProcessed HTML
rawHtmlstringRaw HTML
linksstring[]Links found on the page
imagesstring[]Image URLs found on the page
summarystringLLM-generated summary
screenshotstringScreenshot artifact (often a signed URL with expiry)
audiostringAudio artifact (often a signed URL with expiry)
jsonobjectStructured extraction result ({ type: "json", ... })
metadataobjectPage metadata. See Metadata Fields.
warningstringWarning message (e.g., truncation)
FieldTypeNotes
actions.screenshotsstring[]Screenshots produced by actions
actions.scrapesarrayHTML snapshots captured during actions ({ url, html })
actions.javascriptReturnsarrayJS return values ({ type, value })
actions.pdfsstring[]PDFs generated by actions

data.changeTracking (when changeTracking format is used)

Section titled “data.changeTracking (when changeTracking format is used)”
FieldTypeNotes
changeTracking.previousScrapeAtstring (datetime)Previous scrape time
changeTracking.changeStatusstringChange status (e.g. new)
changeTracking.visibilitystringVisibility
changeTracking.diffstringDiff (mode-dependent)
changeTracking.jsonobjectStructured diff (mode-dependent)

data.branding (when branding format is used)

Section titled “data.branding (when branding format is used)”

branding is a large design-system profile object (colors, fonts, typography, spacing, components, etc.). Enable it only when you need brand/design extraction.