ControlNet Tile Upscaler

fal-ai/controlnet-tile-upscaler
Inference
Commercial use

1. Calling the API#

Install the client#

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

npm install --save @fal-ai/serverless-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 * as fal from "@fal-ai/serverless-client";

const result = await fal.subscribe("fal-ai/controlnet-tile-upscaler", {
  input: {
    prompt: "An american robin bird, sitting on a wooden branch, colorful, ultra hd, 4k, high quality",
    image_url: "https://storage.googleapis.com/falserverless/gallery/bird.jpg"
  },
  logs: true,
  onQueueUpdate: (update) => {
    if (update.status === "IN_PROGRESS") {
      update.logs.map((log) => log.message).forEach(console.log);
    }
  },
});

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 * as fal from "@fal-ai/serverless-client";

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

3. 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 * as fal from "@fal-ai/serverless-client";

// Upload a file (you can get a file reference from an input element or a drag-and-drop event)
const file = new File(["Hello, World!"], "hello.txt", { type: "text/plain" });
const url = await fal.storage.upload(file);

// Use the URL in your request
const result = await fal.subscribe("fal-ai/controlnet-tile-upscaler", { image_url: url });

Read more about file handling in our file upload guide.

4. Schema#

Input#

prompt*string

Prompt for the model

image_url*string

Control image for scribble controlnet

resolutionResolutionEnum

Image resolution Default value: "2048"

Possible values: "2048", "2560"

resemblancefloat

Conditioning scale for controlnet Default value: 0.5

creativityfloat

Denoising strength. 1 means total destruction of the original image Default value: 0.5

hdrfloat

HDR improvement over the original image

num_inference_stepsinteger

Steps Default value: 20

guidance_scalefloat

Scale for classifier-free guidance Default value: 7

seedinteger

Seed

negative_promptstring

Negative prompt Default value: "(deformed iris, deformed pupils, semi-realistic, cgi, 3d, render, sketch, cartoon, drawing, anime), text, cropped, out of frame, worst quality, low quality, jpeg artifacts, ugly, duplicate, morbid, mutilated, extra fingers, mutated hands, poorly drawn hands, poorly drawn face, mutation, deformed, blurry, dehydrated, bad anatomy, bad proportions, extra limbs, cloned face, disfigured, gross proportions, malformed limbs, missing arms, missing legs, extra arms, extra legs, fused fingers, too many fingers, long neck"

guess_modeboolean

In this mode, the ControlNet encoder will try best to recognize the content of the input image even if you remove all prompts. The guidance_scale between 3.0 and 5.0 is recommended.

output_formatOutputFormatEnum

Output format Default value: "jpeg"

Possible values: "jpeg", "png"

{
  "prompt": "An american robin bird, sitting on a wooden branch, colorful, ultra hd, 4k, high quality",
  "image_url": "https://storage.googleapis.com/falserverless/gallery/bird.jpg",
  "resolution": 2048,
  "resemblance": 0.5,
  "creativity": 0.35,
  "hdr": 0.7,
  "num_inference_steps": 20,
  "guidance_scale": 7,
  "negative_prompt": "(deformed iris, deformed pupils, semi-realistic, cgi, 3d, render, sketch, cartoon, drawing, anime), text, cropped, out of frame, worst quality, low quality, jpeg artifacts, ugly, duplicate, morbid, mutilated, extra fingers, mutated hands, poorly drawn hands, poorly drawn face, mutation, deformed, blurry, dehydrated, bad anatomy, bad proportions, extra limbs, cloned face, disfigured, gross proportions, malformed limbs, missing arms, missing legs, extra arms, extra legs, fused fingers, too many fingers, long neck",
  "output_format": "jpeg"
}

Output#

image*Image

Upscaled image

seed*integer

Seed used for the upscaling

{
  "image": {
    "url": "",
    "content_type": "image/png",
    "file_name": "z9RV14K95DvU.png",
    "file_size": 4404019,
    "width": 1024,
    "height": 1024
  }
}