Create an Open Graph social preview image
create_og_imageRender a 1200x630 PNG Open Graph / social-card image from a template and return its public URL (for og:image and twitter:image tags), size and ready-to-paste meta tags. Templates: blog, launch, docs, minimal, gradient. Optional inline PNG with include_image. Same engine, cache and free-tier limits as GET /api/og. Read-only (renders are cached; nothing is stored about you).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bg | No | Background hex color, e.g. 0f172a. | |
| fg | No | Text hex color. | |
| logo | No | Public https:// URL of a PNG, JPEG or SVG logo (max 512 characters, 300 KB). Fetched by OgForge's server. | |
| site | No | Site or brand name, e.g. "example.dev". Max 60 characters (longer text is truncated with "…"). | |
| emoji | No | One emoji, e.g. 🚀 | |
| label | No | Small pill or tag, e.g. "Engineering". Max 40 characters (longer text is truncated with "…"). | |
| theme | No | Color scheme (default depends on the template). | |
| title | Yes | Headline, e.g. "How we cut API latency by 60%". Max 120 characters (longer text is truncated with "…"). | |
| accent | No | Accent hex color. | |
| author | No | Author or byline. Max 60 characters (longer text is truncated with "…"). | |
| subtitle | No | Secondary line / description. Max 200 characters (longer text is truncated with "…"). | |
| template | No | Layout (default blog). | |
| include_image | No | Also return the PNG inline as MCP image content (default false; usually 30-150 KB). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| etag | No | ||
| tier | Yes | ||
| bytes | No | ||
| cache | Yes | MISS, HIT-MEMORY or HIT-EDGE | |
| width | Yes | ||
| height | Yes | ||
| warning | No | e.g. logo_fetch_failed: the image rendered without the logo. | |
| template | Yes | ||
| image_url | Yes | Public PNG URL (GET /api/og?...). Use it as og:image / twitter:image. | |
| meta_tags | No | Ready-to-paste og:image / twitter:card meta tags. | |
| truncated | No | Fields that were shortened to fit. |