Skip to main content
The draft POST /v1/scrape request requires a URL and at least one enabled format. Boolean format selection and the screenshot controls below are supported by the current API; the proposed shared settings, caching, profiles, and partial results are not. Use the implemented scrape guide for current requests.
Omit screenshotParams for an inline viewport screenshot. format accepts png, jpeg or webp, defaulting to jpeg. JPEG/WebP quality defaults to 80; omit quality for PNG. delivery accepts base64 (default) or url for a public image link. Custom viewport dimensions remain in the proposed sharedParams.viewport. For language or country preferences, add shared settings:
Language and country are independent. A language preference does not require country routing. Country selection depends on supported network egress and does not change an explicit language tag. maxAgeMs defaults to 0 and storeInCache defaults to false. Requests with headers, actions, or profiles bypass document caching. Zero data retention is a separate capability. The deadline defaults to 30 seconds. Atomic completion is the default: all requested outputs must succeed. The proposed return-partial mode uses output errors and an explicit partial flag; its implementation and billing policy remain pending. Authenticate with Authorization: Bearer YOUR_API_KEY when this contract is implemented. Keep target-site headers in sharedParams.headers, separate from your url2llm API key.