Skip to content

/v1/og/templates

List all available OG image templates.

GET https://api.urlpix.com/v1/og/templates

Returns a JSON array of template metadata including names, descriptions, and available variables.

Built-in Templates

default

Simple OG image with title and description on a gradient background.

VariableTypeDefaultRequired
titletextYes
descriptiontextNo
bgColor1color#667eeaNo
bgColor2color#764ba2No
textColorcolor#ffffffNo
bash
curl "https://api.urlpix.com/v1/og?template=default&title=Hello%20World" \
  -H "X-API-Key: sk_live_YOUR_KEY" -o og.png

blog-post

Blog post card with author name and avatar.

VariableTypeDefaultRequired
titletextYes
authortextNo
avatarimage_urlNo
logoimage_urlNo
bgColorcolor#0f172aNo
accentcolor#6366f1No

product-card

Product showcase with image, price, and badge.

VariableTypeDefaultRequired
nametextYes
product_imageimage_urlNo
pricetextNo
badgetextNo
bgColorcolor#0f172aNo

social-share

Social media sharing card with hero image.

VariableTypeDefaultRequired
titletextYes
descriptiontextNo
imageimage_urlNo
logoimage_urlNo

stats-card

Metrics dashboard displaying up to 4 statistics.

VariableTypeDefaultRequired
titletextNo
stat1_numbertextYes
stat1_labeltextYes
stat2_numbertextNo
stat2_labeltextNo
stat3_numbertextNo
stat3_labeltextNo
stat4_numbertextNo
stat4_labeltextNo
bgColorcolor#0f172aNo

code-snippet

Code display with syntax highlighting.

VariableTypeDefaultRequired
codetextYes
titletextNo
languagetextjavascriptNo
themetextdarkNo

quote-card

Quote with author attribution and avatar.

VariableTypeDefaultRequired
quotetextYes
authortextNo
avatarimage_urlNo
bgColorcolor#0f172aNo

event-card

Event announcement with date and location.

VariableTypeDefaultRequired
titletextYes
datetextNo
locationtextNo
imageimage_urlNo
accentcolor#6366f1No

comparison-card

Before/after comparison with two columns.

VariableTypeDefaultRequired
left_titletextBeforeYes
right_titletextAfterYes
left_itemstextNo
right_itemstextNo

left_items and right_items accept newline-separated values (max 20 items each).


changelog-card

Release changelog with version and changes list.

VariableTypeDefaultRequired
versiontextYes
change_itemstextNo
datetextNo
logoimage_urlNo

change_items accepts newline-separated values (max 20 items).


minimalist-text

Clean, minimal title and subtitle design.

VariableTypeDefaultRequired
titletextYes
subtitletextNo
bgColorcolor#ffffffNo
textColorcolor#0f172aNo

URLPix — Screenshot & OG Image API