Quickstart

Build a URL, get a PNG. That's the entire API.

https://api.opengraphapi.com/v1/card?template=blog-og&title=Hello+World&subtitle=My+first+card&bg=sunset

Open it in a browser — that's your image. Use it anywhere an image URL works:

<meta property="og:image" content="https://api.opengraphapi.com/v1/card?template=blog-og&title=${encodeURIComponent(post.title)}">

Parameters

Templates

Machine-readable list: GET /v1/templates

API keys & limits

Without a key you get 300 images/day per IP with a small watermark. Your own key from /start/ is free too — magic link, about 60 seconds, no card, and the 300/day is counted per key instead of per shared IP. Need more? Starter $19/mo (500/day) and Growth $49/mo (3,000/day) guarantee watermark-free renders, private caching and email support. Self-serve checkout is live.

Responses include an x-ratelimit-remaining header. When the daily quota is exhausted the API returns HTTP 429 until the next UTC day.

Recipes

# cURL — save a certificate
curl -o cert.png "https://api.opengraphapi.com/v1/card?template=certificate&title=Jane+Doe&subtitle=SEO+Course&api_key=YOUR_KEY"

# JavaScript — dynamic OG image in Next.js / Astro
export function ogImageUrl(title: string) {
  const u = new URL("https://api.opengraphapi.com/v1/card");
  u.searchParams.set("template", "blog-og");
  u.searchParams.set("title", title);
  u.searchParams.set("api_key", process.env.OG_API_KEY!);
  return u.toString();
}

# Python — batch product images
import requests, urllib.parse
for name, price in products:
    url = "https://api.opengraphapi.com/v1/card?" + urllib.parse.urlencode(
        {"template": "product", "title": name, "price": price, "api_key": KEY})
    open(f"{name}.png", "wb").write(requests.get(url).content)