Public API
API ドキュメント
Pro ライセンスキーで OGP バナーを API から生成できます。CI/CD に組み込んで git push 時に自動生成するなど、開発ワークフローに統合可能です。
認証
リクエストヘッダーまたはクエリパラメータでライセンスキーを渡します。
Header（推奨）
X-License-Key: YOUR_LICENSE_KEY
Query param
?licenseKey=YOUR_LICENSE_KEY
GET/api/generate
OGP バナー画像（PNG）を返します。Edge Runtime で動作するため低レイテンシです。
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
title* | string | バナーのタイトル（必須） |
subtitle | string | サブタイトル |
domain | string | ドメイン表示（例: example.com） |
emoji | string | タイトル上に表示する絵文字（例: 🚀） |
templateId | string | テンプレート ID（デフォルト: minimal-white） |
size | string | ogp / twitter / instagram / youtube（Pro） |
font | string | sans / noto-jp |
customBg | hex | 背景色 HEX（Pro、例: #1a1a1a） |
customText | hex | テキスト色 HEX（Pro） |
customAccent | hex | アクセント色 HEX（Pro） |
licenseKey | string | Pro ライセンスキー（ヘッダー推奨） |
使用例
cURL
curl -H "X-License-Key: YOUR_KEY" \ "https://ogp-banner-gen.vercel.app/api/generate?title=Hello+World&templateId=dark-navy&size=ogp" \ -o banner.png
JavaScript / fetch
const res = await fetch(
'https://ogp-banner-gen.vercel.app/api/generate?' + new URLSearchParams({
title: 'My Blog Post',
subtitle: 'A great article',
domain: 'example.com',
templateId: 'gradient-purple',
size: 'ogp',
}),
{ headers: { 'X-License-Key': process.env.OGP_LICENSE_KEY } }
);
const buffer = await res.arrayBuffer();
// fs.writeFileSync('public/og-image.png', Buffer.from(buffer));GitHub Actions（git push で自動生成）
- name: Generate OGP banner
run: |
curl -H "X-License-Key: ${{ secrets.OGP_KEY }}" \
"https://ogp-banner-gen.vercel.app/api/generate?title=${{ env.POST_TITLE }}&templateId=dark-navy" \
-o public/og.png直接 URL（img タグで埋め込み）
<img src="https://ogp-banner-gen.vercel.app/api/generate?title=My+Page&licenseKey=YOUR_KEY"
width="1200" height="630" />テンプレート ID 一覧
Free: 3 種 / Pro: 47 種（ライセンスキーが必要）
minimal-whiteminimal-darkminimal-grayminimal-swissminimal-editorialminimal-creamminimal-sageminimal-slategradient-purplegradient-bluegradient-greengradient-orangegradient-sunsetgradient-auroragradient-rosegradient-midnightdark-navydark-slatedark-tech-terminaldark-obsidianpixel-blackpixel-gameboyglass-blueglass-purplevivid-pinkvivid-yellowvivid-memphiselegant-creamelegant-charcoalelegant-navy-goldseasonal-waseasonal-sakura...全 50 種レート制限
Free（ライセンスキーなし）1 日 5 リクエスト
Pro（有効なライセンスキーあり）無制限