screenshots
Screenshot / Thumbnail
Generate a thumbnail by simply appending a URL to the service path.
Usage Examples:
# Without scheme (https:// is assumed)
dev.thedrive.ai/example.com/document.pdf
# With full URL
dev.thedrive.ai/https://example.com/image.png
# With options
dev.thedrive.ai/example.com/doc.pdf?w=300&h=200&q=80
# URLs with query strings (e.g., Azure SAS tokens)
dev.thedrive.ai/https://storage.blob.core.windows.net/file.pdf?sv=2024&sig=xxx
In HTML:
<img src="https://dev.thedrive.ai/example.com/preview.png" />
Query Parameters (ours):
- w: Width (default 600, max 2000)
- h: Height (default 400, max 2000)
- q: Quality (default 95, 1-100)
- nocache: Bypass cache (default false)
Screenshot Options (websites only, ignored for documents):
- fullpage: Capture full scrollable page (default false)
- delay: Extra wait in ms after page load, max 5000 (default 0)
- dark: Emulate dark mode / prefers-color-scheme: dark (default false)
- device: Viewport preset — mobile (390x844), tablet (820x1180), desktop (1440x900)
- viewport: Raw viewport override, e.g. 375x812 (overrides device)
- selector: CSS selector to capture a specific element (falls back to viewport if not found)
- wait: CSS selector to wait for before capturing (max 5s timeout)
Note: Query parameters from the target URL (like Azure SAS tokens) are preserved and passed through.
get/{url}
Request
- Base URL: https://docs.thedrive.ai (the document declares no server; this is the origin it was published from)
- URL: https://docs.thedrive.ai/{url}
- Auth: none declared
Path parameters
urlstring required
Query parameters
winteger
hinteger
qinteger
nocacheboolean
formatstring
durationinteger
fullpageboolean
delayinteger
darkboolean
devicestring nullable
viewportstring nullable
selectorstring nullable
waitstring nullable
_skip_og_checkboolean
Response
Thumbnail image
unknown required
Changes
No recorded changes to this operation across all 1 revision of this API.