Skip to content
OG Engine logoOG Engine

GET /health

Returns the current service status along with lists of all available fonts, formats, and templates. Useful for validating your integration and discovering available options programmatically.

GET https://og-engine.com/health

Authentication: Not required Rate limiting: Not applied

Example Request

Section titled “Example Request”
Terminal window
curl https://og-engine.com/health

Response

Section titled “Response”
{
  "status": "ok",
  "version": "0.1.0",
  "fonts": [
    "Outfit",
    "Inter",
    "Playfair Display",
    "Sora",
    "Space Grotesk",
    "JetBrains Mono",
    "Noto Sans JP",
    "Noto Sans AR"
  ],
  "formats": [
    "og",
    "twitter",
    "square",
    "linkedin",
    "story"
  ],
  "templates": [
    "default",
    "social-card",
    "blog-hero",
    "email-banner",
    "product-card",
    "event",
    "testimonial",
    "github-repo",
    "news-article",
    "pricing",
    "profile-card",
    "announcement"
  ]
}

Response Fields

Section titled “Response Fields”
Field Type Description
status string "ok" when the service is healthy
version string Current API version
fonts string[] All available font family names (use these exact strings in style.font)
formats string[] All available format presets (use these in format)
templates string[] All available template names (use these in template)

Status Values

Section titled “Status Values”
Status Meaning
"ok" All systems operational
"degraded" Service is operational but some functions may be slower than usual
"maintenance" Planned maintenance in progress; renders may be temporarily unavailable

In normal operation you will always see "ok". Subscribe to status.og-engine.com for real-time uptime notifications.

Using /health for Font Validation

Section titled “Using /health for Font Validation”

The fonts array in the response is the authoritative list of valid values for style.font. You can fetch it at startup to populate a font selector in your UI:

const { fonts } = await fetch('https://og-engine.com/health').then(r => r.json())
// ['Outfit', 'Inter', 'Playfair Display', ...]

Next Steps

Section titled “Next Steps”