API Overview

GitAscii v2 publishes the normal profile README image as static dark and light SVG files on the user’s gitascii branch. The HTTP API remains available for previews, custom embeds, widget selection, and Pro dynamic rules. It is not required to serve the standard README embed.

Endpoint	Method	Result
`/api/:username`	GET	Default profile SVG; supports `?dynamic=1` for Pro rule evaluation.
`/api/:username/:profileSlug`	GET	Named profile SVG.
`/api/svg/:username.svg`	GET	Extension-style SVG route.
`/api/config/:username/:profileSlug`	GET	Stored `SavedConfiguration` JSON.
`/api/generate`	POST	Suggested configuration and normalized GitHub data.
`/api/github/:username`	GET	Normalized GitHub profile data.
`/api/badge/:username?slug=default`	GET	Pro README analytics badge; counts observed badge fetches.

SVG query parameters

Parameter	Use
`theme=dark` or `theme=light`	Select a color variant; defaults to dark.
`template=<preset>`	Use a preset when no saved configuration exists.
`widgets=<id>,<id>`	Render selected widget IDs from the catalog.
`dynamic=1`	Evaluate Pro dynamic rules for the default profile API route.

With no render overrides, the SVG service checks whether the v2 file exists and redirects to its raw.githubusercontent.com URL. Requests with template, widget, preview-date, or resolved dynamic-rule overrides use the rendering engine. Rendered responses carry an ETag and may return 304 Not Modified; cache lifetimes differ for normal, dynamic, and degraded responses. See HTTP Endpoints Reference for examples.

TypeScript engine

The shared engine in src/engine/ renders a SavedConfiguration with normalized GitHub data. Both the app’s initial publisher and the bundled GitHub Action use it, then sanitize and inline allowed external assets before publication. See Rendering and Configuration.

​API Overview

​SVG query parameters

​TypeScript engine

API Overview

SVG query parameters

TypeScript engine