API reference
Screenshot URL
Capture viewport, full-page, or element screenshots and receive a hosted PNG, JPEG, or WebP URL.
HTTP request
POST https://api.ogify.online/v1/render/url Content-Type: application/json x-api-key: $OGIFY_KEY
Request body
| Field | Type | Required | Notes |
|---|---|---|---|
| url | string | Yes | Public http/https URL. Private/local hosts are blocked. |
| viewport_width | integer | No | 320–2400. Defaults to 1200. |
| viewport_height | integer | No | 240–3000. Defaults to 630. |
| full_page | boolean | No | Capture the entire page height. |
| selector | string | No | Capture one matching element instead of the viewport. |
| format | png | jpeg | webp | No | Defaults to png. |
| quality | integer | No | 1–100 for JPEG/WebP. |
| delay | integer | No | 0–10000 ms after navigation. |
| wait_until | string | No | load, domcontentloaded, or networkidle0. |
| wait_for_selector | string | No | Wait for a CSS selector before capture. |
| custom_css | string | No | Inject up to 100 KB of CSS before capture. |
| custom_js | string | No | Run page-side JavaScript before capture. |
| dark_mode | boolean | No | Emulate prefers-color-scheme: dark. |
| hide_selectors | string[] | No | Hide up to 25 elements before capture. |
| headers | object | No | Additional safe request headers. |
| user_agent | string | No | Override browser user agent. |
| device_scale_factor | number | No | 1–3 for higher-density output. |
| cookies | array | No | Set up to 50 cookies before navigation. |
| locale | string | No | Set Accept-Language for localized pages. |
| timezone | string | No | IANA timezone used by the browser page. |
| click_selector | string | No | Click an element before capture. |
| scroll_to | number | bottom | No | Scroll before capture to trigger lazy content. |
| block_resources | string[] | No | Optionally block image, stylesheet, font, media, or script resources. |
| clip | object | No | Capture x/y/width/height region. Not with selector/full_page. |
| omit_background | boolean | No | Preserve transparency where supported. |
Example
curl -X POST https://api.ogify.online/v1/render/url \
-H "x-api-key: $OGIFY_KEY" \
-H "Content-Type: application/json" \
-d '{
"url":"https://example.com",
"full_page":true,
"format":"webp",
"quality":88,
"hide_selectors":[".cookie-banner"],
"wait_until":"networkidle0"
}'Browser controls
Use selector or clip for partial captures, custom_css/custom_js for page automation, cookies for authenticated sessions you control, click_selector and scroll_to for lazy UI, and locale/timezone controls for regional rendering.
full_page and selector cannot be used together.
Security
Ogify blocks direct private/local URLs and aborts browser subrequests to direct private/local hosts. Some sites may still show region-specific pages, consent dialogs, login screens, or anti-bot challenges because Ogify captures the page the browser actually receives.