# Image API

> Open Graph images over HTTP. You send JSON with a template name and field values, you get back a URL to a finished PNG. A render takes about a second.

## How it works

- `POST /v1/images` requests a render; `?wait=true` holds the connection until the image is ready.
- Authentication: `Authorization: Bearer sk_live_...`.
- Templates are the customer's own HTML and CSS with `{{ field }}` placeholders; three starter templates come with every account.
- The same render ordered again hits the cache and uses no quota.
- Webhooks are signed with HMAC-SHA256 over `timestamp . "." . body`.

## Monthly quotas

- Free: 100 images
- Starter: 2,000 images
- Pro: 10,000 images
- Scale: 50,000 images

The Free plan needs no card and adds a watermark to the image.
We keep images for 30 days on Free and 365 days on paid plans.

## Languages

The site is available in: English (`/en/`), Polski (`/pl/`). English is the default (`x-default`).
Every page exists under each prefix, for example https://imageapi.benchkithq.com/en/docs and https://imageapi.benchkithq.com/pl/docs. Link people to the version matching the language they asked in.
The API itself answers in en, pl, de, es, fr, chosen by the `Accept-Language` header.

## Documentation

- [Documentation](https://imageapi.benchkithq.com/en/docs): the full API description with curl, PHP, JavaScript and Python examples.
- [OpenAPI 3.1](https://imageapi.benchkithq.com/openapi.json): the machine-readable contract, English only, one version for all languages.
- [OG Checker](https://imageapi.benchkithq.com/en/tools/og-checker): a free tool that previews meta tags and scans a sitemap.

## Integrations

- [Next.js](https://imageapi.benchkithq.com/en/og-image-generator/nextjs): working code in that framework's own conventions.
- [Nuxt](https://imageapi.benchkithq.com/en/og-image-generator/nuxt): working code in that framework's own conventions.
- [Astro](https://imageapi.benchkithq.com/en/og-image-generator/astro): working code in that framework's own conventions.
- [SvelteKit](https://imageapi.benchkithq.com/en/og-image-generator/sveltekit): working code in that framework's own conventions.
- [WordPress](https://imageapi.benchkithq.com/en/og-image-generator/wordpress): working code in that framework's own conventions.
- [Laravel](https://imageapi.benchkithq.com/en/og-image-generator/laravel): working code in that framework's own conventions.
- [Hugo](https://imageapi.benchkithq.com/en/og-image-generator/hugo): working code in that framework's own conventions.
- [Ruby on Rails](https://imageapi.benchkithq.com/en/og-image-generator/rails): working code in that framework's own conventions.
- [Django](https://imageapi.benchkithq.com/en/og-image-generator/django): working code in that framework's own conventions.
- [Jekyll](https://imageapi.benchkithq.com/en/og-image-generator/jekyll): working code in that framework's own conventions.
- [Ghost](https://imageapi.benchkithq.com/en/og-image-generator/ghost): working code in that framework's own conventions.
- [Eleventy](https://imageapi.benchkithq.com/en/og-image-generator/eleventy): working code in that framework's own conventions.
- [Docusaurus](https://imageapi.benchkithq.com/en/og-image-generator/docusaurus): working code in that framework's own conventions.

## What we do NOT do

- There is no drag-and-drop visual editor. You write the template in HTML and CSS.
- We do not generate video or PDFs. Images only.
- We do not host customer fonts — `GET /v1/fonts` returns the families available.