API endpoint OG image template

og1200×630 square1080×1080 portrait1080×1350 story1080×1920 pinterest1000×1500 youtube1280×720

These are real renders from the API with the example values in the table below. Switch the size above: the same template lays itself out for all 6 sizes — send size or sizes with the request.

For API references and developer docs: a card per endpoint that tells people what they are about to open. The method picks its own colour — GET green, POST blue, PUT and PATCH amber, DELETE red — and {id} or :id segments of the path are drawn in your accent colour. Light by default, like most docs.

Fields

Every field is optional. Long text shrinks to fit instead of overflowing; an image field takes a public URL that we fetch on our side.

Render it with one request

Use the slug as template. The response holds the URL of the finished PNG; ?wait=true keeps the connection open until it is ready.

curl -X POST "https://shareglint.com/v1/images?wait=true" \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "template": "api-endpoint",
    "modifications": {
        "method": "POST",
        "path": "/v1/projects/{project_id}/images",
        "description": "Render an image from a template and get back the URL of the finished file.",
        "params": "template, modifications, size, format",
        "product": "Northwind API",
        "version": "v1",
        "site": "docs.northwind.dev",
        "logo": "https://example.com/images/logo-northwind.png"
    }
}'

Or paste a signed URL into og:image

For static sites, Webflow, Shopify and no-code tools: put the fields in the query string and sign it with your signing secret. The first request renders the image, every later one is a redirect to the cached file. How to compute the signature.

<meta property="og:image" content="https://shareglint.com/i/acc_YOUR_ACCOUNT_ID/api-endpoint.png?description=Render%20an%20image%20from%20a%20template%20and%20get%20back%20the%20URL%20of%20the%20finished%20file.&method=POST&params=template%2C%20modifications%2C%20size%2C%20format&path=%2Fv1%2Fprojects%2F%7Bproject_id%7D%2Fimages&product=Northwind%20API&site=docs.northwind.dev&version=v1&s=YOUR_SIGNATURE">

Make it yours

accent and theme change per request. For anything more, copy the template into your account: you get an ordinary HTML template with the same fields that you can edit in the dashboard or through the API. If the slug is free on your account, the copy takes it — your integrations switch to your version without changing a line.

curl -X POST "https://shareglint.com/v1/templates/library/api-endpoint/copy" \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

More OG image templates

Blog post Website page card Job posting Event Podcast episode Changelog / release Documentation page Real estate listing Product card Product on sale Course lesson Recipe Video thumbnail Newsletter issue Quote card Case study / testimonial GitHub repository Feature announcement Profile / author card Comparison (A vs B) Stat highlight New arrival Price drop Flash sale Coupon code Product rating Gift card Menu special Open house Book launch Fundraising goal Speaker card Webinar Community meetup Countdown Event ticket We're hiring (several roles) Welcome new hire Certificate of completion Livestream Music release Podcast quote (audiogram) Creator thumbnail Star review Social post Editorial pull quote Weekly digest Listicle Pros and cons Before / after Metrics grid Bar chart Milestone celebration Product roadmap Code snippet App store listing Launch day Package release Pricing plans

All templates →