Generate Link Preview API
Link preview API: send a URL, get the title, description, images, favicon and site name for preview cards, with malicious-URL checks. Free tier, no card. The…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Link preview API: send a URL, get the title, description, images, favicon and site name for preview cards, with malicious-URL checks. Free tier, no card.
The Link Preview API fetches a URL and returns the metadata you need to build a rich preview card. Send a url in a POST body and get back JSON with title, description, siteName, images, videos, favicons, mediaType, and contentType, read from the page's Open Graph and Twitter Card tags.
secure_mode is on by default and checks the URL against a malicious-URL database before fetching. Clean URLs return the preview with reported_malicious: false, and flagged URLs return the detected threat instead of metadata. Set images_property_type to og or twitter to choose which tags supply the image, and pass user_agent, accept_language, or allow_redirects to control how the page is fetched. URLs without a protocol get http:// added automatically.
Authenticate every request with your ApyHub token in the apy-token header. Documentation: https://apyhub.com/utility/link-preview
Endpoints 1
- POSTGenerate a link preview
/apyhub/generate-link-previewGenerate a preview for a URL by sending the required url field in the JSON body.
API details
- Base URL
https://api.eu.apyhub.com- Authentication
- An API key in the apy-token header
- Operations
- 1 operation on 1 pathPOST 1
- Response formats
application/json- Description format
- OpenAPI 3.0.3, API version
1.0.0 - Links
- Documentation · OpenAPI document
How to test the Generate Link Preview API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Generate Link Preview API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the apy-token header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Generate a link preview” (POST /apyhub/generate-link-preview), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Generate Link Preview API?
Link preview API: send a URL, get the title, description, images, favicon and site name for preview cards, with malicious-URL checks. Free tier, no card. The… It is listed under Data & analytics and has 1 endpoint.
Who publishes the Generate Link Preview API?
It is listed from ApyHub's public API description (an OpenAPI document), not published by ApyHub on Swastik Codes. Anyone who controls apyhub.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Generate Link Preview API?
Requests go to https://api.eu.apyhub.com. Endpoint paths are added to this base URL.
How do I authenticate with the Generate Link Preview API?
With an API key in the apy-token header.
How many endpoints does the Generate Link Preview API have?
1 operation on 1 path (1 POST).
Is forking the Generate Link Preview API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.