Skip to main content

​
HTTP Endpoints Reference

The standard v2 README embed points to https://raw.githubusercontent.com/:username/:username/gitascii/profiles/:slug/{dark,light}.svg. These GitAscii HTTP routes are for previews and custom integrations.

​
Profile SVG routes

username is the GitHub handle. profileSlug selects a named saved profile; the default is default. The routes accept: Without rendering overrides, a published v2 SVG can produce a 302 redirect to the raw GitHub file. Otherwise the route renders an SVG, with 200 or 304 for a matching ETag. Render errors return an SVG error response with 404 or 500. Cache headers depend on whether the response was redirected, rendered, dynamic, or degraded; do not assume a single TTL.

​
Configuration and generation

The configuration route returns the saved SavedConfiguration or 404. The GitHub route returns normalized profile data. The generation route returns a suggested configuration and data for the supplied username.

​
Pro badge

Badge styles are classic, compact, outline, and transparent. This is a separate image request from the GitHub-hosted profile SVG. Its analytics represent badge fetches observed by GitAscii, usually GitHub Camo refreshes, not individual profile visitors. Publication health is reported separately by the GitHub Action.