OG image API-referencia

Az OG image API-referencia a FastOG dinamikus Open Graph képeinek generálásához használt végpontot, paramétereket és sablonkatalógust ismerteti. Az API előfizetéshez kötött — aktív Dynamic API csomag szükséges hozzá, de maguk a renderelések nem mértek: nincs havi renderkvóta és nincs túlhasználati számlázás. A HMAC-aláírt URL-ek biztosítják az egyes kérések védelmét. Regisztráljon, válasszon egy Dynamic API csomagot, majd hozza létre API-kulcsát és HMAC-titkát az irányítópulton (dashboard); a fizetett API-renderelések tiszták. A generált OpenAPI-szerződés a paraméterek, hibakódok és sablon-slugok hiteles, géppel olvasható listája.

Alap URL

https://fastog.com/api/v1/og

Hitelesítés

Minden kérés HMAC-SHA256 aláírásos hitelesítést igényel. A nyilvános key és a s aláírás lekérdezési paraméterek (query parameter); a fejléc alapú hitelesítés jelenleg nem támogatott. A részletekért lásd a HMAC dokumentációt.

Végpont

GET `/api/v1/og`

Dinamikus Open Graph képet generál a megadott paraméterek alapján.

Lekérdezési paraméterek

Paraméter	Típus	Kötelező	Leírás
`template`	string	Nem	Sablon neve (alapértelmezett: `default`)
`title`	string	Igen	Fő cím. Kötelező — a cím nélküli borító nem hasznos előnézet.
`subtitle`	string	Nem	Alcím vagy leírás szövege
`key`	string	Igen	Teljes API-kulcs
`s`	string	Igen	HMAC-SHA256 aláírás (64 hex karakter)

Sablonspecifikus paraméterek

Minden sablon elfogadja az alábbi közös paramétereket plusz a saját sablonspecifikus paramétereit (lásd az indextáblázatot). A template lekérdezési paraméter választja ki, melyik elrendezés legyen használva (alapértelmezett: default).

Közös paraméterek (minden sablon)

