Skip to main content
POST
/
api
/
agent
/
tools
/
og-image
Generate branded Open Graph image
curl --request POST \
  --url https://www.citedy.com/api/agent/tools/og-image \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "brandName": "<string>",
  "brandDescription": "<string>",
  "primaryColor": "<string>",
  "logoUrl": "<string>",
  "template": "product",
  "headline": "<string>",
  "subheadline": "<string>"
}
'
{
  "success": true,
  "tool": "meta-tags",
  "data": {},
  "credits_charged": 1
}

Documentation Index

Fetch the complete documentation index at: https://www.citedy.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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