Docs
Quickstart
Create an API key and render your first screenshot, social card, HTML image, or PDF in minutes.
1. Create an API key
Sign in to the dashboard and generate an API key. Keep it on your server or in CI — never expose it in browser JavaScript.
export OGIFY_KEY="ogfy_live_..."
2. Turn one URL into a social card
curl -X POST https://api.ogify.online/v1/render/social \
-H "x-api-key: $OGIFY_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/blog/launch"}'Ogify extracts metadata, captures the page, builds a branded card, stores it, and returns a hosted URL.
3. Or use the SDK
npm install @ogify/sdk
import { Ogify } from "@ogify/sdk";
const ogify = new Ogify({ apiKey: process.env.OGIFY_API_KEY! });
const image = await ogify.render.screenshot({
url: "https://example.com",
full_page: true,
format: "webp"
});
console.log(image.url);4. Other high-value endpoints
/v1/render/html renders HTML/CSS to images, /v1/render/pdf generates PDFs, /v1/render/batch groups work, and /v1/jobs moves heavier renders to asynchronous jobs with webhooks.