# 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.


## Overview

- **Endpoint**: `https://fal.run/fal-ai/ideogram/upscale`
- **Model ID**: `fal-ai/ideogram/upscale`
- **Category**: image-to-image
- **Kind**: inference
**Tags**: upscaling, high-res



## Pricing

- **Price**: $0.06 per images

For more details, see [fal.ai pricing](https://fal.ai/pricing).

## API Information

This model can be used via our HTTP API or more conveniently via our client libraries.
See the input and output schema below, as well as the usage examples.


### Input Schema

The API accepts the following input parameters:


- **`image_url`** (`string`, _required_):
  The image URL to upscale
  - Examples: "https://fal.media/files/monkey/e6RtJf_ue0vyWzeiEmTby.png"

- **`prompt`** (`string`, _optional_):
  The prompt to upscale the image with Default value: `""`
  - Default: `""`

- **`resemblance`** (`integer`, _optional_):
  The resemblance of the upscaled image to the original image Default value: `50`
  - Default: `50`
  - Range: `1` to `100`

- **`detail`** (`integer`, _optional_):
  The detail of the upscaled image Default value: `50`
  - Default: `50`
  - Range: `1` to `100`

- **`expand_prompt`** (`boolean`, _optional_):
  Whether to expand the prompt with MagicPrompt functionality.
  - Default: `false`

- **`seed`** (`integer`, _optional_):
  Seed for the random number generator

- **`sync_mode`** (`boolean`, _optional_):
  If `True`, the media will be returned as a data URI and the output data won't be available in the request history.
  - Default: `false`



**Required Parameters Example**:

```json
{
  "image_url": "https://fal.media/files/monkey/e6RtJf_ue0vyWzeiEmTby.png"
}
```

**Full Example**:

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


### Output Schema

The API returns the following output format:

- **`images`** (`list<File>`, _required_)
  - Array of File
  - Examples: [{"url":"https://fal.media/files/lion/DxTSV6683MLl4VPAVUHR3_image.png","file_name":"image.png","content_type":"image/png","file_size":6548418}]

- **`seed`** (`integer`, _required_):
  Seed used for the random number generator
  - Examples: 123456



**Example Response**:

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


## Usage Examples

### cURL

```bash
curl --request POST \
  --url https://fal.run/fal-ai/ideogram/upscale \
  --header "Authorization: Key $FAL_KEY" \
  --header "Content-Type: application/json" \
  --data '{
     "image_url": "https://fal.media/files/monkey/e6RtJf_ue0vyWzeiEmTby.png"
   }'
```

### Python

Ensure you have the Python client installed:

```bash
pip install fal-client
```

Then use the API client to make requests:

```python
import fal_client

def on_queue_update(update):
    if isinstance(update, fal_client.InProgress):
        for log in update.logs:
           print(log["message"])

result = fal_client.subscribe(
    "fal-ai/ideogram/upscale",
    arguments={
        "image_url": "https://fal.media/files/monkey/e6RtJf_ue0vyWzeiEmTby.png"
    },
    with_logs=True,
    on_queue_update=on_queue_update,
)
print(result)
```

### JavaScript

Ensure you have the JavaScript client installed:

```bash
npm install --save @fal-ai/client
```

Then use the API client to make requests:

```javascript
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);
```


## Additional Resources

### Documentation

- [Model Playground](https://fal.ai/models/fal-ai/ideogram/upscale)
- [API Documentation](https://fal.ai/models/fal-ai/ideogram/upscale/api)
- [OpenAPI Schema](https://fal.ai/api/openapi/queue/openapi.json?endpoint_id=fal-ai/ideogram/upscale)

### fal.ai Platform

- [Platform Documentation](https://docs.fal.ai)
- [Python Client](https://docs.fal.ai/clients/python)
- [JavaScript Client](https://docs.fal.ai/clients/javascript)