> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plazen.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Open Graph image

> Overview and conventions for the Plazen API

### Generate OG image

```endpoint theme={null}
method: GET
path: /api/og
summary: Generate OG image for documentation or release notes
queryParams:
  - name: type
    required: true
    description: "release-note | (any other value → documentation)"
  - name: id
    required: true
    description: Entry ID
  - name: theme
    required: false
    description: light | dark (default dark)
```

**Output:** 1200x630 image.\
**Behavior:** Fetches `/api/release-notes/:id` when `type=release-note`, otherwise `/api/documentation/:id`.\
**Errors:** `400 "Missing type or id"`, `404 "Not found"`.