מפתחים · REST v1

YoFont API/MCP

צור גופנים, שלוף גליפים ונהל הפצה — הכול דרך קוד. אותו מנוע שמפעיל את האפליקציה, וכל מה שצריך זה bearer token אחד.

// אימות

כל הבקשות משתמשות ב-bearer token בכותרת Authorization. יש לשמור אותו בצד השרת.

התחבר כדי ליצור מפתח API פעיל — זה חינם, גישה ל-API כלולה בכל תוכנית.

// מגבלות קצב

הבקשות מוגבלות לכל מפתח API. חריגה מהמגבלה מחזירה 429 Too Many Requests עם Retry-After. המגבלות גדלות לפי התוכנית שלך:

צור גופן · כל השאר
Starter60 · 600 / דקה
Pro200 · 2 000 / דקה
Agency600 · 6 000 / דקה

צריך יותר תפוקה? שדרג את התוכנית שלך.

POST/api/public/generate

צור משפחת גופנים שלמה מתוך תיאור טקסט. מחזיר משימה שאפשר לבדוק את התקדמותה, או לקבל עדכון דרך webhook.

promptנדרשתיאור הגופן בשפה פשוטה. Optional when reference_image_url is set.
reference_image_urlתמונת רפרנס לסגנון (PNG/JPG/WEBP) — כתובת URL ציבורית וישירה. אנחנו לא שומרים אותה; אנחנו מעבירים את הקישור כפי שהוא למנוע הרינדור, בדיוק כמו ההמרה מצילום מסך לגופן בתוספי Figma/Chrome.
languagesמערך של קודי ISO — ברירת המחדל היא ["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 / משתנה).

                

                    
// Request

                    
                    

                

                

                    
// Response JSON

                    
                    

                

            

            

                
GET/api/public/download?link=…

                
הורד את קובץ הגופן המוכן בפורמט מסוים (ttf/otf/woff/woff2) — אותו קובץ שמפיק כפתור ההורדה ב-Studio.

                

                    
// Request

                    
                    

                

                

                    
// Response

                    
                    

                

            

            

                
GET/api/public/languages

                
כל קודי השפה בתקן ISO-2 הנתמכים, עם מספר הגליפים לכל כתב וכיוון הטקסט — אפשר להיעזר בהם כדי לבנות מערך "languages" תקין.

                

                    
// Request

                    
                    

                

                

                    
// Response JSON

                    
                    

                

            

            

                
GET/api/public/fonts

                
מאה משימות הגופנים האחרונות שלך — סטטוס, מודל, מקור וקישור לעמוד של כל גופן.

                

                    
// Request

                    
                    

                

                

                    
// Response JSON

                    
                    

                

            

            

                
// בדיקת סטטוס

                
היצירה אסינכרונית. אחרי שליחת POST ל-generate, בצע בדיקת סטטוס אל GET /api/public/status?link=… כל כמה שניות, עד שהסטטוס הופך ל-font_ready (או failed).

                

                
statusqueued · processing · font_ready · failed

                
progress{ total, completed, failed } — כמה אטלסי גליפים הושלמו

                
fontsכתובות ישירות ל-ttf/otf/woff/woff2, קיימות ברגע שstatus = font_ready.

                

                
בדיקה כל 3–5 שניות מספיקה לגמרי — משפחה שלמה בדרך כלל מסתיימת תוך פחות מכמה דקות. כתובות קובצי הגופן קבועות ולא דורשות אימות ברגע שהן מוחזרות.

            

            

                
// שגיאות

                
כל השגיאות מוחזרות במבנה JSON אחיד: { "success": false, "error": "…" }.

                

                
400בקשה שגויה — שדות חסרים או לא תקינים. בדוק את הerror לפרטים.

                
401לא מורשה — חסר או לא תקין Authorization header.

                
402נדרש תשלום — נגמרה מכסת הגליפים. אפשר לטעון עוד בעמוד התוכניות.

                
403גישה אסורה — הקישור שייך לחשבון אחר.

                
404לא נמצא — מזהה הגופן לא קיים או שייך לחשבון אחר.

                
429יותר מדי בקשות — הגעת למגבלת הקצב. נסה שוב לאחר Retry-After.

                
500שגיאה פנימית — משהו השתבש אצלנו. בדרך כלל ניסיון נוסף אחרי כמה שניות פותר את זה.

                

                

                    
{
  "success": false,
  "error": "Not enough glyphs. Top up: https://yofont.com/plans"
}