Instantly validate how any URL will appear when shared on Facebook, LinkedIn, Twitter, and WhatsApp. Returns a full JSON report with platform-specific scores, broken tag detection, image dimension checks, and plain-English fix instructions — all in a single API call.
{"success":true,"url":"https://github.com/","checked_at":"2026-05-05T13:18:07.581Z","meta_tags":{"og_title":"GitHub · Change is constant. GitHub keeps you ahead.","og_description":"Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity.","og_image":"https://images.ctfassets.net/8aevphvgewt8/4pe4eOtUJ0ARpZRE4fNekf/f52b1f9c52f059a33170229883731ed0/GH-Homepage-Universe-img.png","og_image_width":null,"og_image_height":null,"og_url":"https://github.com/","og_type":"object","twitter_card":"summary_large_image","twitter_title":"GitHub · Change is constant. GitHub keeps you ahead.","twitter_description":"Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity.","twitter_image":"https://images.ctfassets.net/8aevphvgewt8/4pe4eOtUJ0ARpZRE4fNekf/f52b1f9c52f059a33170229883731ed0/GH-Homepage-Universe-img.png","fallback_title":"GitHub · Change is constant. GitHub keeps you ahead. · GitHub","fallback_description":"Join the world's most widely adopted, AI-powered developer platform where millions of developers, businesses, and the largest open source community build software that advances humanity."},"image":{"url":"https://images.ctfassets.net/8aevphvgewt8/4pe4eOtUJ0ARpZRE4fNekf/f52b1f9c52f059a33170229883731ed0/GH-Homepage-Universe-img.png","reachable":true,"content_type":"image/png","file_size_kb":604,"width":null,"height":null},"platforms":{"facebook":{"status":"pass","score":100,"issues":[]},"linkedin":{"status":"pass","score":100,"issues":[]},"twitter":{"status":"pass","score":100,"issues":[]},"whatsapp":{"status":"pass","score":100,"issues":[]}},"summary":{"overall_status":"pass","total_issues":0,"errors":0,"warnings":0,"platforms_passing":4}}
curl --location --request GET 'https://zylalabs.com/api/12506/social+preview+qa+api/23805/check?url=https://github.com' --header 'Authorization: Bearer YOUR_API_KEY'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the Social Preview QA API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
(Save 2 months with annual billing 🎉)
Every time a developer shares a URL on social media, platforms like Facebook, LinkedIn, Twitter, and WhatsApp crawl that page and build a preview card from its meta tags. When those tags are missing, broken, or the wrong size — the preview looks unprofessional, images don't load, and click-through rates drop.
The Social Preview QA API solves this with a single API call.
Send any URL to the endpoint and get back a complete validation report showing exactly what is working and what needs fixing — per platform, with specific fix instructions.
WHAT IT CHECKS:
- Open Graph tags (og:title, og:description, og:image, og:url, og:type)
- Twitter Card tags (twitter:card, twitter:title, twitter:image)
- Image availability — is the image URL actually reachable?
- Image dimensions — does it meet each platform's size requirements?
- Character limits — title and description length per platform
- HTTPS compliance — flags HTTP images that some platforms silently drop
PLATFORMS COVERED:
- Facebook (1200x630px image requirement, title/description limits)
- LinkedIn (1200x627px minimum for large preview)
- Twitter/X (800x418px minimum for summary_large_image card)
- WhatsApp (300x200px minimum, og:description recommended)
RESPONSE FORMAT:
Returns clean JSON with a pass/fail status and score (0-100) per platform, a list of issues with severity levels (error or warning), plain-English fix instructions for every issue found, image metadata including dimensions and file size, and an overall summary.
WHO THIS IS FOR:
- Web agencies checking client sites before launch
- CMS platforms that want to validate pages on publish
- Marketing teams monitoring campaign landing pages
- Developers building site audit or SEO tools
- Anyone managing multiple websites who needs automated preview QA
No setup required. Send a URL, get a report. One endpoint, one call.
The API returns a comprehensive JSON report that includes a pass/fail status and score (0-100) for each platform (Facebook, LinkedIn, Twitter, WhatsApp), a list of detected issues with severity levels, plain-English fix instructions, and image metadata such as dimensions and file size.
Key fields in the response include `success`, `url`, `checked_at`, `meta_tags` (containing Open Graph and Twitter Card data), `platform_scores`, `issues` (with severity), and `image_metadata` (dimensions and file size).
The response is structured in a JSON format with a top-level object containing success status, URL checked, timestamp, and nested objects for meta tags, platform scores, issues, and image metadata, making it easy to parse and utilize.
The API provides information on Open Graph and Twitter Card tags, image availability and dimensions, character limits for titles and descriptions, and HTTPS compliance, ensuring that URLs are optimized for social media sharing.
Users can customize requests by sending different URLs to the API endpoint. Each URL will trigger a validation process that checks the specific meta tags and image requirements for the supported social media platforms.
Typical use cases include web agencies validating client sites before launch, CMS platforms checking pages upon publishing, marketing teams monitoring campaign landing pages, and developers integrating social media preview checks into SEO tools.
Data accuracy is maintained through real-time fetching of the provided URL, ensuring that the latest meta tags and images are analyzed. The API checks for broken tags and image availability, providing users with reliable validation results.
Users can utilize the returned data by reviewing the pass/fail scores to identify issues, following the plain-English fix instructions to resolve problems, and ensuring that images meet the required dimensions for optimal social media previews.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund