apyhub
IMAGE PROCESSING · MARKETING

Dynamic OG Image API

What it does

Open Graph Image Generator creates a binary OG image from the title and optional design fields you send in the request body. Use it when you need a share image for blog posts, product pages, or social previews without building and rendering templates yourself.

Send a body object with a required title, plus optional tag, author, domain, subtitle, and reading_time text. You can also control the look with template (blog, minimal, bold, or card), background (solid, gradient, gradient_horizontal, gradient_vertical, pattern, or mesh), and colors such as bg_color, text_color, and accent_color.

The response is a binary image. That makes it easy to generate an OG asset on demand for CMS workflows, social sharing pipelines, or preview cards in a publishing app. If you already have content metadata, you can map it directly into the image request and keep the generated visual consistent with the rest of your site.

Use Open Graph Image Generator when you want shareable images that match an article headline, label, and brand colors, while keeping the rendering logic behind a single API call.

POST
Dynamic OG Image Generation
https://api.eu.apyverse.com/chisleroff/dynamic-og-image-generation

QUICKSTART

GUIDE

Quickstart

Generate an OG image from a required title.

curl -X POST "https://api.eu.apyverse.com/chisleroff/dynamic-og-image-generation" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Product launch announcement"}'

What you'll get back

Returns a binary file (string with format: "binary"), not a JSON object. The response is the generated image itself.

TRY ITLIVE · 50 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
Tag/label pill text.
Main headline for the OG image.
Domain name to display.
Hex background color.
Subtitle text.
Hex text color.
Hex accent color (auto-derived if omitted).
Reading time label.

About this endpoint

What it does

Generates a dynamic OG image from the supplied body fields and returns the image as a binary string. The request body requires title; other fields are optional and control the image text, colors, template, and background style.

Request Body

ParameterTypeMandatoryDescription
titleStringYesMain headline for the OG image. Max length: 200.
tagStringNoTag/label pill text. Max length: 50.
authorStringNoMax length: 100.
domainStringNoDomain name to display. Max length: 100.
bg_colorStringNoHex background color. Default: #1a202c.
subtitleStringNoSubtitle text. Max length: 300.
templateENUMNoAllowed values: blog, minimal, bold, card. Default: blog.
backgroundENUMNoAllowed values: solid, gradient, gradient_horizontal, gradient_vertical, pattern, mesh. Default: solid.
text_colorStringNoHex text color. Default: #ffffff.
accent_colorStringNoHex accent color. Auto-derived if omitted.
reading_timeStringNoReading time label. Max length: 50.

Response

Returns a binary string containing the generated OG image. The output schema is string with binary format; no JSON response body fields are defined.

Body

Name
Type
Description
bodyREQUIRED
object
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.