Skip to main content
The ogis API is a simple HTTP endpoint that generates Open Graph images from query parameters.

Base URL

Generate Image

GET /

Generate an Open Graph image

Query Parameters

Response

Returns a PNG image with dimensions 1200x630 pixels.
  • Content-Type: image/png
  • Status: 200 OK

Example Request

Example with SDK

OpenAPI Specification

The full OpenAPI specification is available at:

Health Check

GET /health

Check service health

Response

  • Status: 200 OK — Service is healthy
  • Status: 503 Service Unavailable — Service is not ready

Error Responses

Rate Limiting

The public hosted service at img.ogis.dev has rate limiting enabled. For high-volume usage, consider self-hosting.