Open Graph and Social Preview Validator API

API ID 12803

Extracts and validates social preview metadata from webpages or raw HTML, including preview titles, descriptions, images, page URLs, content type fields, warnings, errors, and status information.

3,493 ms avg response

API Documentation

Endpoints

Request

Extracts page metadata, social preview tags, duplicate tags, empty tags, warnings, errors, and metadata status from a submitted webpage or HTML.

Endpoint ID: 25188
POST https://docs.zylalabs.com/api/12803/open+graph+and+social+preview+validator+api/25188/extract+metadata
INPUT PARAMETERS

Extract Metadata — Endpoint Features

Object Description
Request Body Required Json

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

API EXAMPLE RESPONSE
JSON
{"ok":true,"metadataFound":{"title":true,"description":false,"canonicalUrl":false,"openGraphTags":0,"twitterTags":0},"title":"Example Domain","description":null,"canonicalUrl":null,"openGraph":{},"twitter":{},"duplicateTags":[],"emptyTags":[],"disclaimer":"Results are technical validation only and do not guarantee SEO ranking, social platform rendering, click-through rate, or platform approval."}
Extract Metadata — CODE SNIPPETS

curl --location --request POST 'https://zylalabs.com/api/12803/open+graph+and+social+preview+validator+api/25188/extract+metadata' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
	"url": "https://example.com"
}'

    
Request

Validates social preview metadata from a submitted webpage or HTML and returns errors, warnings, recommendations, metadata status, and validation details.

Endpoint ID: 25189
POST https://docs.zylalabs.com/api/12803/open+graph+and+social+preview+validator+api/25189/validate+metadata
INPUT PARAMETERS

Validate Metadata — Endpoint Features

Object Description
Request Body Required Json

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

API EXAMPLE RESPONSE
JSON
{"ok":true,"valid":false,"metadataFound":{"title":true,"description":false,"canonicalUrl":false,"openGraphTags":0,"twitterTags":0},"openGraph":{},"twitter":{},"titleLength":14,"descriptionLength":0,"errors":["Missing og:title.","Missing og:description.","Missing og:image."],"warnings":["Missing og:url.","Missing og:type.","Missing twitter:card.","Missing twitter:title.","Missing twitter:description.","Missing twitter:image."],"recommendations":["Add a canonical URL when possible.","Add twitter:card for better X/Twitter preview control."],"disclaimer":"Results are technical validation only and do not guarantee SEO ranking, social platform rendering, click-through rate, or platform approval."}
Validate Metadata — CODE SNIPPETS

curl --location --request POST 'https://zylalabs.com/api/12803/open+graph+and+social+preview+validator+api/25189/validate+metadata' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
	"url": "https://example.com"
}'

    
Request

Extracts and validates social preview metadata from webpages or raw HTML

Endpoint ID: 25190
POST https://docs.zylalabs.com/api/12803/open+graph+and+social+preview+validator+api/25190/build+social+preview
INPUT PARAMETERS

Build Social Preview — Endpoint Features

Object Description
Request Body Required Json

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

API EXAMPLE RESPONSE
JSON
{"ok":true,"preview":{"openGraph":{"title":"Example Domain","description":null,"image":null},"twitter":{"title":"Example Domain","description":null,"image":null,"card":null}},"warnings":["Missing og:url.","Missing og:type.","Missing twitter:card.","Missing twitter:title.","Missing twitter:description.","Missing twitter:image."],"disclaimer":"Results are technical validation only and do not guarantee SEO ranking, social platform rendering, click-through rate, or platform approval."}
Build Social Preview — CODE SNIPPETS

curl --location --request POST 'https://zylalabs.com/api/12803/open+graph+and+social+preview+validator+api/25190/build+social+preview' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
	"url": "https://example.com"
}'

    
Request

Checks social image URL values found in page preview metadata and returns image URL validation output, warnings, errors, and status information.

Endpoint ID: 25191
POST https://docs.zylalabs.com/api/12803/open+graph+and+social+preview+validator+api/25191/check+social+image+urls
INPUT PARAMETERS

Check Social Image URLs — Endpoint Features

Object Description
Request Body Required Json

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

