YoFont — AI font generator
Ontwikkelaars · REST v1

YoFont API/MCP

Skep lettertipes, haal gliewe en bestuur aflewering programmaties. Dieselfde enjin as die toepassing, net een bearer-token daarvandaan.

// Verifikasie

Alle versoeke gebruik 'n bearer-token in die Authorization-kopstuk. Hou dit aan die bedienerkant.

Meld aan om 'n lewende API-sleutel te skep — API- en MCP-toegang is by die Pro- en Studio-pakkette ingesluit.

// Tempolimiete

Versoeke word per API-sleutel beperk. As jy die limiet oorskry, kry jy 429 Too Many Requests met 'n Retry-After. Die limiete skaal saam met jou pakket:

Skep lettertipe · al die res
Pro200 · 2 000 / min
Studio600 · 6 000 / min

Meer deurset nodig? Gradeer jou pakket op.

POST/api/public/generate

Skep 'n volledige letterfamilie uit 'n teksbeskrywing en/of 'n verwysingsprent. Dit gee 'n taak terug wat jy peil totdat dit klaar is.

promptverpligtendBeskrywing van die lettertipe in gewone taal. Optional when reference_image_url is set.
reference_image_urlStylverwysingsprent (PNG/JPG/WEBP) — 'n direkte openbare URL. Ons stoor dit nooit nie; ons stuur die skakel net so aan na die tekenenjin, net soos die Figma-/Chrome-inproppe se skermskoot-na-lettertipe.
languagesSkikking van ISO-kodes — verstek is ["en"]. Two-letter ISO codes, full list: GET /api/public/languages.
weightsbv. ["normal","bold","thin"].
glyph_typesletters · digits · punct · special (default all).
model_tierstandard (Epicur ×1) · pro (Spinoza ×3) · ultra (Nietzsche ×5).

                
200Aanvaar — gee { success, link, task_id, glyphs_charged, status_url }
// Response JSON

                
402Gliewe op — vul aan op die Pakkette-bladsy
GET/api/public/status?link=…

Haal 'n lettertipe se status en aflaai-URL's (TTF / WOFF2 / variabel).

// Request

                
// Response JSON

                
GET/api/public/download?link=…

Laai die gebou lettertipelêer in 'n spesifieke formaat af (ttf/otf/woff/woff2) — dieselfde lêer wat die Ateljee se aflaaiknoppie lewer.

// Request

                
// Response

                
GET/api/public/languages

Elke ondersteunde ISO-2-taalkode, met glieftellings per skrifstelsel en teksrigting — gebruik dit om 'n geldige "languages"-skikking te bou.

// Request

                
// Response JSON

                
GET/api/public/fonts

Jou laaste 100 lettertipetake — status, model, bron en 'n skakel na elke lettertipe se bladsy.

// Request

                
// Response JSON

                
// Peiling

Generering is asinkronies. Nadat jy na generate ge-POST het, peil GET /api/public/status?link=… elke paar sekondes totdat die status font_ready (of failed) is.

statusqueued · processing · atlas_ready · font_ready · failed
progress{ total, completed, failed } — hoeveel gliefatlasse klaar is
fontsttf-/otf-/woff-/woff2-lêer-URL's, teenwoordig sodra status = font_ready. Hierdie URL's vereis jou API-sleutel — as jy hulle sonder die Authorization-kopstuk haal, kry jy 403. Laai die grepe af deur GET /api/public/download?link=…&format=….

Een peiling elke 3–5 sekondes is genoeg — 'n volledige familie is gewoonlik binne 'n paar minute klaar. Haal die lêers deur GET /api/public/download met jou API-sleutel; die URL's in "fonts" is nie openbaar toeganklik nie.

// Foute

Alle foute volg 'n konsekwente JSON-vorm: { "success": false, "error": "…" }.

400Slegte versoek — ontbrekende of ongeldige velde. Kyk na die error vir besonderhede.
401Nie gemagtig nie — ontbrekende of ongeldige Authorization kopstuk.
402Betaling benodig — die gliefkwota is op. Vul aan op die Pakkette-bladsy.
403Verbode — die skakel behoort aan 'n ander rekening.
404Nie gevind nie — die lettertipe-ID bestaan nie of behoort aan 'n ander rekening.
429Te veel versoeke — die tempolimiet is bereik. Probeer weer ná Retry-After.
500Interne fout — iets het aan ons kant verkeerd geloop. 'n Herprobeer ná 'n paar sekondes werk gewoonlik.
{
  "success": false,
  "error": "Not enough glyphs. Top up: https://yofont.com/plans"
}