GlyphfieldDocs
Documentation/System reference

Identities and custom assets

Choose a built-in brand identity for a generation request, override its name, colors and logo, and embed local images as base64 data URLs.

Maintained with source

Every POST /api/generate request accepts an identity object, the brand that the output uses. It takes one of three forms:

FormExampleUse
Built-in ID{ "id": "gt" }A built-in identity exactly as shipped. Send id alone
Complete identityThe full object from /api/identities or identity.read, with id, colors and typographyA custom or edited identity
Preset with overrides{ "preset": "gt", "name": "…", "ink": "#…" }A preset with a few changed fields

An unknown built-in ID returns unknown_identity. An invalid complete identity, or an id sent with other fields, returns invalid_identity.

Glyphfield Brand identity workspace showing the shared identity and asset system
The Brand identity tool holds more fields than a generation overrideAssets · provenance · type · color

Presets

  • starter is the default: the complete neutral Starter identity, which is original Glyphfield work.
  • basement, gt, ramp, mintlify, tailwind, viteplus, cloudflare and stripe load the reference identities with their bundled logo files.
  • custom starts from Starter's colors and type without its logo. Without logoDataUrl, the output shows a monogram made from shortName.
  • template is still accepted for older requests. It has no built-in record and behaves like custom.

GET /api/identities returns { agentPresetField: "identity.preset", identities, localIdentityPersistence: "browser-localStorage", schemaVersion: 2 }. identities holds the nine built-in BrandIdentity records with their foundations, strategy, graphic system rules, applications, proof references and local asset IDs. Read the list at runtime instead of copying it into a client.

Identity fields

FieldLimit
name80 characters
shortName8 characters
website200 characters
tagline180 characters
positioning320 characters
description320 characters
ink, paperSix-digit HEX colors for text and background
logoDataUrlA base64 image data URL of up to 5,000,000 characters

Text fields must contain at least one character after trimming. A field you send replaces the preset's value, and a field you leave out keeps it. A logo replaces the preset's mark and wordmark in every slot.

Convert a logo to a data URL

On macOS or Linux:

MIME=image/png
LOGO_DATA="data:$MIME;base64,$(base64 < logo.png | tr -d '\n')"

Build the request with jq so that the shell does not alter the data:

jq -n --arg logo "$LOGO_DATA" '{
  kind: "background",
  identity: {
    preset: "custom",
    name: "Acme",
    shortName: "AC",
    website: "acme.test",
    ink: "#111111",
    paper: "#FFFFFF",
    logoDataUrl: $logo
  },
  settings: {
    width: 1200,
    height: 630,
    style: "gradient",
    colorA: "#FFFFFF",
    colorB: "#D9FF63"
  },
  output: "raw"
}' > request.json

Image data URLs must be base64 PNG, JPEG, WebP, GIF or SVG. The API rejects remote URLs. Download an asset you are allowed to use, then convert it.

Background and partner images

template requests also accept backgroundImageDataUrl and partnerLogoDataUrl with the same format and limit. partnerId takes a proof asset ID of the selected identity from /api/identities, another built-in identity ID, or template-northstar.

The API embeds accepted images in the returned SVG, so the file does not depend on other URLs.

Reference sources and trademarks

The reference identities were built from each brand's published sources, captured in July 2026 and reviewed in October 2026:

These identities are included for design study and interoperability. Brand names, marks and source assets belong to their owners. Glyphfield's MIT license covers the software and the original templates. It grants no trademark rights and implies no endorsement.

The General Translation (GT) identity follows GT's own brand canon. Its marks and brand-system artwork are © General Translation, Inc. They are included with permission for that identity and are not covered by the MIT license. This artwork includes the glyph globes, the glyph and horizon fields, the speed marks, the signal gem smoke and the product still.

The GT identity also carries ten artifact pictures. They are GT's dithered screens of public-domain and CC BY-SA 4.0 originals. Each asset record carries its credit (attribution), license and sourceUrl, and Third-party notices lists all ten. Show the credit wherever you publish one of these pictures.

Reference identities also bundle the font files for their Display, Body, Accent and Code roles, so they render in their own typefaces instead of Glyphfield's interface font. Those files keep their original licenses, and Glyphfield's MIT license does not relicense them. public/fonts/brands/README.md lists the role map and the redistribution terms.

On this page