Linkshot API

Generate Open Graph screenshots from any URL — edge-rendered, cached globally, and returned as a PNG.

Quick Start#

You can be generating OG images in under 5 minutes. Here's how:

1

Sign up and register your domain

Create an account, then go to Dashboard → Domains and add your website's hostname (e.g. example.com). Linkshot will only generate screenshots for URLs on domains you register.

2

Create a template

Go to Dashboard → Templates → New template. Configure your viewport size, TailwindCSS injection, and other capture settings. Save it — you'll get a template ID (UUID).

3

Add the API URL to your page's <head>

Place this in your HTML's <head> tag. Replace TEMPLATE_ID with your template's UUID and PAGE_URL with the URL of the current page.

<meta property="og:image"
  content="https://uselinkshot.com/api/og/v1/TEMPLATE_ID?url=PAGE_URL" />
<meta name="twitter:image"
  content="https://uselinkshot.com/api/og/v1/TEMPLATE_ID?url=PAGE_URL" />

No API key required

The OG Screenshot API is public — no authentication header is needed. Authorization is handled automatically through template ownership and domain registration.

How it works#

Edge rendering

Screenshots are taken by a headless browser running on our global edge network, close to your users.

R2 caching

Generated screenshots are cached globally. Subsequent requests return instantly with stale-while-revalidate semantics.

TailwindCSS injection

Enable Tailwind injection in your template and any Tailwind class on your page renders perfectly — no build step needed.

Base URL#

All API endpoints are served from:

https://uselinkshot.com

Plans & Limits#

All plans include a 7-day free trial — no credit card required. Limits apply to the number of domains and templates you can create.

PlanDomainsTemplates
Basic11
Pro33
Max66