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
titletext—Yes
descriptiontext—No
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
titletext—Yes
authortext—No
avatarimage_url—No
logoimage_url—No
bgColorcolor#0f172aNo
accentcolor#6366f1No

product-card ​

Product showcase with image, price, and badge.

VariableTypeDefaultRequired
nametext—Yes
product_imageimage_url—No
pricetext—No
badgetext—No
bgColorcolor#0f172aNo

social-share ​

Social media sharing card with hero image.

VariableTypeDefaultRequired
titletext—Yes
descriptiontext—No
imageimage_url—No
logoimage_url—No

stats-card ​

Metrics dashboard displaying up to 4 statistics.

VariableTypeDefaultRequired
titletext—No
stat1_numbertext—Yes
stat1_labeltext—Yes
stat2_numbertext—No
stat2_labeltext—No
stat3_numbertext—No
stat3_labeltext—No
stat4_numbertext—No
stat4_labeltext—No
bgColorcolor#0f172aNo

code-snippet ​

Code display with syntax highlighting.

VariableTypeDefaultRequired
codetext—Yes
titletext—No
languagetextjavascriptNo
themetextdarkNo

quote-card ​

Quote with author attribution and avatar.

VariableTypeDefaultRequired
quotetext—Yes
authortext—No
avatarimage_url—No
bgColorcolor#0f172aNo

event-card ​

Event announcement with date and location.

VariableTypeDefaultRequired
titletext—Yes
datetext—No
locationtext—No
imageimage_url—No
accentcolor#6366f1No

comparison-card ​

Before/after comparison with two columns.

VariableTypeDefaultRequired
left_titletextBeforeYes
right_titletextAfterYes
left_itemstext—No
right_itemstext—No

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


changelog-card ​

Release changelog with version and changes list.

VariableTypeDefaultRequired
versiontext—Yes
change_itemstext—No
datetext—No
logoimage_url—No

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


minimalist-text ​

Clean, minimal title and subtitle design.

VariableTypeDefaultRequired
titletext—Yes
subtitletext—No
bgColorcolor#ffffffNo
textColorcolor#0f172aNo

URLPix — Screenshot & OG Image API