Documentation page OG image template

This is a real render from the API with the example values below, at 1200×630.

Docs links get pasted into issues, Slack threads and forums all day. A card per page — with the section in the breadcrumb and a short description — tells people they are about to land on the answer, not on your home page. Light by default, like most docs sites.

Fields

Every field is optional. Long text shrinks to fit instead of overflowing; an image field takes a public URL that we fetch on our side.

Render it with one request

Use the slug as template. The response holds the URL of the finished PNG; ?wait=true keeps the connection open until it is ready.

curl -X POST "https://imageapi.benchkithq.com/v1/images?wait=true" \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "template": "docs-page",
    "modifications": {
        "title": "Authenticating requests with API keys",
        "description": "Create a key, send it as a Bearer token and rotate it without downtime.",
        "section": "Getting started",
        "product": "Northwind Docs",
        "site": "docs.northwind.dev",
        "logo": "https://example.com/images/logo-northwind.png"
    }
}'

Or paste a signed URL into og:image

For static sites, Webflow, Shopify and no-code tools: put the fields in the query string and sign it with your signing secret. The first request renders the image, every later one is a redirect to the cached file. How to compute the signature.

<meta property="og:image" content="https://imageapi.benchkithq.com/i/acc_YOUR_ACCOUNT_ID/docs-page.png?description=Create%20a%20key%2C%20send%20it%20as%20a%20Bearer%20token%20and%20rotate%20it%20without%20downtime.&product=Northwind%20Docs&section=Getting%20started&site=docs.northwind.dev&title=Authenticating%20requests%20with%20API%20keys&s=YOUR_SIGNATURE">

Make it yours

accent and theme change per request. For anything more, copy the template into your account: you get an ordinary HTML template with the same fields that you can edit in the dashboard or through the API. If the slug is free on your account, the copy takes it — your integrations switch to your version without changing a line.

curl -X POST "https://imageapi.benchkithq.com/v1/templates/library/docs-page/copy" \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

More OG image templates

Blog post Job posting Event Podcast episode Changelog / release Real estate listing Product card Product on sale Course lesson Recipe Video thumbnail Newsletter issue Quote card Case study / testimonial GitHub repository Feature announcement Profile / author card Comparison (A vs B) Stat highlight

All templates →