Appearance
/v1/og/templates
List all available OG image templates.
GET https://api.urlpix.com/v1/og/templatesReturns 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.
| Variable | Type | Default | Required |
|---|---|---|---|
title | text | — | Yes |
description | text | — | No |
bgColor1 | color | #667eea | No |
bgColor2 | color | #764ba2 | No |
textColor | color | #ffffff | No |
bash
curl "https://api.urlpix.com/v1/og?template=default&title=Hello%20World" \
-H "X-API-Key: sk_live_YOUR_KEY" -o og.pngblog-post
Blog post card with author name and avatar.
| Variable | Type | Default | Required |
|---|---|---|---|
title | text | — | Yes |
author | text | — | No |
avatar | image_url | — | No |
logo | image_url | — | No |
bgColor | color | #0f172a | No |
accent | color | #6366f1 | No |
product-card
Product showcase with image, price, and badge.
| Variable | Type | Default | Required |
|---|---|---|---|
name | text | — | Yes |
product_image | image_url | — | No |
price | text | — | No |
badge | text | — | No |
bgColor | color | #0f172a | No |
social-share
Social media sharing card with hero image.
| Variable | Type | Default | Required |
|---|---|---|---|
title | text | — | Yes |
description | text | — | No |
image | image_url | — | No |
logo | image_url | — | No |
stats-card
Metrics dashboard displaying up to 4 statistics.
| Variable | Type | Default | Required |
|---|---|---|---|
title | text | — | No |
stat1_number | text | — | Yes |
stat1_label | text | — | Yes |
stat2_number | text | — | No |
stat2_label | text | — | No |
stat3_number | text | — | No |
stat3_label | text | — | No |
stat4_number | text | — | No |
stat4_label | text | — | No |
bgColor | color | #0f172a | No |
code-snippet
Code display with syntax highlighting.
| Variable | Type | Default | Required |
|---|---|---|---|
code | text | — | Yes |
title | text | — | No |
language | text | javascript | No |
theme | text | dark | No |
quote-card
Quote with author attribution and avatar.
| Variable | Type | Default | Required |
|---|---|---|---|
quote | text | — | Yes |
author | text | — | No |
avatar | image_url | — | No |
bgColor | color | #0f172a | No |
event-card
Event announcement with date and location.
| Variable | Type | Default | Required |
|---|---|---|---|
title | text | — | Yes |
date | text | — | No |
location | text | — | No |
image | image_url | — | No |
accent | color | #6366f1 | No |
comparison-card
Before/after comparison with two columns.
| Variable | Type | Default | Required |
|---|---|---|---|
left_title | text | Before | Yes |
right_title | text | After | Yes |
left_items | text | — | No |
right_items | text | — | No |
left_items and right_items accept newline-separated values (max 20 items each).
changelog-card
Release changelog with version and changes list.
| Variable | Type | Default | Required |
|---|---|---|---|
version | text | — | Yes |
change_items | text | — | No |
date | text | — | No |
logo | image_url | — | No |
change_items accepts newline-separated values (max 20 items).
minimalist-text
Clean, minimal title and subtitle design.
| Variable | Type | Default | Required |
|---|---|---|---|
title | text | — | Yes |
subtitle | text | — | No |
bgColor | color | #ffffff | No |
textColor | color | #0f172a | No |