katsau Docs
GET/v1/preview

Simulate how your URL will appear across different social platforms.

📱 Multi-Platform Preview

See exactly how your links will look on Twitter, Facebook, LinkedIn, Slack, Discord, WhatsApp, and Telegram. Get warnings about missing or problematic tags.

Query Parameters

NameTypeRequiredDefaultDescription
urlstring-The URL to generate previews for
platformsstringtwitter,facebook,linkedinComma-separated list of platforms
Try it out
GET /v1/preview

See how your URL appears on social platforms

curl "https://api.katsau.com/v1/preview?url=https%3A%2F%2Fgithub.com" \
  -H "Authorization: Bearer YOUR_API_KEY"

Supported Platforms

Twitter
600×314
Facebook
500×261
LinkedIn
552×289
Slack
400×209
Discord
400×209
WhatsApp
300×157
Telegram
280×280

Request Example

curl "https://api.katsau.com/v1/preview?url=https://github.com&platforms=twitter,facebook,linkedin" \
  -H "Authorization: Bearer ks_live_your_api_key"

Response

{
  "success": true,
  "data": {
    "url": "https://github.com",
    "previews": {
      "twitter": {
        "platform": "Twitter",
        "card_type": "summary_large_image",
        "dimensions": { "width": 600, "height": 314 },
        "elements": {
          "title": "GitHub: Let's build from here",
          "description": "GitHub is where over 100 million developers...",
          "image": "https://github.githubassets.com/.../github-social.png",
          "domain": "github.com",
          "favicon": "https://github.githubassets.com/favicons/favicon.svg"
        },
        "warnings": []
      },
      "facebook": {
        "platform": "Facebook",
        "dimensions": { "width": 500, "height": 261 },
        "elements": {
          "title": "GitHub: Let's build from here",
          "description": "GitHub is where over 100 million developers...",
          "image": "https://github.githubassets.com/.../github-social.png",
          "domain": "github.com"
        },
        "warnings": []
      },
      "linkedin": {
        "platform": "LinkedIn",
        "dimensions": { "width": 552, "height": 289 },
        "elements": { ... },
        "warnings": []
      }
    }
  },
  "meta": {
    "request_id": "req_abc123xyz",
    "response_time_ms": 456
  }
}

Warnings

Each platform preview includes a warnings array with platform-specific issues:

WarningPlatform
twitter:card missing, defaulting to summary_large_imageTwitter
og:title missing - Facebook may use page title insteadFacebook
og:image missing - LinkedIn preview will be less engagingLinkedIn
No image found - preview will appear without imageAll

List Supported Platforms

Get the full list of supported platforms with their dimensions:

curl "https://api.katsau.com/v1/preview/supported" \
  -H "Authorization: Bearer ks_live_your_api_key"

Use Cases

  • •Content Validation: Check how blog posts look before publishing
  • •SEO Tools: Build link preview debuggers for clients
  • •Social Scheduling: Preview links in social media management apps