Run models all in one Sandbox 🏖️
Docs
Log-inSign-up

fal-ai/vecglypher

Vector font generation with VecGlypher. Create custom glyphs from text descriptions or reference images—outputs clean SVG paths directly without raster-to-vector conversion.
Inference
Commercial use
Schema
LLMs
PlaygroundAPI

Table of contents

About

Text To Svg

1. Calling the API#

Install the client#

The client provides a convenient way to interact with the model API.

npm install --save @fal-ai/client

Setup your API Key#

Set FAL_KEY as an environment variable in your runtime.

export FAL_KEY="YOUR_API_KEY"

Submit a request#

The client API handles the API submit protocol. It will handle the request status updates and return the result when the request is completed.

import { fal } from "@fal-ai/client";

const result = await fal.subscribe("fal-ai/vecglypher", {
  input: {
    prompt: "g"
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});
console.log(result.data);
console.log(result.requestId);

2. Authentication#

The API uses an API Key for authentication. It is recommended you set the FAL_KEY environment variable in your runtime when possible.

API Key#

In case your app is running in an environment where you cannot set environment variables, you can set the API Key manually as a client configuration.
import { fal } from "@fal-ai/client";

fal.config({
  credentials: "YOUR_FAL_KEY"
});

3. Queue#

Submit a request#

The client API provides a convenient way to submit requests to the model.

import { fal } from "@fal-ai/client";

const { request_id } = await fal.queue.submit("fal-ai/vecglypher", {
  input: {
    prompt: "g"
  },
  webhookUrl: "https://optional.webhook.url/for/results",
});

Fetch request status#

You can fetch the status of a request to check if it is completed or still in progress.

import { fal } from "@fal-ai/client";

const status = await fal.queue.status("fal-ai/vecglypher", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b",
  logs: true,
});

Get the result#

Once the request is completed, you can fetch the result. See the Output Schema for the expected result format.

import { fal } from "@fal-ai/client";

const result = await fal.queue.result("fal-ai/vecglypher", {
  requestId: "764cabcf-b745-4b3e-ae38-1200304cf45b"
});
console.log(result.data);
console.log(result.requestId);

4. Files#

Some attributes in the API accept file URLs as input. Whenever that's the case you can pass your own URL or a Base64 data URI.

Data URI (base64)#

You can pass a Base64 data URI as a file input. The API will handle the file decoding for you. Keep in mind that for large files, this alternative although convenient can impact the request performance.

Hosted files (URL)#

You can also pass your own URLs as long as they are publicly accessible. Be aware that some hosts might block cross-site requests, rate-limit, or consider the request as a bot.

Uploading files#

We provide a convenient file storage that allows you to upload files and use them in your requests. You can upload files using the client API and use the returned URL in your requests.

import { fal } from "@fal-ai/client";

const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

Read more about file handling in our file upload guide.

5. Schema#

Input#

prompt string* required

The target text to generate as vector glyphs. Each character is rendered as a separate SVG path element.

style_description string

Font style description using typography terms such as weight (100-900), style (italic, oblique), category (serif, sans-serif, display, handwriting, monospace), and characteristics (geometric, humanist, condensed, rounded). Default value: "italic style, 400 weight, serif, text, elegant"

temperature float

Sampling temperature. Lower values produce more deterministic output. Default value: 0.1

seed integer

Random seed for reproducibility.

enable_safety_checker boolean

Enable input safety checking. Default value: true

top_p float

Top-p (nucleus) sampling parameter. Default value: 0.95

top_k integer

Top-k sampling parameter. Default value: 5

repetition_penalty float

Repetition penalty to reduce repeated SVG path segments. Default value: 1

max_tokens integer

Maximum tokens to generate. Increase for longer text. Default value: 8192

output_size integer

Maximum dimension (width or height) of the output SVG in pixels. The aspect ratio is preserved. Default value: 512

fill_color string

Fill color for the generated glyphs. Accepts any valid SVG/CSS color value. Default value: "black"

stroke_color string

Optional stroke (outline) color for the generated glyphs. When set, adds an outline around each glyph path.

stroke_width float

Stroke width in SVG units. Only applies when stroke_color is set. Default value: 1

{
  "prompt": "g",
  "style_description": "italic style, 400 weight, serif, text, elegant",
  "temperature": 0.1,
  "enable_safety_checker": true,
  "top_p": 0.95,
  "top_k": 5,
  "repetition_penalty": 1,
  "max_tokens": 8192,
  "output_size": 512,
  "fill_color": "black",
  "stroke_color": "black",
  "stroke_width": 1
}

Output#

image File* required

The generated SVG file containing vector glyphs.

svg_content string* required

Raw SVG content as a string.

seed integer* required

The seed used for generation.

timings Timings* required

Timing breakdown of the generation process.

{
  "image": {
    "file_size": 959,
    "file_name": "180c718ac5d8407092d0688ea2605f0c.svg",
    "content_type": "image/svg+xml",
    "url": "https://v3b.fal.media/files/b/0a90bfc3/0f8Su2aQUzPQy4NZMDQpp_180c718ac5d8407092d0688ea2605f0c.svg"
  },
  "svg_content": "",
  "seed": 1835785439,
  "timings": {
    "inference": 10.83
  }
}

Other types#

File#

url string* required

The URL where the file can be downloaded from.

content_type string

The mime type of the file.

file_name string

The name of the file. It will be auto-generated if not provided.

file_size integer

The size of the file in bytes.

Related Models