Ideogram Upscale | Image to Image

fal-ai/ideogram/upscale

Ideogram Upscale enhances the resolution of the reference image by up to 2X and might enhance the reference image too. Optionally refine outputs with a prompt for guided improvements.

Inference

Commercial use

Partner

Schema

Playground API

About

Ideogram's state-of-the-art image upscaling model. Can be used as an API directly from fal.

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

Migrate to @fal-ai/client

The @fal-ai/serverless-client package has been deprecated in favor of @fal-ai/client. Please check the migration guide for more information.

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/ideogram/upscale", {
  input: {
    image_url: "https://fal.media/files/monkey/e6RtJf_ue0vyWzeiEmTby.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"
});

Protect your API Key

When running code on the client-side (e.g. in a browser, mobile app or GUI applications), make sure to not expose your FAL_KEY. Instead, use a server-side proxy to make requests to the API. For more information, check out our server-side integration guide.

3. Queue#

Long-running requests

For long-running requests, such as training jobs or models with slower inference times, it is recommended to check the Queue status and rely on Webhooks instead of blocking while waiting for the result.

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/ideogram/upscale", {
  input: {
    image_url: "https://fal.media/files/monkey/e6RtJf_ue0vyWzeiEmTby.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/ideogram/upscale", {
  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/ideogram/upscale", {
  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);

Auto uploads

The client will auto-upload the file for you if you pass a binary object (e.g. File, Data).

Read more about file handling in our file upload guide.

5. Schema#

Input#

image_url string* required

The image URL to upscale Default value: undefined

prompt string

The prompt to upscale the image with Default value: ""

resemblance integer

The resemblance of the upscaled image to the original image Default value: 50

detail integer

The detail of the upscaled image Default value: 50

expand_prompt boolean

Whether to expand the prompt with MagicPrompt functionality. Default value: false

seed integer

Seed for the random number generator Default value: undefined

sync_mode boolean

If set to true, the function will wait for the image to be generated and uploaded before returning the response. This will increase the latency of the function but it allows you to get the image directly in the response without going through the CDN. Default value: false

{
  "image_url": "https://fal.media/files/monkey/e6RtJf_ue0vyWzeiEmTby.png",
  "resemblance": 50,
  "detail": 50
}

Output#

images list<File>* required

Default value: undefined

seed integer* required

Seed used for the random number generator Default value: undefined

{
  "images": [
    {
      "file_size": 6548418,
      "file_name": "image.png",
      "content_type": "image/png",
      "url": "https://fal.media/files/lion/DxTSV6683MLl4VPAVUHR3_image.png"
    }
  ],
  "seed": 123456
}

Other types#

ReplaceBackgroundInputV3#

image_urls list<string>

A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format Default value: undefined

rendering_speed RenderingSpeedEnum

The rendering speed to use. Default value: "BALANCED"

Possible enum values: TURBO, BALANCED, QUALITY

color_palette ColorPalette

A color palette for generation, must EITHER be specified via one of the presets (name) or explicitly via hexadecimal representations of the color with optional weights (members) Default value: undefined

style_codes list<string>

A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style Default value: undefined

style Enum

The style type to generate with. Cannot be used with style_codes. Default value: undefined

Possible enum values: AUTO, GENERAL, REALISTIC, DESIGN

expand_prompt boolean

Determine if MagicPrompt should be used in generating the request or not. Default value: true

num_images integer

Number of images to generate. Default value: 1

seed integer

Seed for the random number generator Default value: undefined

sync_mode boolean

prompt string* required

Cyber punk city with neon lights and skyscrappers Default value: undefined

image_url string* required

The image URL whose background needs to be replaced Default value: undefined

ReplaceBackgroundOutputV3#

images list<File>* required

Default value: undefined

seed integer* required

Seed used for the random number generator Default value: undefined

RemixOutputV3#

images list<File>* required

Default value: undefined

seed integer* required

Seed used for the random number generator Default value: undefined

BaseTextToImageInputV3#

image_urls list<string>

A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format Default value: undefined

rendering_speed RenderingSpeedEnum

The rendering speed to use. Default value: "BALANCED"

Possible enum values: TURBO, BALANCED, QUALITY

color_palette ColorPalette

style_codes list<string>

A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style Default value: undefined

style Enum

The style type to generate with. Cannot be used with style_codes. Default value: undefined

Possible enum values: AUTO, GENERAL, REALISTIC, DESIGN

expand_prompt boolean

Determine if MagicPrompt should be used in generating the request or not. Default value: true

num_images integer

Number of images to generate. Default value: 1

seed integer

Seed for the random number generator Default value: undefined

sync_mode boolean

prompt string* required

Default value: undefined

image_size ImageSize | Enum

The resolution of the generated image Default value: square_hd

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
}

negative_prompt string

Description of what to exclude from an image. Descriptions in the prompt take precedence to descriptions in the negative prompt. Default value: ""

RGBColor#

r integer

Red color value Default value: 0

g integer

