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

# Generate Image



## OpenAPI

````yaml GET /
openapi: 3.1.0
info:
  title: 'ogis: Open Graph Images as a Service'
  description: Generate Open Graph images dynamically via URL parameters
  license:
    name: ''
  version: 0.1.0
servers:
  - url: https://img.ogis.dev
security: []
tags:
  - name: image
    description: Image generation endpoints
  - name: monitoring
    description: Service monitoring and health checks
paths:
  /:
    get:
      tags:
        - image
      operationId: generate
      parameters:
        - name: title
          in: query
          description: Title text for the image
          required: false
          schema:
            type: string
        - name: description
          in: query
          description: Description text for the image
          required: false
          schema:
            type: string
        - name: subtitle
          in: query
          description: Subtitle text (above title)
          required: false
          schema:
            type: string
        - name: logo
          in: query
          description: Optional logo image URL
          required: false
          schema:
            type: string
        - name: image
          in: query
          description: Optional custom image URL
          required: false
          schema:
            type: string
        - name: template
          in: query
          description: Template name (e.g., "twilight", "daybreak")
          required: false
          schema:
            type: string
        - name: signature
          in: query
          description: HMAC signature (required when authentication is enabled)
          required: false
          schema:
            type: string
        - name: format
          in: query
          description: 'Output format: png (default), webp, jpeg'
          required: false
          schema:
            type: string
        - name: scale
          in: query
          description: 'Scale factor for output resolution (0.1-max_scale, default: 1.0)'
          required: false
          schema:
            type: number
            format: float
        - name: quality
          in: query
          description: 'Quality for lossy formats (1-100, default: 90, ignored for PNG)'
          required: false
          schema:
            type: integer
            format: int32
            minimum: 0
        - name: extra
          in: query
          description: Additional parameters (used for color customization)
          required: true
          schema:
            type: object
            additionalProperties:
              type: string
            propertyNames:
              type: string
      responses:
        '200':
          description: Successfully generated PNG image (1200x630)
          content:
            image/png: {}
        '400':
          description: Invalid input - field exceeds maximum length or invalid hex color
        '401':
          description: Authentication required - missing signature
        '403':
          description: Forbidden - invalid signature or SSRF blocked
        '404':
          description: Template not found
        '422':
          description: >-
            Unprocessable - invalid image URL, unsupported format, or image too
            large
        '500':
          description: Internal server error
        '502':
          description: Bad gateway - upstream image fetch failed
        '503':
          description: Service unavailable - server overloaded
        '504':
          description: Gateway timeout - image fetch timed out

````