✨ NEW: Seedream 4.0 Edit - Best Model for Image Editing
DocsBlogPricingEnterpriseCareersResearch Grants
Log-inSign-up

Calligrapher Image to Image

fal-ai/calligrapher
Use the text and font retaining capabilities of calligrapher to modify texts on your books, clothes and many more.
Inference
Commercial use
PlaygroundAPI

About

Generate

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/calligrapher", {
  input: {
    source_image_url: "https://storage.googleapis.com/falserverless/calligrapher/test17_source.png",
    prompt: "The text is 'Rise'"
  },
  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/calligrapher", {
  input: {
    source_image_url: "https://storage.googleapis.com/falserverless/calligrapher/test17_source.png",
    prompt: "The text is 'Rise'"
  },
  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/calligrapher", {
  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/calligrapher", {
  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#

source_image_url string* required

Base64-encoded source image with drawn mask layers

mask_image_url string

Base64-encoded mask image (optional if using auto_mask_generation)

reference_image_url string

Optional base64 reference image for style

prompt string* required

Text prompt to inpaint or customize

num_images integer

How many images to generate Default value: 1

image_size ImageSize | Enum

Target image size for generation

Possible enum values: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9

Note: For custom image sizes, you can pass the width and height as an object:

"image_size": {
  "width": 1280,
  "height": 720
}
cfg_scale float

Guidance or strength scale for the model Default value: 1

num_inference_steps integer

Number of inference steps (1-100) Default value: 50

seed integer

Random seed for reproducibility

use_context boolean

Whether to prepend context reference to the input Default value: true

auto_mask_generation boolean

Whether to automatically generate mask from detected text

source_text string

Source text to replace (if empty, masks all detected text) Default value: ""

{
  "source_image_url": "https://storage.googleapis.com/falserverless/calligrapher/test17_source.png",
  "mask_image_url": "https://storage.googleapis.com/falserverless/calligrapher/test17_mask.png",
  "prompt": "The text is 'Rise'",
  "num_images": 1,
  "image_size": {
    "height": 1024,
    "width": 1024
  },
  "cfg_scale": 1,
  "num_inference_steps": 50,
  "use_context": true
}

Output#

images list<Image>* required
{
  "images": [
    {
      "url": "",
      "content_type": "image/png",
      "file_name": "z9RV14K95DvU.png",
      "file_size": 4404019,
      "width": 1024,
      "height": 1024
    }
  ]
}

Other types#

Image#

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.

file_data string

File data

width integer

The width of the image in pixels.

height integer

The height of the image in pixels.

ImageSize#

width integer

The width of the generated image. Default value: 512

height integer

The height of the generated image. Default value: 512