API reference
/render/url
Render a screenshot of a public URL using Ogify's browser rendering pipeline.
HTTP request
GET https://api.ogify.dev/render/url?url=https://example.com&viewport=og x-api-key: $OGIFY_KEY
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
| url | string | Yes | Public URL to screenshot. |
| viewport | string | No | Use og, desktop, mobile, or a custom preset if enabled. |
| waitUntil | string | No | load, domcontentloaded, or networkidle. |
Caching behavior
Successful screenshots are cached at the edge. Identical URL and viewport requests may return the cached PNG.
Use stable page URLs and pre-render important marketing pages during deploys to avoid cold screenshots on first share.
Example
curl "https://api.ogify.dev/render/url?url=https://example.com&viewport=og" \ -H "x-api-key: $OGIFY_KEY" \ --output screenshot.png