OG image generator

POST /api/og-image-generate2 quota units per call · cache hits free

Generate Open Graph (og:image) share-card images dynamically. Configurable title, subtitle, theme, and accent colour. 1200×630 default — the standard OG size.

Generates Open Graph / Twitter share-card images at the standard 1200×630 resolution — the size every social network expects. Inputs: - `title`, `subtitle`: text content. - `theme`: visual style preset. - `accentColor`: hex colour used for highlights / accents. - `logo` (optional): a logo PNG to render in a corner. Use this in your CDN-cached `/og` route so each blog post, product, or page gets a unique share image without you having to design one in Figma.

Inputs

Name	Type	Default	Description
title*	string	—	Big headline (1–200 chars).
subtitle	string	—	Optional subhead under the title (max 300 chars).
brand	string	—	Optional brand label rendered bottom-left (max 64 chars).
background	string	"#0f172a"	Background colour (CSS hex, e.g. #0f172a).
accent	string	"#0ea5e9"	Accent colour for the rule + brand mark.
titleColor	string	"#ffffff"	Title text colour.
subtitleColor	string	"#cbd5e1"	Subtitle text colour.
width	number (200…4000)	1200	Output width in px. 1200 = OpenGraph standard.
height	number (200…4000)	630	Output height in px. 630 = OpenGraph standard.

Response

Modes: binary, json. Cache: yes (24h TTL).

Every response carries x-cache (HIT / MISS / BYPASS), x-cache-signature (stable across identical inputs), and the rate-limit headers listed below.

Quota & limits

Cost per call	2 units against the 10,000-unit monthly quota. Cache hits are free — only cache misses decrement.
Burst limit	200 requests per rolling minute, shared across all tools.
Max request size	`64 KiB` (base64 inflates file payloads ~33% — the limit applies to the decoded bytes).
Max response size	`8 MiB`
Timeout	30s wall clock.
Rate-limit headers	`X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Burst-Limit` on every response; `X-Quota-Warning` once 80% of the monthly quota is spent; `Retry-After` on 429s.

Errors

Errors are JSON with an error string; schema failures add a details object (Zod's flattened field errors).

Status	When	Body
400	Input fails the tool's schema (wrong type, missing required field, malformed base64) or the file bytes can't be parsed as the expected format.	{ "error": "invalid inputs", "details": { "fieldErrors": { … } } }
401	Missing or invalid X-Api-Key / X-Account-Id headers (or no session when called from the browser).	{ "error": "unauthorized" }
404	Unknown tool id, or calling /api/* on the website hostname instead of api.xtract.bot.	{ "error": "not found" }
413	Request body over the tool's max request size, or an image header declaring more megapixels than the tool's pixel budget.	{ "error": "…exceeds maxRequestBytes…" }
415	Content-Type isn't application/json on the json-body transport.	{ "error": "unsupported content-type; expected application/json" }
429	Monthly quota or the 200/min burst limit exhausted. Check Retry-After and the X-RateLimit-* headers.	{ "error": "monthly quota exceeded", "monthRemaining": 0, … }
5xx	Conversion engine failure. Safe to retry; if it persists, the input is hitting a bug — please report it.	{ "error": "…" }

Code samples

Built from the default example.


curl -X POST https://api.xtract.bot/api/og-image-generate \
  -H "Content-Type: application/json" \
  -H "Accept: application/octet-stream" \
  -H "X-Account-Id: $XTRACT_ACCOUNT_ID" \
  -H "X-Api-Key: $XTRACT_API_KEY" \
  -d '{
  "title": "xtract.bot — file conversion API for developers"
}'