Integration of @vercel/og - a new library to generate OG image

Table of Contents

On October 11, 2022, Vercel launched a new library of OG image generators.

Their former generator, vercel/og-image is still available. But it requires a repository and a deployment apart from the project, which is a bit cumbersome until it works appropriately.

The newly released @vercel/og is much simpler; you just add a file inside the project (Typescript is needed).

I've tried it on local and it worked well. So, I'd like to write how to insert a dynamic title to @vercel/og in this entry.

Reference OG Image Generation

Environnement de fonctionnement :

  • Node.js v16.18.0
  • React v18.2.0
  • Next.js v12.3.1
  • @vercel/og v0.0.18

Install @vercel/og

Go to the project where you want to use @vercel/og, and install it.

# for npm
npm install @vercel/og

# for yarn
yarn add @vercel/og

Generate API to convert

import { ImageResponse } from '@vercel/og';
import { NextRequest } from 'next/server';

export const config = {
  runtime: 'experimental-edge',

export default function handler(req: NextRequest) {
  try {
    const { searchParams } = new URL(req.url);

    // ?title=<title>
    const hasTitle = searchParams.has('title');
    const title = hasTitle
      ? searchParams.get('title')?.slice(0, 100)
      : 'My default title';

    return new ImageResponse(
            backgroundColor: 'black',
            backgroundSize: '150px 150px',
            height: '100%',
            width: '100%',
            display: 'flex',
            textAlign: 'center',
            alignItems: 'center',
            justifyContent: 'center',
            flexDirection: 'column',
            flexWrap: 'nowrap',
              display: 'flex',
              alignItems: 'center',
              justifyContent: 'center',
              justifyItems: 'center',
              src="data:image/svg+xml,%3Csvg width='116' height='100' fill='white' xmlns=''%3E%3Cpath d='M57.5 0L115 100H0L57.5 0z' /%3E%3C/svg%3E"
              style={{ margin: '0 30px' }}
              fontSize: 60,
              fontStyle: 'normal',
              letterSpacing: '-0.025em',
              color: 'white',
              marginTop: 30,
              padding: '0 120px',
              lineHeight: 1.4,
              whiteSpace: 'pre-wrap',
        width: 1200,
        height: 630,
  } catch (e: any) {
    return new Response(`Failed to generate the image`, {
      status: 500,

Reference Dynamic text generated as image - OG Image Example | Vercel Docs

That's it! Run yarn dev, then go to the following URL. You'll see the OG image.


Just point to the URL as the content of the meta property.


You can change the style on editing the CSS in og.tsx, or Tailwind CSS can be used. You don't have to install Tailwind CSS just for it, which is cool!

Official guidances