Skip to main content
POST
/
api
/
agent
/
tools
/
og-preview
Extract Open Graph/Twitter preview metadata
curl --request POST \
  --url https://www.citedy.com/api/agent/tools/og-preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>"
}
'
{
  "success": true,
  "tool": "meta-tags",
  "data": {},
  "credits_charged": 1
}

Authorizations

Authorization
string
header
required

Bearer citedy_agent_* key

Body

application/json
url
string<uri>
required

Target page URL.

Maximum string length: 2000

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