---
title: "Generate branded Open Graph image"
method: POST
path: "/api/agent/tools/og-image"
tags: ["SEO Tools"]
---

# Generate branded Open Graph image

`POST /api/agent/tools/og-image`

## Request body

- SeoOgImageRequest
  - `brandName` string
  - `brandDescription` string
  - `primaryColor` string
  - `logoUrl` string, uri
  - `template` 'product' | 'blog_post' | 'comparison' | 'case_study'
  - `headline` string
  - `subheadline` string

## Response `200`

Success

- SeoToolSuccessResponse
  - `success` boolean, required
  - `tool` string, required
  - `data` object, required — Tool-specific diagnostics payload.
  - `credits_charged` integer, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `402` — Payment required
- `409` — Missing logo or settings conflict
- `413` — Logo payload too large
- `429` — Rate limited
- `500` — Internal error

## Changes

- **2026-03-03** `9cd5ce117b1d` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/citedy/apis/citedy-agent-api/changes/api/agent/tools/og-image/post.md)

---

[API](https://skmtc.dev/citedy/apis/citedy-agent-api.md) · [All operations](https://skmtc.dev/citedy/apis/citedy-agent-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/citedy/citedy-agent-api/revisions/b5785d3fe446/schema)