API EXAMPLE RESPONSE
JSON
{"ok":true,"images":{"openGraph":{"url":null,"validUrl":false,"warnings":["No image URL found."],"recommendations":["Add og:image and twitter:image for better social previews."]},"twitter":{"url":null,"validUrl":false,"warnings":["No image URL found."],"recommendations":["Add og:image and twitter:image for better social previews."]}},"disclaimer":"Results are technical validation only and do not guarantee SEO ranking, social platform rendering, click-through rate, or platform approval."}
Check Social Image URLs — CODE SNIPPETS

curl --location --request POST 'https://zylalabs.com/api/12803/open+graph+and+social+preview+validator+api/25191/check+social+image+urls' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
	"url": "https://example.com"
}'

    

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 Open Graph and Social Preview Validator 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.

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

(Save 2 months with annual billing 🎉)

🚀 Enterprise Plan

Starts at
$ 10,000/Year


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

Overview

Open Graph and Social Preview Validator API extracts and validates social preview metadata from webpages or raw HTML.

The API handles page title, meta description, canonical URL, Open Graph tags, og:title, og:description, og:image, og:url, og:type, social card tags, preview title, preview description, preview image, duplicate metadata tags, empty metadata values, missing required preview fields, title length warnings, description length warnings, invalid image URL checks, social image URL checks, validation status, usage status, safety notes, and disclaimer.

The API returns metadata extraction results, page title, meta description, canonical URL, Open Graph tag values, social card tag values, duplicate tags, empty tags, metadata found status, validation status, errors, warnings, recommendations, normalized social preview output, image URL validation output, and technical disclaimer.

This API is useful for SEO teams, developers, SaaS builders, CMS platforms, marketing agencies, technical SEO consultants, content platforms, frontend teams, backend teams, QA teams, ecommerce platforms, publisher sites, news sites, blog platforms, product teams, web audit platforms, site monitoring services, SEO software companies, internal tooling teams, social media teams, content QA teams, landing page builders, no-code website builders, developer platforms, and marketing automation platforms.

The API checks metadata submitted by URL or raw HTML and returns technical extraction and validation results. It does not hack, brute force, attempt logins, scan private systems, scrape restricted content, bypass robots.txt, change customer data, send emails, create calendar events, guarantee ranking outcomes, guarantee social preview rendering, guarantee click-through rate, guarantee platform approval, guarantee preview cache updates, or replace professional SEO review.

The API response includes a data_disclaimer field explaining that the validation is based only on metadata submitted by URL or raw HTML and is provided for technical review purposes. Results should be reviewed before use in SEO, publishing, social media, marketing, compliance, operational, or business decisions.

Open Graph and Social Preview Validator API FAQs

Each endpoint returns metadata extraction and validation results, including page title, meta description, canonical URL, Open Graph tag values, social preview tag values, duplicate and empty tags, errors, warnings, recommendations, and validation status.

Key fields include "ok" (status), "metadataFound" (indicating presence of metadata), "errors" (list of issues), "warnings" (suggestions for improvement), and "recommendations" (best practices for metadata).

The response data is structured in JSON format, with a top-level "ok" field indicating success, followed by nested objects for metadata details, errors, warnings, and recommendations, making it easy to parse and utilize.

Each endpoint provides information on metadata extraction, validation results, social preview construction, and image URL checks, covering aspects like title, description, images, and validation status.

Users can customize requests by submitting specific URLs or raw HTML content to the endpoints. The response is based on the submitted webpage or HTML structure and the metadata fields found during extraction and validation.

"valid" indicates whether the metadata passed the endpoint checks, "titleLength" and "descriptionLength" provide character counts, while "duplicateTags" and "emptyTags" list metadata issues found in the submitted content.

Typical use cases include checking social preview metadata, reviewing missing or empty preview fields, validating preview image URLs, finding duplicate metadata tags, and identifying technical warnings or errors in submitted webpage or HTML content.

Data reflects technical metadata extraction and validation checks on the submitted webpage or raw HTML at the time of the request. Results may vary based on page content, redirects, metadata format, image URLs, and parsing behavior.

General FAQs

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.

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.

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.

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 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.

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.
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