YoFont — AI font generator
Pembangun · REST v1

YoFont API/MCP

Jana fon, ambil glif dan urus penghantaran secara berprogram. Enjin yang sama seperti aplikasi, cuma satu token bearer jaraknya.

// Pengesahan

Semua permintaan menggunakan token bearer dalam pengepala Authorization. Simpannya di bahagian pelayan.

Log masuk untuk menjana kunci API langsung — akses API & MCP disertakan dengan pelan Pro dan Studio.

// Had kadar

Permintaan dihadkan bagi setiap kunci API. Melebihi had akan mengembalikan 429 Too Many Requests dengan satu Retry-After. Had berskala mengikut pelan anda:

Cipta fon · selebihnya
Pro200 · 2 000 / min
Studio600 · 6 000 / min

Perlukan lebih banyak kapasiti? Naik taraf pelan anda.

POST/api/public/generate

Jana keluarga fon yang lengkap daripada arahan teks dan/atau imej rujukan. Ia mengembalikan satu kerja yang anda semak sehingga siap.

promptwajibPenerangan muka taip dalam bahasa biasa. Optional when reference_image_url is set.
reference_image_urlImej rujukan gaya (PNG/JPG/WEBP) — satu URL awam yang terus. Kami tidak pernah menyimpannya; kami menghantar pautan itu seadanya ke enjin render, sama seperti tangkap-layar-jadi-fon pada pemalam Figma/Chrome.
languagesTatasusunan kod ISO — lalai kepada ["en"]. Two-letter ISO codes, full list: GET /api/public/languages.
weightscth. ["normal","bold","thin"].
glyph_typesletters · digits · punct · special (default all).
model_tierstandard (Epicur ×1) · pro (Spinoza ×3) · ultra (Nietzsche ×5).

                
200Diterima — mengembalikan { success, link, task_id, glyphs_charged, status_url }
// Response JSON

                
402Kehabisan glif — tambah nilai di halaman Pelan
GET/api/public/status?link=…

Ambil status fon dan URL muat turunnya (TTF / WOFF2 / variable).

// Request

                
// Response JSON

                
GET/api/public/download?link=…

Muat turun fail fon yang telah dibina dalam format tertentu (ttf/otf/woff/woff2) — fail yang sama seperti yang dihasilkan butang muat turun Studio.

// Request

                
// Response

                
GET/api/public/languages

Setiap kod bahasa ISO-2 yang disokong, lengkap dengan bilangan glif bagi setiap sistem tulisan dan arah teks — gunakannya untuk membina tatasusunan "languages" yang sah.

// Request

                
// Response JSON

                
GET/api/public/fonts

100 kerja fon terakhir anda — status, model, sumber dan pautan ke halaman setiap fon.

// Request

                
// Response JSON

                
// Semakan status

Penjanaan adalah tak segerak. Selepas POST ke generate, semak GET /api/public/status?link=… setiap beberapa saat sehingga statusnya font_ready (atau failed).

statusqueued · processing · atlas_ready · font_ready · failed
progress{ total, completed, failed } — berapa banyak atlas glif sudah siap
fontsURL fail ttf/otf/woff/woff2, hadir setelah status = font_ready. URL ini memerlukan kunci API anda — mengambilnya tanpa pengepala Authorization akan mengembalikan 403. Muat turun baitnya melalui GET /api/public/download?link=…&format=….

Semakan setiap 3–5 saat sudah memadai — satu keluarga penuh biasanya siap dalam masa kurang daripada beberapa minit. Ambil failnya melalui GET /api/public/download dengan kunci API anda; URL dalam "fonts" tidak boleh diakses secara awam.

// Ralat

Semua ralat mengikut bentuk JSON yang konsisten: { "success": false, "error": "…" }.

400Permintaan tidak sah — medan hilang atau tidak sah. Semak error untuk butiran.
401Tidak dibenarkan — hilang atau tidak sah Authorization pengepala.
402Pembayaran diperlukan — kuota glif habis. Tambah nilai di halaman Pelan.
403Dilarang — pautan itu milik akaun lain.
404Tidak dijumpai — ID fon itu tidak wujud atau milik akaun lain.
429Terlalu banyak permintaan — had kadar dicapai. Cuba semula selepas Retry-After.
500Ralat dalaman — ada sesuatu yang tidak kena di pihak kami. Mencuba semula selepas beberapa saat biasanya berjaya.
{
  "success": false,
  "error": "Not enough glyphs. Top up: https://yofont.com/plans"
}