Green color value Default value: 0

b integer

Blue color value Default value: 0

File#

url string* required

The URL where the file can be downloaded from. Default value: undefined

content_type string

The mime type of the file. Default value: undefined

file_name string

The name of the file. It will be auto-generated if not provided. Default value: undefined

file_size integer

The size of the file in bytes. Default value: undefined

ColorPalette#

members list<ColorPaletteMember>

A list of color palette members that define the color palette Default value: undefined

name Enum

A color palette preset value Default value: undefined

Possible enum values: EMBER, FRESH, JUNGLE, MAGIC, MELON, MOSAIC, PASTEL, ULTRAMARINE

ColorPaletteMember#

rgb RGBColor* required

RGB color value for the palette member Default value: undefined

color_weight float

The weight of the color in the color palette Default value: 0.5

EditOutputV3#

images list<File>* required

Default value: undefined

seed integer* required

Seed used for the random number generator Default value: undefined

ImageSize#

width integer

The width of the generated image. Default value: 512

height integer

The height of the generated image. Default value: 512

RemixImageInputV3#

image_urls list<string>

A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format Default value: undefined

rendering_speed RenderingSpeedEnum

The rendering speed to use. Default value: "BALANCED"

Possible enum values: TURBO, BALANCED, QUALITY

color_palette ColorPalette

style_codes list<string>

A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style Default value: undefined

style Enum

The style type to generate with. Cannot be used with style_codes. Default value: undefined

Possible enum values: AUTO, GENERAL, REALISTIC, DESIGN

expand_prompt boolean

Determine if MagicPrompt should be used in generating the request or not. Default value: true

num_images integer

Number of images to generate. Default value: 1

seed integer

Seed for the random number generator Default value: undefined

sync_mode boolean

prompt string* required

The prompt to remix the image with Default value: undefined

image_url string* required

The image URL to remix Default value: undefined

strength float

Strength of the input image in the remix Default value: 0.8

image_size ImageSize | Enum

The resolution of the generated image Default value: square_hd

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
}

negative_prompt string

Description of what to exclude from an image. Descriptions in the prompt take precedence to descriptions in the negative prompt. Default value: ""

ReframeOutputV3#

images list<File>* required

Default value: undefined

seed integer* required

Seed used for the random number generator Default value: undefined

EditImageInputV3#

image_urls list<string>

A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format Default value: undefined

rendering_speed RenderingSpeedEnum

The rendering speed to use. Default value: "BALANCED"

Possible enum values: TURBO, BALANCED, QUALITY

color_palette ColorPalette

style_codes list<string>

A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style Default value: undefined

expand_prompt boolean

Determine if MagicPrompt should be used in generating the request or not. Default value: true

num_images integer

Number of images to generate. Default value: 1

seed integer

Seed for the random number generator Default value: undefined

sync_mode boolean

prompt string* required

The prompt to fill the masked part of the image. Default value: undefined

image_url string* required

The image URL to generate an image from. Needs to match the dimensions of the mask. Default value: undefined

mask_url string* required

The mask URL to inpaint the image. Needs to match the dimensions of the input image. Default value: undefined

ReframeImageInputV3#

image_urls list<string>

A set of images to use as style references (maximum total size 10MB across all style references). The images should be in JPEG, PNG or WebP format Default value: undefined

rendering_speed RenderingSpeedEnum

The rendering speed to use. Default value: "BALANCED"

Possible enum values: TURBO, BALANCED, QUALITY

color_palette ColorPalette

style_codes list<string>

A list of 8 character hexadecimal codes representing the style of the image. Cannot be used in conjunction with style_reference_images or style Default value: undefined

style Enum

The style type to generate with. Cannot be used with style_codes. Default value: undefined

Possible enum values: AUTO, GENERAL, REALISTIC, DESIGN

num_images integer

Number of images to generate. Default value: 1

seed integer

Seed for the random number generator Default value: undefined

sync_mode boolean

image_url string* required

The image URL to reframe Default value: undefined

image_size ImageSize | Enum* required

The resolution for the reframed output image Default value: undefined

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
}

Ideogram Upscale Image to Image

Table of contents

1. Calling the API

2. Authentication

3. Queue

4. Files

5. Schema

About

1. Calling the API#

Install the client#

Migrate to @fal-ai/client

Setup your API Key#

Submit a request#

2. Authentication#

API Key#

Protect your API Key

3. Queue#

Long-running requests

Submit a request#

Fetch request status#

Get the result#

4. Files#

Data URI (base64)#

Hosted files (URL)#

Uploading files#

Auto uploads

5. Schema#

Input#

Output#

Other types#

ReplaceBackgroundInputV3#

ReplaceBackgroundOutputV3#

RemixOutputV3#

BaseTextToImageInputV3#

RGBColor#

File#

ColorPalette#

ColorPaletteMember#

EditOutputV3#

ImageSize#

RemixImageInputV3#

ReframeOutputV3#

EditImageInputV3#

ReframeImageInputV3#