Social Preview QA API API ID: 12506

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.
Use this API from your AI agent via MCP
Works with OpenClaw, Claude Code/Desktop, Cursor, Windsurf, Cline and any MCP-compatible AI client.
Docs & setup
Create a skill by wrapping this MCP: https://mcp.zylalabs.com/mcp?apikey=YOUR_ZYLA_API_KEY

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.

API Documentation

Endpoints


Validates how a URL will appear when shared on Facebook, LinkedIn, Twitter, and WhatsApp. Fetches the page, extracts all Open Graph and Twitter Card meta tags, checks image availability and dimensions against each platform's requirements, and returns a structured JSON report with a pass/fail score per platform, a list of issues with severity levels, and plain-English fix instructions for every problem found.



                                                                            
GET https://www.zylalabs.com/api/12506/social+preview+qa+api/23805/check
                                                                            
                                                                        

check - Endpoint Features

Object Description
url [Required] The full URL to validate including https://. Example: https://yoursite.com/blog/my-post
Test Endpoint

API EXAMPLE RESPONSE

       
                                                                                                        
                                                                                                                                                                                                                                                                                                                                        {"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}}
                                                                                                                                                                                                                    
                                                                                                    

Check - CODE SNIPPETS


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' 


    

API Access Key & Authentication

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.
Headers
Header Description
Authorization [Required] Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.

Simple Transparent Pricing

No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.

🚀 Enterprise

Starts at
$ 10,000/Year


  • Custom Volume
  • Custom Rate Limit
  • Specialized Customer Support
  • Real-Time API Monitoring

Customer favorite features

  • ✔︎ Only Pay for Successful Requests
  • ✔︎ Free 7-Day Trial
  • ✔︎ Multi-Language Support
  • ✔︎ One API Key, All APIs.
  • ✔︎ Intuitive Dashboard
  • ✔︎ Comprehensive Error Handling
  • ✔︎ Developer-Friendly Docs
  • ✔︎ Postman Integration
  • ✔︎ Secure HTTPS Connections
  • ✔︎ Reliable Uptime

Social Preview QA API FAQs

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.

General FAQs

To obtain your API key, you first need to sign in to your account and subscribe to the API you want to use. Once subscribed, go to your Profile, open the Subscription section, and select the specific API. Your API key will be available there and can be used 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.

If you don’t cancel before the 7th day, your free trial will end automatically and your subscription will switch to a paid plan under the same plan you originally subscribed to, meaning you will be charged and gain access to the API calls included in that plan.

The free trial ends when you reach 50 API requests or after 7 days, whichever comes first. 

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, we offer a 7-day free trial that allows you to make up to 50 API calls at no cost, so you can test our APIs without any commitment. 

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.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world's most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.
The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.
Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]
Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.
API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.
Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.
To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.
To check how many API calls you have left for the current month, refer to the 'X-Zyla-API-Calls-Monthly-Remaining' field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.
To see the maximum number of API requests your plan allows, check the 'X-Zyla-RateLimit-Limit' response header. For instance, if your plan includes 1,000 requests per month, this header will display 1,000.
The 'X-Zyla-RateLimit-Reset' header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3,600, it means 3,600 seconds are left until the limit resets.
Yes, you can cancel your plan anytime by going to your account and selecting the cancellation option on the Billing page. Please note that upgrades, downgrades, and cancellations take effect immediately. Additionally, upon cancellation, you will no longer have access to the service, even if you have remaining calls left in your quota.
After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it's important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.
When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.
Payout Orders are processed between the 20th and the 30th of each month. If you submit your request before the 20th, your payment will be processed within this timeframe.
You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

Please have a look at our Refund Policy: https://zylalabs.com/terms#refund


Related APIs