YoFont — AI font generator
開發者 · REST v1

YoFont API/MCP

用程式碼生成字型、拉取字形、打理分發。和網頁版同一套引擎,一個 bearer token 就能接入。

// 身份驗證

每個請求都要在 Authorization 標頭裡帶上 bearer token,切記只放在服務端。

登入以生成 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 / 可變字型)。

// 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

                
// 輪詢

生成是非同步的。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 標頭。
402需要付費 — 字形額度已用完,請到套餐頁充值。
403禁止訪問 — 該連結屬於其他賬戶。
404未找到 — 該字型 ID 不存在,或屬於別的賬戶。
429請求過於頻繁 — 已觸發限流,請參考響應裡的 Retry-After.
500伺服器內部錯誤 — 我們這邊出了點岔子。一般過幾秒再試一次就好。
{
  "success": false,
  "error": "Not enough glyphs. Top up: https://yofont.com/plans"
}