Skip to main content
Version: 0.0.7

Font API Reference

kittl.font — upload custom fonts. This API has been available since SDK 0.0.1.

For font family and style management, see the Data API. That API was added in SDK 0.0.5.

createFont(params)​

Uploads one or more font files as a font family.

PropertyTypeRequiredDescription
namestringYesName for the font family
filesBlob[]YesArray of font file blobs (one per style)
stylesstring[]YesStyle name for each file (e.g. ['Regular', 'Bold', 'Italic']) — must match files in order and length
previewImageBlobNoPreview image blob for the font family

Returns SdkResultAsync<UploadedFontFamily, Error>:

PropertyTypeDescription
idstringUnique font family ID
namestringFont family name
fontsUploadedFontStyle[]Array of uploaded styles (each has id, name, style, objectName)
previewstring?Preview image URL (if provided)
workspaceIdstring?Workspace associated with the font
extension{ id: string; name?: string }?Extension associated with the font