Open Graph (OG) Image Generator Service

/

Endpoint: GET /generate

Query Parameters:

• url (required): The full URL to screenshot (e.g., https://example.com). Must be URL encoded.
• ttl (optional): Cache Time-To-Live in hours. Defaults to 24 hours.
• width (optional): Screenshot width in pixels. Defaults to 1200.
• height (optional): Screenshot height in pixels. Defaults to 630.
• force_refresh (optional): Set to true to ignore cache and regenerate. Defaults to false.

Response:

• If cached/ready: Returns a 202 Accepted* with JSON:
  { "status": "cached", "image_url": "..." }
• If starting generation: Returns a 202 Accepted with JSON:
  { "status": "processing", "task_id": "...", "check_status_url": "..." }

*Note: Due to limitations, cached responses might also return 202; check the "status" field.

Example:

/generate?url=

Try it (Enter URL)

Endpoint: GET /status/{task_id}

Check the status of a generation task using the task_id returned by /generate.

Response:
{ "status": "pending|processing|completed|failed", "image_url": "..." | null, "error_message": "..." | null }