डेवलपर्स · REST v1

YoFont API/MCP

फ़ॉन्ट जनरेट करें, ग्लिफ़ पाएँ और डिलीवरी को प्रोग्रामैटिक तरीके से मैनेज करें। ऐप वाला ही इंजन, बस एक bearer टोकन की दूरी पर।

// प्रमाणीकरण

सभी अनुरोध Authorization हेडर में एक bearer टोकन भेजते हैं। इसे सर्वर-साइड रखें।

लाइव API कुंजी बनाने के लिए साइन इन करें — यह मुफ़्त है, हर प्लान में API एक्सेस शामिल है।

// रेट लिमिट

अनुरोध हर API कुंजी के हिसाब से सीमित हैं। सीमा पार करने पर मिलता है 429 Too Many Requests , साथ में Retry-After. लिमिट आपके प्लान के हिसाब से बढ़ती हैं:

फ़ॉन्ट बनाएँ · बाकी सब
Starter60 · 600 / मिनट
Pro200 · 2 000 / मिनट
Agency600 · 6 000 / मिनट

ज़्यादा थ्रूपुट चाहिए? अपना प्लान अपग्रेड करें.

POST/api/public/generate

टेक्स्ट प्रॉम्प्ट और/या रेफ़रेंस इमेज से पूरी फ़ॉन्ट फ़ैमिली जनरेट करें। यह एक जॉब लौटाता है, जिसे आप पूरा होने तक पोल करते रहते हैं।

promptज़रूरीफ़ॉन्ट का आसान भाषा में विवरण। Optional when reference_image_url is set.
reference_image_urlस्टाइल रेफ़रेंस इमेज (PNG/JPG/WEBP) — एक डायरेक्ट पब्लिक URL। हम इसे कभी सेव नहीं करते; लिंक को जैसा है वैसा ही रेंडर इंजन को भेज देते हैं, ठीक वैसे ही जैसे 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ग्लिफ़ खत्म — Plans पेज पर टॉप-अप करें

            

            

                
GET/api/public/status?link=…

                
किसी फ़ॉन्ट का स्टेटस और डाउनलोड URL पाएँ (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

                
आपकी पिछली 100 फ़ॉन्ट जॉब्स — स्टेटस, मॉडल, सोर्स और हर फ़ॉन्ट के पेज का लिंक।

                

                    
// Request

                    
                    

                

                

                    
// Response JSON

                    
                    

                

            

            

                
// पोलिंग

                
जनरेशन असिंक है। generate पर POST करने के बाद, पोल करें GET /api/public/status?link=… हर कुछ सेकंड में, जब तक स्टेटस font_ready (या failed) न हो जाए।

                

                
statusqueued · processing · font_ready · failed

                
progress{ total, completed, failed } — कितने ग्लिफ़ एटलस पूरे हो चुके हैं

                
fontsसीधे ttf/otf/woff/woff2 URL, तब मौजूद जब status = font_ready.

                

                
हर 3–5 सेकंड में एक पोल काफ़ी है — पूरी फ़ैमिली आमतौर पर दो मिनट से कम में तैयार हो जाती है। फ़ॉन्ट फ़ाइल के URL स्टैटिक होते हैं और मिलने के बाद किसी ऑथ की ज़रूरत नहीं होती।

            

            

                
// त्रुटियाँ

                
सभी त्रुटियाँ एक जैसे JSON फ़ॉर्मैट में आती हैं: { "success": false, "error": "…" }.

                

                
400ख़राब अनुरोध — गुम या अमान्य फ़ील्ड। error देखें।

                
401अनधिकृत — गुम या अमान्य Authorization हेडर।

                
402भुगतान ज़रूरी — ग्लिफ़ कोटा खत्म। Plans पेज पर टॉप-अप करें।

                
403वर्जित — यह लिंक किसी और खाते का है।

                
404नहीं मिला — फ़ॉन्ट ID मौजूद नहीं है या किसी और खाते का है।

                
429बहुत ज़्यादा अनुरोध — रेट लिमिट पार हो गई। दोबारा कोशिश करें Retry-After.

                
500आंतरिक त्रुटि — हमारी तरफ़ से कुछ गड़बड़ हो गई। कुछ सेकंड बाद फिर कोशिश करने पर आमतौर पर काम बन जाता है।

                

                

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