Creative Upscaler

fal-ai/creative-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/creative-upscaler", {
  input: {
    image_url: "https://storage.googleapis.com/falserverless/model_tests/upscale/owl.png"
  },
  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/creative-upscaler", { image_url: url });

Read more about file handling in our file upload guide.

4. Schema#

Input#

model_typeModelTypeEnum

The type of model to use for the upscaling. Default is SD_1_5 Default value: "SD_1_5"

Possible values: "SD_1_5", "SDXL"

image_url*string

The image to upscale.

promptstring

The prompt to use for generating the image. Be as descriptive as possible for best results. If no prompt is provide BLIP2 will be used to generate a prompt.

scalefloat

The scale of the output image. The higher the scale, the bigger the output image will be. Default value: 2

creativityfloat

How much the output can deviate from the original Default value: 0.5

detailfloat

How much detail to add Default value: 1

shape_preservationfloat

How much to preserve the shape of the original image Default value: 0.25

prompt_suffixstring

The suffix to add to the generated prompt. Not used for a custom prompt. This is useful to add a common ending to all prompts such as 'high quality' etc or embedding tokens. Default value: " high quality, highly detailed, high resolution, sharp"

negative_promptstring

The negative prompt to use.Use it to address details that you don't want in the image. This could be colors, objects, scenery and even the small details (e.g. moustache, blurry, low resolution). Default value: "blurry, low resolution, bad, ugly, low quality, pixelated, interpolated, compression artifacts, noisey, grainy"

seedinteger

The same seed and the same prompt given to the same version of Stable Diffusion will output the same image every time.

guidance_scalefloat

The CFG (Classifier Free Guidance) scale is a measure of how close you want the model to stick to your prompt when looking for a related image to show you. Default value: 7.5

num_inference_stepsinteger

The number of inference steps to use for generating the image. The more steps the better the image will be but it will also take longer to generate. Default value: 20

enable_safety_checksboolean

If set to true, the resulting image will be checked whether it includes any potentially unsafe content. If it does, it will be replaced with a black image. Default value: true

skip_ccsrboolean

If set to true, the image will not be processed by the CCSR model before being processed by the creativity model.

override_size_limitsboolean

Allow for large uploads that could take a very long time.

base_model_urlstring

The URL to the base model to use for the upscaling

additional_lora_urlstring

The URL to the additional LORA model to use for the upscaling. Default is None

additional_lora_scalefloat

The scale of the additional LORA model to use for the upscaling. Default is 1.0 Default value: 1

additional_embedding_urlstring

The URL to the additional embeddings to use for the upscaling. Default is None

{
  "model_type": "SD_1_5",
  "image_url": "https://storage.googleapis.com/falserverless/model_tests/upscale/owl.png",
  "scale": 2,
  "creativity": 0.5,
  "detail": 1,
  "shape_preservation": 0.25,
  "prompt_suffix": " high quality, highly detailed, high resolution, sharp",
  "negative_prompt": "blurry, low resolution, bad, ugly, low quality, pixelated, interpolated, compression artifacts, noisey, grainy",
  "seed": 42,
  "guidance_scale": 7.5,
  "num_inference_steps": 20,
  "enable_safety_checks": true,
  "additional_lora_scale": 1
}

Output#

image*Image

The generated image file info.

seed*integer

Seed of the generated Image. It will be the same value of the one passed in the input or the randomly generated that was used in case none was passed.

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