YoFont — AI font generator
Әзірлеушілерге · REST v1

YoFont API/MCP

Қаріп жасаңыз, таңбаларды алыңыз және жеткізуді бағдарламалық түрде басқарыңыз. Қозғалтқыш қосымшадағымен бірдей, бір bearer токен жеткілікті.

// Аутентификация

Барлық сұраныс bearer токенін мына тақырыпта жібереді: Authorization. Оны сервер жағында сақтаңыз.

Нақты API кілтін жасау үшін кіріңіз — API және MCP қолжетімділігі Pro мен Studio жоспарларына кіреді.

// Жиілік шектеулері

Сұраныстар әр API кілті бойынша шектеледі. Шектен асқанда мынау қайтады: 429 Too Many Requests — мына тақырыппен: Retry-After. Шектеулер жоспарыңызға қарай өседі:

Қаріп жасау · қалғанының бәрі
Pro200 · 2 000 / мин
Studio600 · 6 000 / мин

Өткізу қабілеті көбірек керек пе? Жоспарыңызды жаңартыңыз.

POST/api/public/generate

Мәтіндік сипаттамадан және/немесе үлгі суреттен толық қаріп отбасын жасайды. Аяқталуын тексеріп отыратын тапсырма қайтарады.

promptміндеттіҚаріпті қарапайым сөзбен сипаттау. Optional when reference_image_url is set.
reference_image_urlСтиль үлгісі ретіндегі сурет (PNG/JPG/WEBP) — тікелей ашық сілтеме. Біз оны сақтамаймыз; сілтемені сол күйінде рендер қозғалтқышына жібереміз, Figma/Chrome плагиндеріндегі «скриншоттан қаріп» сияқты.
languagesISO кодтарының массиві — әдепкісі ["en"]. Two-letter ISO codes, full list: GET /api/public/languages.
weightsмысалы: ["normal","bold","thin"].
glyph_typesletters · digits · punct · special (default all).
model_tierstandard (Epicur ×1) · pro (Spinoza ×3) · ultra (Nietzsche ×5).

                
200Қабылданды — қайтарады: { success, link, task_id, glyphs_charged, status_url }
// Response JSON

                
402Таңба бітті — «Жоспарлар» бетінде толтырыңыз
GET/api/public/status?link=…

Қаріптің күйін және жүктеу сілтемелерін алу (TTF / WOFF2 / variable).

// Request

                
// Response JSON

                
GET/api/public/download?link=…

Жиналған қаріп файлын нақты пішімде жүктеу (ttf/otf/woff/woff2) — Студиядағы жүктеу батырмасы беретін файлмен бірдей.

// Request

                
// Response

                
GET/api/public/languages

Қолдау көрсетілетін әр ISO-2 тіл коды, жазу бойынша таңба саны және мәтін бағыты — дұрыс "languages" массивін құру үшін қолданыңыз.

// Request

                
// Response JSON

                
GET/api/public/fonts

Соңғы 100 қаріп тапсырмаңыз — күйі, моделі, көзі және әр қаріптің бетіне сілтеме.

// Request

                
// Response JSON

                
// Күйді тексеру

Жасау асинхронды жүреді. generate-ке POST жібергеннен кейін мынаны тексеріп отырыңыз: GET /api/public/status?link=… — күйі font_ready (немесе failed) болғанша, бірнеше секунд сайын.

statusqueued · processing · atlas_ready · font_ready · failed
progress{ total, completed, failed } — қанша таңба атласы дайын болғаны
fontsttf/otf/woff/woff2 файл сілтемелері, мына кезде пайда болады: status = font_ready. Бұл сілтемелер API кілтіңізді талап етеді — Authorization тақырыбынсыз сұрасаңыз, 403 қайтады. Байттарды мынау арқылы жүктеңіз: GET /api/public/download?link=…&format=….

3–5 секунд сайын бір тексеру жеткілікті — толық отбасы әдетте бірер минутта бітеді. Файлдарды API кілтіңізбен GET /api/public/download арқылы алыңыз; "fonts" ішіндегі сілтемелер жалпыға қолжетімді емес.

// Қателер

Барлық қате бірыңғай JSON пішімінде беріледі: { "success": false, "error": "…" }.

400Қате сұраныс — өрістер жоқ немесе жарамсыз. Мынаны тексеріңіз: error — толығырақ сонда.
401Авторизация жоқ — жоқ немесе жарамсыз Authorization тақырыбы.
402Төлем қажет — таңба квотасы бітті. «Жоспарлар» бетінде толтырыңыз.
403Тыйым салынған — бұл сілтеме басқа аккаунтқа тиесілі.
404Табылмады — мұндай қаріп ID жоқ немесе ол басқа аккаунтқа тиесілі.
429Сұраныс тым көп — жиілік шегіне жеттіңіз. Қайталаңыз: Retry-After.
500Ішкі қате — біздің жақта бірдеңе дұрыс болмады. Бірнеше секундтан кейін қайталау әдетте көмектеседі.
{
  "success": false,
  "error": "Not enough glyphs. Top up: https://yofont.com/plans"
}