StatusDocsPricingCommunity
Log-inSign-up

Creative Upscaler Image to Image

Creative Upscaler
fal-ai/creative-upscaler
Inference
Commercial use

About

Generate Image

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

model_type ModelTypeEnum

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

Possible enum values: SD_1_5, SDXL

image_url string* required

The image to upscale.

prompt string

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.

scale float

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

creativity float

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

detail float

How much detail to add Default value: 1

shape_preservation float

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

prompt_suffix string

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_prompt string

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"

seed integer

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

guidance_scale float

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_steps integer

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_checks boolean

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_ccsr boolean

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

override_size_limits boolean

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

base_model_url string

The URL to the base model to use for the upscaling

additional_lora_url string

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

additional_lora_scale float

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

additional_embedding_url string

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* required

The generated image file info.

seed integer* required

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
  }
}

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.

width integer

The width of the image in pixels.

height integer

The height of the image in pixels.