API reference
Render template
Render a built-in social-card template as a PNG or as an immutable public image URL.
Recommended request
POST https://api.ogify.online/v1/render/template Content-Type: application/json x-api-key: $OGIFY_KEY
Request body
| Field | Type | Required | Notes |
|---|---|---|---|
| template | string | Yes | blog, product, or saas. |
| title | string | Yes | Main headline, trimmed server-side. |
| author | string | No | Author, company, or site label. |
| tag | string | No | Small category / eyebrow label. |
| brand | string | No | Brand label used in paid-plan template marks. |
| accent_color | #RRGGBB | No | Template accent override. |
| background_color | #RRGGBB | No | Template background override. |
| width | integer | No | 200–2400. Defaults to 1200. |
| height | integer | No | 100–1400. Defaults to 630. |
Example
curl -X POST https://api.ogify.online/v1/render/template \
-H "x-api-key: $OGIFY_KEY" \
-H "Content-Type: application/json" \
-d '{
"template": "blog",
"title": "How we launched Ogify",
"author": "Benjamin · ogify.online",
"tag": "Building in public",
"accent_color": "#C73E1D"
}'JSON response
{
"id": "f4f7...",
"image_url": "https://api.ogify.online/i/f4f7....png",
"content_type": "image/png",
"width": 1200,
"height": 630,
"cache": "MISS",
"renders_used": 12,
"renders_limit": 500
}Binary compatibility endpoint
POST /render/template accepts the same template fields and returns image/png directly. Existing integrations do not need to migrate immediately.
Errors
400 VALIDATION_ERROR 401 INVALID_API_KEY / REVOKED_API_KEY 429 RATE_LIMITED / MONTHLY_QUOTA_EXCEEDED 500 RENDER_ERROR