Skip to content package
@vercel/og v0.11.1 Generate Open Graph Images dynamically from HTML/CSS without a browser
node >=16 2 deps esm types
overview readme
license MPL-2.0
deps 2
unpacked 6.6 MB
files 13
node >=16 $ npm install @vercel/og@0.11.1n npmREADME GitHub-flavored package documentation.
downloads Across all versions.
Download trend unavailable.
compatibility Runtime metadata.
keywords Tagged topics.
open graph image open graph og image og:image social card image
install size Estimated unpacked size across 21 packages.
41.0 MB
Includes dependencies.
dependencies 2 direct · 2 outdated
versions Latest published Sep 22, 2026
contents Open Graph Image Generation
Generate Open Graph images with Vercel’s API route functions
Quick Start
Install @vercel/og, then use it inside an API route in your Next.js project:
// /pages/api/og.jsx
import { ImageResponse } from '@vercel/og'
export default
Mar 5, 2026
maintainers Registry package owners.
function
() {
return new ImageResponse (
(
< div
style={ {
width: '100%' ,
height: '100%' ,
display: 'flex' ,
alignItems: 'center' ,
justifyContent: 'center' ,
fontSize: 128 ,
background: 'lavender' ,
} }
>
Hello!
</ div >
)
)
}
copy
Then run next dev and access localhost:3000/api/og, the React element will be rendered and responded as a PNG from that endpoint:
Read more about the API, supported features and check out the examples in the following sections.
API Reference The package exposes an ImageResponse constructor, with the following options available:
import { ImageResponse } from '@vercel/og'
// ...
new ImageResponse (
element: ReactElement,
options: {
width?: number = 1200
height ?: number = 630
emoji ?: 'twemoji' | 'blobmoji' | 'noto' | 'openmoji' | 'fluent' | 'fluentFlat' = 'twemoji' ,
fonts?: {
name: string,
data: ArrayBuffer,
weight: number,
style: 'normal' | 'italic'
}[]
debug ?: boolean = false
// Options that will be passed to the HTTP response
status ?: number = 200
statusText ?: string
headers ?: Record < string, string>
},
) copy When running in production, these headers will be included by @vercel/og:
'content-type' : 'image/png' ,
'cache-control' : 'public, immutable, no-transform, max-age=31536000' , copy During development, the cache-control: no-cache, no-store header is used instead.
Supported HTML and CSS Features By default, @vercel/og only has the Noto Sans font included. If you need to use other fonts, you can pass them in the fonts option. Check the Custom Font example below for more details.
Examples
Development / Contributing
Playground
pnpm i inside the playground/ directory
pnpm dev to start the Next.js app
Package
pnpm i inside the root directory
pnpm build to build the library
Acknowledgements This project will not be possible without the following projects: