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
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| title | String | Yes | Main headline for the OG image. Max length: 200. |
| tag | String | No | Tag/label pill text. Max length: 50. |
| author | String | No | Max length: 100. |
| domain | String | No | Domain name to display. Max length: 100. |
| bg_color | String | No | Hex background color. Default: #1a202c. |
| subtitle | String | No | Subtitle text. Max length: 300. |
| template | ENUM | No | Allowed values: blog, minimal, bold, card. Default: blog. |
| background | ENUM | No | Allowed values: solid, gradient, gradient_horizontal, gradient_vertical, pattern, mesh. Default: solid. |
| text_color | String | No | Hex text color. Default: #ffffff. |
| accent_color | String | No | Hex accent color. Auto-derived if omitted. |
| reading_time | String | No | Reading 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.