API Documentation

Complete guide to the Glyph and Card generation API

Overview

The API provides endpoints for generating SVG and PNG images of glyphs, cards, and decks. All endpoints are versioned under /api/v1/ and return properly formatted image responses with appropriate headers for caching and embedding.

Base URL: /api/v1/
Supported Formats: SVG and PNG (both fully supported)
Cache Policy: 1 year cache with immutable headers

Authentication

No authentication is required. All endpoints are publicly accessible.

API Endpoints

Glyph API

Generate individual glyph SVGs with customizable parameters

GET /api/v1/glyph/svg GET /api/v1/glyph/png

Card API

Generate card SVGs and PNGs with glyph content and formatting

GET /api/v1/card/svg GET /api/v1/card/png

Deck API

Generate deck layouts in SVG and PNG formats with multiple cards

GET /api/v1/deck/svg GET /api/v1/deck/png

Quick Examples

Basic Glyph

GET /api/v1/glyph/svg?duod=0&height=100&color=blue
Basic glyph example

Colored Card

GET /api/v1/card/svg?duod=5&colorized=true
Colored card example

Deck Layout

GET /api/v1/deck/svg?cardType=poker&bleed=true
Deck layout example

Common Parameters

ParameterTypeDescriptionExample
duodstringGlyph identifier0, 5, A
colorstringPrimary colorblue, #FF0000
heightnumberHeight value100
colorizedbooleanEnable colorizationtrue, false

Response Format

SVG Endpoints

All SVG endpoints return:

  • Content-Type: image/svg+xml
  • Cache-Control: public, max-age=31536000, immutable
  • Body: Valid SVG markup

PNG Endpoints

All PNG endpoints return:

  • Content-Type: image/png
  • Cache-Control: public, max-age=31536000, immutable
  • Body: Binary PNG image data

PNG endpoints support additional parameters for resolution and background control.