OG-bilde-API-referanse
OG-bilde-API-referansen dekker endepunktet, parameterne og mal-katalogen for å generere dynamiske Open Graph-bilder med FastOG. API-et er abonnementsbasert — en aktiv Dynamic API-plan kreves, men selve renderingene måles ikke: det finnes ingen månedlig render-kvote og ingen fakturering for overforbruk. HMAC-signerte URL-er holder hver forespørsel sikker. Registrer deg, velg en Dynamic API-plan, og opprett deretter API-nøkkelen og HMAC-hemmeligheten din i dashbordet; betalte API-renderinger er rene. Den genererte OpenAPI-kontrakten er den autoritative maskinlesbare listen over parametere, feilkoder og mal-slugs.
Base-URL
https://fastog.com/api/v1/og
Autentisering
Alle forespørsler krever HMAC-SHA256-signaturautentisering. Den offentlige key og signaturen s er query-parametere; header-basert autentisering støttes ikke for øyeblikket. Se HMAC-dokumentasjonen for detaljer.
Endpoint
GET /api/v1/og
Genererer et dynamisk Open Graph-bilde basert på de angitte parameterne.
Query-parametere
| Parameter | Type | Påkrevd | Beskrivelse |
|---|---|---|---|
template |
string | Nei | Malnavn (standard: default) |
title |
string | Ja | Hovedoverskrift. Påkrevd — en forside uten tittel er ikke en nyttig forhåndsvisning. |
subtitle |
string | Nei | Undertittel eller beskrivelsestekst |
key |
string | Ja | Fullstendig API-nøkkel |
s |
string | Ja | HMAC-SHA256-signatur (64 hex-tegn) |
Mal-spesifikke parametere
Hver mal godtar de felles parameterne nedenfor pluss sine mal-spesifikke parametere (se indekstabellen). Query-parameteren template velger hvilket oppsett som brukes (standard: default).
Felles parametere (alle maler)
| Parameter | Type | Beskrivelse |
|---|---|---|
title |
string | Hovedoverskriftstekst |
subtitle |
string | Støttetekst |
tags |
list | Kommaseparerte tag-etiketter |
theme |
string | dark | light | glass | solid | midnight | vivid | paper | glass_light | custom |
gradient_preset |
string | Navngitt gradient-forhåndsinnstilling (f.eks. indigo, ocean, sunset, cosmic) |
gradient_direction |
number | Gradientvinkel i grader (standard 135) |
bg_color |
hex | Ensartet bakgrunnsfarge |
pattern |
string | Bakgrunnsmønster (grid, dots, noise, none, …) |
pattern_color |
hex | Mønsterfarge |
pattern_intensity |
number | Mønsteropasitet (1–30) |
font_family |
string | font-sans, font-jakarta, font-dm, font-outfit, font-space, font-playfair, font-merriweather, font-instrument, font-jetbrains, font-fira |
accent_color |
hex | Aksentfarge for uthevinger |
auto_text_color |
bool | Utled tekstfarge fra bakgrunnen (standard true) |
title_color |
hex | Overstyr tittelfarge |
subtitle_color |
hex | Overstyr undertittelfarge |
brand_name |
string | Merkevare-/logotekst (standard FastOG) |
brand_logo |
string | URL til merkevarelogo |
layout_mode |
string | split | centered | banner (mal-spesifikke varianter gjelder) |
Malindeks — 67 gjengivbare slugs, 48 valgbare. Tabellen nedenfor dokumenterer de mest brukte utseendene og deres malspesifikke props; den fullstendige, genererte listen (etikett, kategori, utrangert-flagg og alle godkjente slugs) finnes i /openapi.json under x-template-catalogue, og hver mals editorfelt (nøkkel, etikett, type, standardverdi, alternativer og URL-format) finnes under x-template-fields. Utrangerte slugs forblir gjengivbare slik at URL-er som allerede er i bruk fortsatt fungerer, men de tilbys ikke i velgerne.
template |
Mal | Kategori | Ekstra parametere |
|---|---|---|---|
default |
Standard | Merkevare | — |
blog |
Blogginnlegg | Innhold | author, date, domain |
ecommerce |
Netthandel | Handel | price, original_price, rating, rating_total, features, badge, cta, image, domain |
company |
Bedrift | Merkevare | domain, logo, tag |
launch |
Produktlansering | Merkevare | kicker, version, tag, cta, domain |
saaslaunch |
SaaS-lansering | Merkevare | kicker, cta, domain |
devtool |
Utviklerverktøy | Utvikler | version, badge, domain |
game |
Spill | Innhold | price, rating, image, domain |
event |
Arrangement | Sosialt | location, host, date, domain |
quote |
Sitat | Sosialt | quote, author_name, author_title |
job |
Stillingsannonse | Sosialt | location, department, salary, job_type, domain |
stats |
Statistikk | Data | metric, metric_label, delta |
pricing |
Priser | Handel | price, period, cta |
podcast |
Podkast | Media | episode_number, guest_name, guest_role, duration |
video |
Video | Media | duration, channel, views |
editorial |
Redaksjonell | Innhold | kicker, author, date, domain |
minimal |
Minimal | Merkevare | domain |
changelog |
Endringslogg | Utvikler | version, tag |
corporate |
Bedriftsprofil | Merkevare | kicker, tag, domain |
hero |
Hero | Merkevare | kicker, cta, status, domain |
imageright |
Bilde til høyre | Handel | kicker, price, original_price, rating, rating_total, badge, cta, image, domain |
specgrid |
Spesifikasjonsrutenett | Handel | specs (liste med `Label |
logos |
Logovegg | Merkevare | kicker, brand_logos, domain |
notice |
Varsel | Sosialt | notice_status, notice_icon, notice_text, date, domain |
testimonial |
Attest | Sosialt | quote, author_name, author_title, company, author_avatar, rating, rating_total, quote_style |
logofocus |
Logofokus | Innhold | kicker, domain |
xheader |
X-header | Sosialt | size, handle, followers, location, website, avatar |
bento |
Bento | Data | kicker, tiles, domain |
comparison |
Sammenligning | Handel | kicker, left_label, left_desc, left_points, right_label, right_desc, right_points, verdict |
timeline |
Tidslinje | Innhold | kicker, milestones, domain |
countdown |
Nedtelling | Merkevare | kicker, target_date, cta, domain |
news |
Nyheter | Innhold | headline, byline, author, date, source, image |
code |
Kode | Utvikler | code, language, terminal_title, author, domain |
testimonialpro |
Attest Pro | Sosialt | quote, author_name, author_title, company, author_avatar, rating, rating_total, cta |
product |
Produkt | Handel | badge, title, price, original_price, rating, rating_total, features, cta, image, layout_mode |
promo |
Kampanje | Merkevare | brand_name, benefits, title, subtitle, domain, layout_mode |
devblog |
Utviklerblogg | Innhold | category, title, subtitle, tags, author, author_title, date, read_time, views, likes, comments, code, language, file_path |
codepost |
Kodeinnlegg | Innhold | category, date, title, subtitle, author, read_time, code, file_path, language |
statsbar |
Statistikklinje | Data | kicker, metric, metric_label, delta, stats, domain |
changelogpro |
Endringslogg Pro | Utvikler | version, tag, title, changes, features, domain |
quotecta |
Sitat-CTA | Sosialt | quote, author_name, author_title, company, cta, domain |
appscreenshot |
App-skjermbilde | Media | badge, title, subtitle, app_name, rating, screenshot, domain |
realestate |
Eiendom | Handel | title, subtitle, price, beds, baths, sqft, cta_text, status, image_url, domain |
autorental |
Bilutleie | Handel | title, subtitle, rate_badge, cta_text, fleet_tag, image_url, domain |
restaurant |
Restaurant | Handel | kicker, title, subtitle, price, cta_text, badge, image_url, domain |
hospitality |
Reiseliv | Media | kicker, title, subtitle, rate, cta_text, image_url, domain |
saasspend |
SaaS-forbruk | Merkevare | status_pill, title, subtitle, cta_text, stat_callout, dashboard_image, domain |
brutalist |
Brutalistisk | Merkevare | agency_tag, title, subtitle, cta_text, footer_note, domain |
training |
Opplæring | Sosialt | track, dates, title, subtitle, cta_text, location, image_url, domain |
ecosystem |
Økosystem | Utvikler | kicker, title, subtitle, apps_list, dock_label, domain |
glassproduct godtar også cta. Malene ecommerce, product, glassproduct og imageright
viser «Shop now» som standard; sett cta til en tom verdi for å skjule den visuelle pillen.
Strukturerte parametertyper
| Type | Format | Eksempel |
|---|---|---|
list |
Kommaseparerte verdier | features=Fast,Cheap,Secure |
tiles |
Linjeseparerte label|value-par |
tiles=Requests|12.4M\nUptime|99.99% |
milestones |
Linjeseparerte date|title|description |
milestones=Q3 2026|Alpha|Invite-only |
changes |
Linjeseparerte type|text (added,fixed,improved,removed) |
changes=added|Bento templates |
Respons
- 200 OK — Returnerer PNG-bildedata
- 401 Unauthorized — Ugyldig eller manglende autentisering
- 422 Unprocessable — Ugyldige malparametere
Feilresponser
| Feilkode | HTTP-status | Beskrivelse |
|---|---|---|
missing_signature |
401 | Mangler parameteren key eller s |
invalid_signature |
401 | Signaturverifisering feilet |
Eksempel på forespørsel
GET /api/v1/og?template=blog&title=Hello%20World&subtitle=A%20test%20post&key=sk_quick_123abc&s=a1b2c3...
Eksempel med cURL
curl "https://fastog.com/api/v1/og?template=blog&title=Hello%20World&key=sk_quick_123abc&s=<signature>"
Priser og grenser
FastOG er abonnementsstyrt: en aktiv Dynamic API-plan kreves. Renderinger er ikke målt — det finnes ingen månedlig renderkvote og ingen fakturering for overforbruk. Planen er adgangskontrollen, og hvert nivå renderer uten en teller. Se Priser for gjeldende nivåer og priser.
Bufrede bilder er gratis: forespørsler som serveres fra Cloudflare edge-cache (samme mal + parametere,
uavhengig av s-signaturen på en tidligere bufret URL) når aldri origin, så en identisk
URL bruker ikke en ny rendering.
Rent som standard: hver rendering er ren — ingen vannmerke på noen plan, og ingen på den gratis OG
Image Tester, Studio-forhåndsvisninger eller Studio-eksporter. En fastog_watermark render-prop støttes
fortsatt for kallere som eksplisitt ber om et «Made with FastOG»-merke, men ingenting setter det
automatisk.
Relatert
- Dokumentasjon — Alle FastOG-guider og -referanser
- Gratis OG-bilde-tester — Forhåndsvis uten en konto
- Hurtigstartguide — inkluderer arkitekturflyten (signer ved rendering)
- Guide for HMAC-signatur
- HMAC-validering
- JavaScript-veiledning