API Documentation#

Generate dynamic OG images from templates. One API call gives you a signed URL you can drop straight into your meta tags.

How it works#

1. Create a template — design your image layout with JSX in the dashboard or via the API.
2. Mint a signed URL — call POST /v1/url with your template ID and variables.
3. Use the URL — place it in <meta property="og:image">. Crawlers fetch the image directly from our CDN.

Billing happens at mint time. Image delivery (GET /v1/image) is free and cached.

Getting Started#

• Quick Start — mint your first image URL in under a minute
• Authentication — set up your API key
• Endpoints — full API reference

Resources#

• Examples — cURL, TypeScript, and Python
• Rate Limits — monthly quotas and plan limits
• Errors — error codes and troubleshooting
• Image Delivery — how signed URLs and caching work
• FAQ — common questions