katsau Docs
GET/v1/preview/image

Generate visual preview images showing how your URL will appear when shared on social platforms.

🎨 Visual Social Preview Generator

Get an actual image (SVG) mockup of how your link will look on Twitter, Facebook, or LinkedIn. Perfect for documentation, design reviews, and visual testing.

Query Parameters

NameTypeRequiredDefaultDescription
urlstring-The URL to generate a preview for
platformstringtwitterPlatform to simulate: twitter, facebook, or linkedin

🎨 Try it out - Social Preview Generator

Enter a URL above to see how it will appear on social platforms

Request Example

curl "https://api.katsau.com/v1/preview/image?url=https://github.com&platform=twitter" \
  -H "Authorization: Bearer ks_live_your_api_key" \
  -o preview.svg

Response

Returns an SVG image with Content-Type: image/svg+xml

image/svg+xml1200 × 628 pixels (Twitter)

The SVG includes the extracted Open Graph image, title, description, and domain styled like an actual social media card.

Platform Dimensions

Twitter
1200×628

Large image card

Facebook
1200×630

Link preview card

LinkedIn
1200×627

Article card

Twitter Card Types

The generated preview automatically detects the twitter:card type:

summary_large_image

Large image displayed above the title and description. Best for articles and blog posts.

summary

Square thumbnail on the left, title and description on the right. Best for profiles and apps.

Use Cases

  • •Documentation: Show users how links will appear without leaving your app
  • •Design Review: Generate mockups for approval before publishing
  • •Testing: Automated visual testing of Open Graph implementations
  • •Dashboards: Display preview thumbnails in content management systems