Open Graph image API

OG Studio

Compose a share card here, then render it anywhere by hitting the endpoint with URL params. Responses are immutable and cached for a year, keyed by every parameter.

Open raw image

Card

Preview · 1200 × 630image/svg+xml
GUIDEShip social cards withouta screenshot pipelineOne GET request renders a share image. Cached at theedge for a year, keyed by every parameter.ogstudio.app/docs

Endpoint

cache-control: public, immutable, max-age=31536000
/api/public/og?title=Ship+social+cards+without+a+screenshot+pipeline&description=One+GET+request+renders+a+share+image.+Cached+at+the+edge+for+a+year%2C+keyed+by+every+parameter.&url=ogstudio.app%2Fdocs&badge=Guide
<meta property="og:image" content="/api/public/og?title=Ship+social+cards+without+a+screenshot+pipeline&description=One+GET+request+renders+a+share+image.+Cached+at+the+edge+for+a+year%2C+keyed+by+every+parameter.&url=ogstudio.app%2Fdocs&badge=Guide" />
<meta name="twitter:card" content="summary_large_image" />

Parameters

title
Headline, 1–220 chars. Auto-wraps to 3 lines.
description
Sub-copy, up to 300 chars, 2 lines.
url
Small footer label, e.g. your domain.
badge
Pill label above the headline.
theme
midnight · paper · forest · ink · ember
image
Full-bleed background image URL (inlined server-side).
logo
Square logo/avatar URL.
dim
0–100 scrim strength over the background image.
align
left (default) or center.

Every distinct parameter set is its own immutable URL with a strong ETag, so CDNs and social crawlers never re-render the same card twice. Change a param to bust the cache.