# API reference Open Graph Image Template

A dark API card with a method chip, endpoint path pill, and description.

- Page: https://www.shadcn-ui-blocks.com/open-graph-images/api-endpoint
- Category: [Developer](https://www.shadcn-ui-blocks.com/open-graph-images/developer), API and tooling
- Theme: dark, with light and dark renditions
- Preview PNG: https://www.shadcn-ui-blocks.com/open-graph-images/api-endpoint/preview

## Install

```bash
npx shadcn@latest add @shadcn-ui-blocks/og-image-api-endpoint
```

The code is part of Pro and Team: the install needs an API key from either plan (https://www.shadcn-ui-blocks.com/docs/shadcn-cli).

Use the API reference template for endpoint pages, where the share card should read like a request. It puts the method badge and the path in a request pill above the endpoint's purpose, with a pair of constraint chips at the foot, so a developer knows the verb, the route, and the limits at a glance.

## How it works

This template is a metadata image route for the Next.js App Router. The file exports `size`, `contentType`, and `alt` values plus a default async function that returns an `ImageResponse`. When the reference page is shared, satori converts the JSX into an SVG document, the runtime rasterizes that SVG into a 1200 by 630 PNG, and Next.js serves the result and wires the `og:image` and `twitter:image` tags into the page head automatically. The method badge carries an emerald fill for reads and writes alike, the one accent on an otherwise flat dark card.

## Install

Install with the shadcn CLI using your Shadcn UI Blocks API key:

```bash
npx shadcn@latest add @shadcn-ui-blocks/og-image-api-endpoint
```

The file lands at `app/opengraph-image.tsx`, which makes it the site wide share card. For a reference you will usually move it into the endpoint segment, for example `app/docs/[endpoint]/opengraph-image.tsx`. You can also copy the code from this page straight into your project.

The card renders text with Inter, read from `assets/fonts` at your project root with `node:fs` so the font files never ship to the browser. Download the latin woff files for weights 400, 500, 600, and 700 from [Fontsource](https://fontsource.org/fonts/inter) and save them as `assets/fonts/inter-latin-400-normal.woff` and so on.

## Customize

The `content` object holds `brand`, the `label` chip, the `method`, the `path`, the `title`, the `description`, the `chips` array of constraints, and the `url`. Match the badge color to the verb if you like, green for a `GET`, a warmer tone for a `DELETE`, by editing its `backgroundColor`. To generate a card per endpoint, accept `params` in the default export and pull the method, path, and summary from your route metadata. Keep the path short enough to stay on one line inside the pill.

satori supports a focused subset of CSS: flexbox layout only, flat colors, and an explicit `display: flex` on any element with multiple children. Keep those rules in mind if you rework the layout.