Paraméter	Típus	Leírás
`title`	string	Fő cím szövege
`subtitle`	string	Kiegészítő szöveg
`tags`	list	Vesszővel elválasztott címkelkék
`theme`	string	`dark` \| `light` \| `glass` \| `solid` \| `midnight` \| `vivid` \| `paper` \| `glass_light` \| `custom`
`gradient_preset`	string	Elnevezett színátmenet-előbeállítás (pl. `indigo`, `ocean`, `sunset`, `cosmic`)
`gradient_direction`	number	Színátmenet szöge fokban (alapértelmezett `135`)
`bg_color`	hex	Egyszínű háttérszín
`pattern`	string	Háttérminta (`grid`, `dots`, `noise`, `none`, …)
`pattern_color`	hex	Minta színe
`pattern_intensity`	number	Minta átlátszósága (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	Kiemelések kiemelőszíne
`auto_text_color`	bool	Szövegszín származtatása a háttérből (alapértelmezett `true`)
`title_color`	hex	Címszín felülírása
`subtitle_color`	hex	Alcímszín felülírása
`brand_name`	string	Márka/logó szövege (alapértelmezett `FastOG`)
`brand_logo`	string	Márkalogó kép URL-je
`layout_mode`	string	`split` \| `centered` \| `banner` (sablonspecifikus változatok érvényesek)

Sablonindex — 67 megjeleníthető slug, 48 kiválasztható. Az alábbi táblázat a leggyakrabban használt megjelenéseket és a sablonra jellemző propjaikat dokumentálja; a teljes, generált lista (címke, kategória, visszavont jelző és minden elfogadott slug) a /openapi.json alatt található a x-template-catalogue között, és minden sablon szerkesztőmezője (kulcs, címke, típus, alapérték, opciók és URL-formátum) a x-template-fields alatt van. A visszavont slugok továbbra is megjeleníthetők, hogy a már forgalomban lévő URL-ek működjenek, de a választók nem kínálják fel őket.

`template`	Sablon	Kategória	További paraméterek
`default`	Default	Márka	—
`blog`	Blog Post	Tartalom	`author`, `date`, `domain`
`ecommerce`	E-commerce	Kereskedelem	`price`, `original_price`, `rating`, `rating_total`, `features`, `badge`, `cta`, `image`, `domain`
`company`	Company	Márka	`domain`, `logo`, `tag`
`launch`	Product Launch	Márka	`kicker`, `version`, `tag`, `cta`, `domain`
`saaslaunch`	SaaS Launch	Márka	`kicker`, `cta`, `domain`
`devtool`	Developer Tool	Fejlesztő	`version`, `badge`, `domain`
`game`	Game	Tartalom	`price`, `rating`, `image`, `domain`
`event`	Event	Közösségi	`location`, `host`, `date`, `domain`
`quote`	Quote	Közösségi	`quote`, `author_name`, `author_title`
`job`	Job Posting	Közösségi	`location`, `department`, `salary`, `job_type`, `domain`
`stats`	Stats	Adat	`metric`, `metric_label`, `delta`
`pricing`	Pricing	Kereskedelem	`price`, `period`, `cta`
`podcast`	Podcast	Média	`episode_number`, `guest_name`, `guest_role`, `duration`
`video`	Video	Média	`duration`, `channel`, `views`
`editorial`	Editorial	Tartalom	`kicker`, `author`, `date`, `domain`
`minimal`	Minimal	Márka	`domain`
`changelog`	Changelog	Fejlesztő	`version`, `tag`
`corporate`	Corporate	Márka	`kicker`, `tag`, `domain`
`hero`	Hero	Márka	`kicker`, `cta`, `status`, `domain`
`imageright`	Image Right	Kereskedelem	`kicker`, `price`, `original_price`, `rating`, `rating_total`, `badge`, `cta`, `image`, `domain`
`specgrid`	Spec Grid	Kereskedelem	`specs` (list of `Label
`logos`	Logo Wall	Márka	`kicker`, `brand_logos`, `domain`
`notice`	Notice	Közösségi	`notice_status`, `notice_icon`, `notice_text`, `date`, `domain`
`testimonial`	Testimonial	Közösségi	`quote`, `author_name`, `author_title`, `company`, `author_avatar`, `rating`, `rating_total`, `quote_style`
`logofocus`	Logo Focus	Tartalom	`kicker`, `domain`
`xheader`	X Header	Közösségi	`size`, `handle`, `followers`, `location`, `website`, `avatar`
`bento`	Bento	Adat	`kicker`, `tiles`, `domain`
`comparison`	Comparison	Kereskedelem	`kicker`, `left_label`, `left_desc`, `left_points`, `right_label`, `right_desc`, `right_points`, `verdict`
`timeline`	Timeline	Tartalom	`kicker`, `milestones`, `domain`
`countdown`	Countdown	Márka	`kicker`, `target_date`, `cta`, `domain`
`news`	News	Tartalom	`headline`, `byline`, `author`, `date`, `source`, `image`
`code`	Code	Fejlesztő	`code`, `language`, `terminal_title`, `author`, `domain`
`testimonialpro`	Testimonial Pro	Közösségi	`quote`, `author_name`, `author_title`, `company`, `author_avatar`, `rating`, `rating_total`, `cta`
`product`	Product	Kereskedelem	`badge`, `title`, `price`, `original_price`, `rating`, `rating_total`, `features`, `cta`, `image`, `layout_mode`
`promo`	Promo	Márka	`brand_name`, `benefits`, `title`, `subtitle`, `domain`, `layout_mode`
`devblog`	Dev Blog	Tartalom	`category`, `title`, `subtitle`, `tags`, `author`, `author_title`, `date`, `read_time`, `views`, `likes`, `comments`, `code`, `language`, `file_path`
`codepost`	Code Post	Tartalom	`category`, `date`, `title`, `subtitle`, `author`, `read_time`, `code`, `file_path`, `language`
`statsbar`	Stats Bar	Adat	`kicker`, `metric`, `metric_label`, `delta`, `stats`, `domain`
`changelogpro`	Changelog Pro	Fejlesztő	`version`, `tag`, `title`, `changes`, `features`, `domain`
`quotecta`	Quote CTA	Közösségi	`quote`, `author_name`, `author_title`, `company`, `cta`, `domain`
`appscreenshot`	App Screenshot	Média	`badge`, `title`, `subtitle`, `app_name`, `rating`, `screenshot`, `domain`
`realestate`	Real Estate	Kereskedelem	`title`, `subtitle`, `price`, `beds`, `baths`, `sqft`, `cta_text`, `status`, `image_url`, `domain`
`autorental`	Auto Rental	Kereskedelem	`title`, `subtitle`, `rate_badge`, `cta_text`, `fleet_tag`, `image_url`, `domain`
`restaurant`	Restaurant	Kereskedelem	`kicker`, `title`, `subtitle`, `price`, `cta_text`, `badge`, `image_url`, `domain`
`hospitality`	Hospitality	Média	`kicker`, `title`, `subtitle`, `rate`, `cta_text`, `image_url`, `domain`
`saasspend`	SaaS Spend	Márka	`status_pill`, `title`, `subtitle`, `cta_text`, `stat_callout`, `dashboard_image`, `domain`
`brutalist`	Brutalist	Márka	`agency_tag`, `title`, `subtitle`, `cta_text`, `footer_note`, `domain`
`training`	Training	Közösségi	`track`, `dates`, `title`, `subtitle`, `cta_text`, `location`, `image_url`, `domain`
`ecosystem`	Ecosystem	Fejlesztő	`kicker`, `title`, `subtitle`, `apps_list`, `dock_label`, `domain`

A glassproduct a cta értéket is elfogadja. A ecommerce, product, glassproduct és imageright sablonok alapértelmezés szerint a „Shop now” feliratot jelenítik meg; állítsa a cta értékét üresre a vizualis pirula elrejtéséhez.

Strukturált paramétertípusok

Típus	Formátum	Példa
`list`	Vesszővel elválasztott értékek	`features=Fast,Cheap,Secure`
`tiles`	Soronként elválasztott `label\|value` párok	`tiles=Requests\|12.4M\nUptime\|99.99%`
`milestones`	Soronként elválasztott `date\|title\|description`	`milestones=Q3 2026\|Alpha\|Invite-only`
`changes`	Soronként elválasztott `type\|text` (`added`,`fixed`,`improved`,`removed`)	`changes=added\|Bento templates`

Válasz

200 OK — PNG képadatokat ad vissza
401 Unauthorized — Érvénytelen vagy hiányzó hitelesítés
422 Unprocessable — Érvénytelen sablonparaméterek

Hibaválaszok

Hibakód	HTTP állapot	Leírás
`missing_signature`	401	Hiányzó `key` vagy `s` paraméter
`invalid_signature`	401	Az aláírás ellenőrzése sikertelen

Példakérés

GET /api/v1/og?template=blog&title=Hello%20World&subtitle=A%20test%20post&key=sk_quick_123abc&s=a1b2c3...

Példa cURL

bash

curl "https://fastog.com/api/v1/og?template=blog&title=Hello%20World&key=sk_quick_123abc&s=<signature>"

Árazás és korlátok

A FastOG előfizetéshez kötött: aktív Dynamic API csomag szükséges hozzá. A renderelések nincsenek mérve — nincs havi renderkvóta és nincs túllépési számlázás. A csomag jelenti a kaput, és minden szint számláló nélkül renderel. Az aktuális szintekért és árakért lásd az Árazás oldalt.

A gyorsítótárazott képek ingyenesek: a Cloudflare edge gyorsítótárból kiszolgált kérések (azonos sablon + paraméterek, függetlenül a s aláírástól egy korábban gyorsítótárazott URL-en) soha nem érik el az origót, így egy azonos URL nem használ el újabb renderelést.

Alapértelmezésben tiszta: minden renderelés tiszta — nincs vízjel egyetlen csomagban sem, és nincs a ingyenes OG Image Testerben, a Studio előnézeteiben vagy a Studio exportjaiban sem. A fastog_watermark render prop továbbra is támogatott azoknak a hívóknak, akik kifejezetten „Made with FastOG” jelvényt kérnek, de semmi nem állítja be automatikusan.

Dokumentáció — A FastOG összes útmutatója és referenciája
Ingyenes OG-kép tesztelő — Előnézet fiók nélkül
Gyors kezdési útmutató — tartalmazza az architektúra folyamatát (aláírás rendereléskor)
HMAC-aláírás útmutató
HMAC-validáció
JavaScript oktatóanyag