Skip to content

Output Formats

formats controls which keys appear under data. The default is ["markdown"].

formatResponse keyNotes
markdowndata.markdownClean Markdown
htmldata.htmlProcessed HTML
rawHtmldata.rawHtmlRaw HTML
linksdata.linksLinks
imagesdata.imagesImages
summarydata.summaryLLM-generated summary
brandingdata.brandingBrand/design profile
audiodata.audioAudio artifact (often a signed URL with expiry)
formats: [
{
type: 'json',
prompt: 'Extract the key fields',
schema: { type: 'object', properties: { title: { type: 'string' } } },
},
]
FieldTypeNotes
type"json"Required
schemaobjectJSON Schema
promptstringOptional prompt

Response key: data.json

formats: [{ type: 'screenshot', fullPage: true, quality: 80 }]
FieldTypeNotes
type"screenshot"Required
fullPagebooleanFull page screenshot
qualitynumberQuality setting
viewportobject{ width, height }

Response key: data.screenshot

formats: [{ type: 'changeTracking', modes: ['json', 'git-diff'] }]
FieldTypeNotes
type"changeTracking"Required
modesstring[]e.g. json / git-diff
tagstringOptional
schemaobjectOptional
promptstringOptional

Response key: data.changeTracking

Note: changeTracking requires markdown to also be present in formats.

formats: [{ type: 'attributes', selectors: [{ selector: 'a', attribute: 'href' }] }]
FieldTypeNotes
type"attributes"Required
selectorsarray[{ selector, attribute }]

Response key: implementation-dependent (varies by backend version).