Screenshot API
Capture screenshots of any public URL. Returns a job ID for async processing.
TL;DR: POST a URL, get a PNG. ForgeKit handles headless Chrome, scaling, and retries.
Endpoint: POST /api/v1/screenshot
Overview
The Screenshot API renders any public URL in headless Chrome and returns a pixel-perfect image. Use it for visual regression, OG fallbacks, competitive monitoring, and AI agent browsing. Supports custom viewports, wait conditions, ad blocking, and cookie injection for authenticated pages.
Async jobs
Long-running captures return a job ID. Poll GET /api/v1/jobs/{id} or configure a webhook for completion notification. Ideal for CI pipelines and batch processing.
Code examples
Node.js
const res = await fetch("https://useforgekit.dev/api/v1/screenshot", {
method: "POST",
headers: {
Authorization: "Bearer fk_live_...",
"Content-Type": "application/json",
},
body: JSON.stringify({ url: "https://example.com", width: 1280 }),
});Python
import requests
resp = requests.post(
"https://useforgekit.dev/api/v1/screenshot",
headers={"Authorization": "Bearer fk_live_..."},
json={"url": "https://example.com", "width": 1280},
)cURL
curl -X POST https://useforgekit.dev/api/v1/screenshot \
-H "Authorization: Bearer fk_live_..." \
-d '{"url":"https://example.com","width":1280}'Pricing
250 free credits/month. Paid plans from $19/mo. View pricing.
FAQ
What formats are supported?
PNG, WebP, and JPEG output formats.
Can I capture full-page screenshots?
Yes — set fullPage: true in the request body.
How many credits per screenshot?
1 credit standard, 2 for full-page.