API Documentation

Generate beautiful OG images with a simple API call.

Quick Start

1

Create an account

Sign up and get 100 free credits

2

Generate an API key

Go to Dashboard → API Keys → Create Key

3

Make your first request

Use the examples below

Code Examples

curl -o og-image.png \
  -H "x-api-key: og_your_api_key" \
  "https://ogshot.cc/api/og?title=Hello%20World&template=gradient"

Endpoints

GET/api/og

Generate an OG image

Headers

x-api-keyYour API keyrequired

Query Parameters

titlestringrequired

Main heading text

subtitlestringoptional

Secondary text below title

templatestringoptional

Template name: minimal, gradient, glass, bold, neon Default: minimal

widthnumberoptional

Image width in pixels (max 2400) Default: 1200

heightnumberoptional

Image height in pixels (max 1260) Default: 630

Response Codes

CodeDescription
200Success — returns PNG image
400Bad request — invalid parameters
401Unauthorized — invalid or missing API key
402Payment required — insufficient credits
429Rate limit exceeded

Available Templates

minimal

Minimal

Clean and simple

gradient

Gradient

Vibrant gradient orbs

glass

Glass

Frosted glass effect

bold

Bold

Large typography

neon

Neon

Glowing cyberpunk