V1 — Image API
Synchronous image generation via GET request. Returns a PNG stream directly. No API key required for basic usage.
GET/api/og
Authentication
V1 works without an API key for quick prototyping and embedding. Anonymous requests are rate limited to 10 renders per day per IP.
Authenticated requests (with x-api-key header) get higher rate limits and render tracking in the dashboard.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
template | string | Yes | Template name or custom_* ID. See Templates. |
title | string | Yes | Main heading text. 1–200 characters. |
description | string | No | Subheading or description. Max 500 characters. |
tag | string | No | Category/tag label. Max 50 characters. |
author | string | No | Author name. Max 100 characters. |
avatar | URL | No | Author avatar image. Must be HTTPS. |
logo | URL | No | Brand logo image. Must be HTTPS. |
font | string | No | Google Font name. Default: Inter. |
Color Parameters
All color values are 6-character hex codes without the# prefix.
| Parameter | Alias | Default | Description |
|---|---|---|---|
bgColor | bg | 0a0a0f | Background color |
textColor | text | f0f0f8 | Primary text color |
accentColor | accent | 6366f1 | Accent/highlight color |
surfaceColor | — | 13131a | Surface/card background |
palette | — | — | Preset: midnight, paper, forest, sunset, ocean |
Note
If palette is specified, individual color params override palette defaults.Response
| Header | Value |
|---|---|
Content-Type | image/png |
Cache-Control | public, max-age=86400, s-maxage=86400 |
The image is 1200×630 px PNG, optimized for social media platforms.
Error Responses
| Status | Meaning |
|---|---|
400 | Invalid parameters (JSON with error and details) |
401 | Invalid API key |
404 | Custom template not found |
429 | Rate limit exceeded |
500 | Internal server error |
Example
cURL
curl -o og-image.png \ "https://ogmint.app/api/og?template=blog&title=Hello+World&author=Jane&palette=sunset"