OG Awesome API

npm install og-awesome
# or
pnpm add og-awesome

import { OgAwesome } from 'og-awesome'

const og = new OgAwesome({ apiKey: process.env.OG_API_KEY })

const { url } = await og.default({
  title:    'Hello World',
  template: 'gradient',
  font:     'FunnelSans',
  weight:   '700',
})

const { url } = await og.blog({
  title:       'TypeScript Tips You Need to Know',
  subtitle:    'Level up your type safety.',
  author:      'Jane Doe',
  siteName:    'Dev Weekly',
  titleFontSize: 68,
  subtitleFontSize: 34,
  authorFontSize: 24,
  siteNameFontSize: 20,
  authorImage: 'https://example.com/avatar.jpg',
  template:    'dark',
})

const { url } = await og.product({
  productName: 'Acme Widget Pro',
  tagline:     'The fastest widget on the market.',
  brandName:   'Acme Corp',
  titleFontSize: 72,
  subtitleFontSize: 34,
  authorFontSize: 28,
  image:       product.imageUrl,  // required
  template:    'split',
})

const { url } = await og.profile({
  name:     'Jane Doe',
  jobTitle: 'Senior Engineer',
  company:  'Acme Corp',
  titleFontSize: 72,
  subtitleFontSize: 34,
  authorFontSize: 26,
  image:    'https://example.com/jane.jpg',
  template: 'dark',
})

const buffer = await og.blog({ title: 'My Post', download: true })
// buffer is ArrayBuffer — write to disk, pipe to response, etc.

import { OgAwesome, OgAwesomeError } from 'og-awesome'

try {
  const { url } = await og.blog({ title: 'My Post' })
} catch (err) {
  if (err instanceof OgAwesomeError) {
    console.error(err.status, err.body)
    // e.g. 401, { error: 'Invalid API key' }
  }
  throw err
}

// app/blog/[slug]/page.tsx
import { OgAwesome } from 'og-awesome'
import type { Metadata } from 'next'

const og = new OgAwesome({ apiKey: process.env.OG_API_KEY })

export async function generateMetadata({ params }): Promise<Metadata> {
  const post = await getPost(params.slug)

  const { url } = await og.blog({
    title:    post.title,
    subtitle: post.excerpt,
    author:   post.authorName,
    siteName: 'My Blog',
    template: 'dark',
  })

  return {
    openGraph: { images: [{ url, width: 1200, height: 630 }] },
    twitter:   { card: 'summary_large_image', images: [url] },
  }
}

curl -X POST https://ogawesome.com/og/blog \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "title": "10 Tips for Better TypeScript",
    "subtitle": "Level up your type safety with these practical patterns.",
    "author": "Jane Doe",
    "siteName": "My Dev Blog",
    "titleFontSize": 68,
    "subtitleFontSize": 34,
    "authorFontSize": 24,
    "siteNameFontSize": 20,
    "authorImage": "https://example.com/avatar.jpg",
    "template": "dark",
    "font": "FunnelSans"
  }'

curl -X POST https://ogawesome.com/og/product \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "productName": "Acme Widget Pro",
    "tagline": "The fastest widget on the market.",
    "brandName": "Acme Corp",
    "titleFontSize": 72,
    "subtitleFontSize": 34,
    "authorFontSize": 28,
    "image": "https://example.com/product.png",
    "template": "split",
    "font": "SNPro",
    "weight": "700"
  }'

curl -X POST https://ogawesome.com/og/profile \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
    "name": "Jane Doe",
    "jobTitle": "Senior Engineer",
    "company": "Acme Corp",
    "titleFontSize": 72,
    "subtitleFontSize": 34,
    "authorFontSize": 26,
    "image": "https://example.com/jane.jpg",
    "template": "dark",
    "font": "Roboto",
    "weight": "700"
  }'

POST https://ogawesome.com/og
Content-Type: application/json
x-api-key: ogas_xxxxxxxxxxxx

{ "title": "My Title" }