Skip to content
OG Engine logoOG Engine

API Reference Overview

The OG Engine REST API lets you generate images, validate text layout, and check service health from any HTTP client. All endpoints are served over HTTPS.

Base URL

Section titled “Base URL”
https://og-engine.com

All endpoint paths are relative to this base URL.

Authentication

Section titled “Authentication”

Most endpoints require a Bearer token in the Authorization header:

Terminal window
Authorization: Bearer oge_sk_YOUR_KEY

API keys begin with the prefix oge_sk_. Obtain your key by signing up at og-engine.com — no credit card required for the Free plan.

The /validate and /health endpoints do not require authentication.

Content Type

Section titled “Content Type”

For JSON request bodies, always set:

Content-Type: application/json

When uploading a background image with /render, use:

Content-Type: multipart/form-data

(curl sets this automatically when you use -F.)

Rate Limiting

Section titled “Rate Limiting”

Render quota is metered monthly. Paid plans reset each billing cycle; free plans reset on the 1st of each month. Each successful /render or /render/batch call consumes quota. /validate calls are free and unlimited.

Plan Monthly Renders Batch WebP
Free 500 No No
Starter 10,000 No Yes
Pro 50,000 Yes Yes
Scale 200,000 Yes Yes

Rate limiting headers are present on every authenticated response. See the Errors guide for details.

Endpoints

Section titled “Endpoints”
Method Path Auth Description
POST /render Required Generate a single image
POST /render/from-url Required Fetch a URL, extract OG/meta tags, and render an image
POST /validate Optional Check if text fits a layout (free, unlimited)
POST /render/batch Required Generate multiple images (Pro+)
GET /health Not required Service status and capabilities
POST /auth/register Not required Create a free account and get an API key
GET /usage Required Current quota usage for your API key

Error Format

Section titled “Error Format”

All errors return a JSON body:

{
  "error": "missing_field",
  "message": "The 'format' field is required.",
  "details": { "field": "format" },
  "docs": "https://og-engine.com/api-reference/errors#missing_field"
}

See the Errors Reference for the complete list of error codes.

Versioning

Section titled “Versioning”

The current API is v1. There is no version prefix in the URL — the API version is communicated through breaking-change notices and the changelog. Subscribe to status.og-engine.com for uptime and deprecation notices.

Next Steps

Section titled “Next Steps”