> ## Documentation Index
> Fetch the complete documentation index at: https://www.mixfont.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Font generation
> Generate TTF font files from a text prompt or a reference image
export const FontPreview = ({fontFamily, children}) =>
{children}
;
Generate TTF font files from a text prompt or a public reference image. Font generation is asynchronous: create a generation, then poll until the job reaches `succeeded`, `failed`, or `cancelled`.
The font generation API is available through HTTP or Mixfont's language specific SDKs.
View the packages on [npm](https://www.npmjs.com/package/mixfont) and [PyPI](https://pypi.org/project/mixfont/).
## Install a client
```bash JavaScript theme={null}
npm install mixfont
```
```bash Python theme={null}
pip install mixfont
```
```bash cURL theme={null}
# No client library is required.
```
## Generate from an image
Reference image URLs must use HTTPS, be publicly reachable, point to a JPEG, PNG, or WebP image, and be no larger than 20 MB.
```javascript JavaScript theme={null}
import { Mixfont } from "mixfont";
const mixfont = new Mixfont({
apiKey: process.env.MIXFONT_API_KEY,
});
const generation = await mixfont.generations.create({
imageUrl: "https://images.example.com/reference-wordmark.png",
glyphSet: "standard",
});
const result = await mixfont.generations.wait(generation.id);
console.log(result.ttfUrl);
```
```python Python theme={null}
import os
from mixfont import Mixfont
mixfont = Mixfont(api_key=os.environ["MIXFONT_API_KEY"])
generation = mixfont.generations.create(
image_url="https://images.example.com/reference-wordmark.png",
glyph_set="standard",
)
result = mixfont.generations.wait(generation["id"])
print(result["ttf_url"])
```
```bash cURL theme={null}
curl https://api.mixfont.com/v1/font-generations/image \
-H "Content-Type: application/json" \
-H "x-api-key: $MIXFONT_API_KEY" \
-d '{
"image_url": "https://images.example.com/reference-wordmark.png",
"glyph_set": "standard"
}'
curl https://api.mixfont.com/v1/font-generations/GENERATION_ID \
-H "x-api-key: $MIXFONT_API_KEY"
```
Image generation returns a generation `id` and polling URL. Poll until `status` is `succeeded`, then download the generated TTF from the response. A generated font from this reference image can look like this:
## Generate from a prompt
```javascript JavaScript theme={null}
import { Mixfont } from "mixfont";
const mixfont = new Mixfont({
apiKey: process.env.MIXFONT_API_KEY,
});
const generation = await mixfont.generations.create({
prompt: "a cute and bubbly font",
glyphSet: "standard",
});
const result = await mixfont.generations.wait(generation.id);
console.log(result.ttfUrl);
```
```python Python theme={null}
import os
from mixfont import Mixfont
mixfont = Mixfont(api_key=os.environ["MIXFONT_API_KEY"])
generation = mixfont.generations.create(
prompt="a cute and bubbly font",
glyph_set="standard",
)
result = mixfont.generations.wait(generation["id"])
print(result["ttf_url"])
```
```bash cURL theme={null}
curl https://api.mixfont.com/v1/font-generations/text \
-H "Content-Type: application/json" \
-H "x-api-key: $MIXFONT_API_KEY" \
-d '{
"prompt": "a cute and bubbly font",
"glyph_set": "standard"
}'
curl https://api.mixfont.com/v1/font-generations/GENERATION_ID \
-H "x-api-key: $MIXFONT_API_KEY"
```
Prompt generation returns a generation `id` and polling URL. Poll until `status` is `succeeded`, then download the generated TTF from the response. A generated font from this prompt can look like this:
## Request structure
The REST API uses snake case. The JavaScript client maps request fields to camel case. The Python client uses snake case.
| REST field | JavaScript | Python | Used by | Description |
| ----------- | ---------- | ----------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `image_url` | `imageUrl` | `image_url` | Image generation | Public HTTPS URL for a JPEG, PNG, or WebP reference image up to 20 MB. |
| `prompt` | `prompt` | `prompt` | Text generation | Text prompt describing the font to generate. |
| `glyph_set` | `glyphSet` | `glyph_set` | Both | Optional glyph set. `standard` generates 72 glyphs for English with basic letters, numbers, and punctuation. `extended` generates 319 glyphs for all Latin languages, including special characters. Defaults to `standard`. |
`standard` costs 20 API credits and takes on average around 25 seconds. `extended` costs 50 API credits and may take 2-3 minutes to complete.
## Response structure
Create endpoints return `201 Created` with the generation object and a polling URL.
```json theme={null}
{
"id": "7d58a66d-f129-4f9a-bf9a-4f2c6d0c3e4d",
"name": "Nebula Sans",
"ttf_url": null,
"status": "preparing",
"input_type": "text",
"glyph_set": "standard",
"progress_percent": 0,
"poll_url": "https://api.mixfont.com/v1/font-generations/7d58a66d-f129-4f9a-bf9a-4f2c6d0c3e4d",
"created_at": "2026-06-02T21:12:42.000Z"
}
```
Polling returns the generation object without `poll_url`. When the job succeeds, `ttf_url` contains the generated TTF download URL.
```json theme={null}
{
"id": "7d58a66d-f129-4f9a-bf9a-4f2c6d0c3e4d",
"name": "Nebula Sans",
"ttf_url": "https://static.mixfont.com/uploads/generated/7d58a66d-f129-4f9a-bf9a-4f2c6d0c3e4d/font.ttf",
"status": "succeeded",
"input_type": "text",
"glyph_set": "standard",
"progress_percent": 100,
"created_at": "2026-06-02T21:12:42.000Z"
}
```
The JavaScript client returns camel-case response properties. The Python client returns the raw API response dictionary with snake-case keys.
| REST and Python field | JavaScript field |
| --------------------- | ----------------- |
| `input_type` | `inputType` |
| `glyph_set` | `glyphSet` |
| `progress_percent` | `progressPercent` |
| `ttf_url` | `ttfUrl` |
| `created_at` | `createdAt` |
| `poll_url` | `pollUrl` |
Generated TTF URLs are temporary and will be deleted after 24 hours. Download
each generated TTF file and save it separately if you need to preserve it.
###
Review the image generation endpoint.
Review the prompt generation endpoint.
Review the polling endpoint.
