Skip to main content
POST
Generate branded Open Graph image

Authorizations

Authorization
string
header
required

Bearer citedy_agent_* key

Body

application/json
brandName
string
Maximum string length: 100
brandDescription
string
Maximum string length: 1000
primaryColor
string
Pattern: ^#[0-9A-Fa-f]{6}$
logoUrl
string<uri>
Maximum string length: 2000
template
enum<string>
Available options:
product,
blog_post,
comparison,
case_study
headline
string
Maximum string length: 120
subheadline
string
Maximum string length: 180

Response

Success

success
boolean
required
Example:

true

tool
string
required
Example:

"meta-tags"

data
object
required

Tool-specific diagnostics payload.

credits_charged
integer
required
Required range: x >= 0
Example:

1