## Basic model info

- Model name: ideogram/ideogram upscale
- Model description: 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.
- Endpoint name: upscale


## Model schema

The model schema is defined in the OpenAPI schema: [OpenAPI Schema](https://oapi.sunra.ai/main/ideogram/upscale/latest.json)

### Model input schema

The model input schema is:



```json
{
  "description": "Input schema for Ideogram upscale.",
  "properties": {
    "prompt": {
      "description": "Text prompt to guide the upscaling process",
      "title": "Prompt",
      "type": "string",
      "x-sr-order": 201
    },
    "prompt_enhancer": {
      "default": true,
      "description": "Whether to enhance the prompt automatically",
      "title": "Prompt Enhancer",
      "type": "boolean",
      "x-sr-order": 202
    },
    "seed": {
      "anyOf": [
        {
          "maximum": 2147483647,
          "minimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Random seed for reproducibility",
      "title": "Seed",
      "x-sr-order": 201
    },
    "detail": {
      "default": 50,
      "description": "The detail of the upscaled image",
      "maximum": 100,
      "minimum": 1,
      "multipleOf": 1,
      "title": "Detail",
      "type": "integer",
      "x-sr-order": 402
    },
    "image": {
      "anyOf": [
        {
          "format": "uri",
          "maxLength": 2083,
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "string"
        }
      ],
      "description": "URL of the image to upscale",
      "title": "Image",
      "x-sr-order": 301
    },
    "resemblance": {
      "default": 50,
      "description": "The resemblance of the upscaled image to the original image",
      "maximum": 100,
      "minimum": 1,
      "multipleOf": 1,
      "title": "Resemblance",
      "type": "integer",
      "x-sr-order": 401
    }
  },
  "required": [
    "image"
  ],
  "title": "UpscaleInput",
  "type": "object"
}
```



### Model output schema

The model output schema is:



```json
{
  "properties": {
    "images": {
      "items": {
        "properties": {
          "content_type": {
            "description": "The mime type of the file.",
            "title": "Content Type",
            "type": "string"
          },
          "file_name": {
            "description": "The name of the file. It will be auto-generated if not provided.",
            "title": "File Name",
            "type": "string"
          },
          "file_size": {
            "description": "The size of the file in bytes.",
            "title": "File Size",
            "type": "integer"
          },
          "url": {
            "description": "The URL where the file can be downloaded from.",
            "title": "Url",
            "type": "string"
          }
        },
        "required": [
          "content_type",
          "file_name",
          "file_size",
          "url"
        ],
        "title": "SunraFile",
        "type": "object"
      },
      "title": "Images",
      "type": "array"
    }
  },
  "required": [
    "images"
  ],
  "title": "ImagesOutput",
  "type": "object"
}
```



## Example inputs and outputs

Use the following example inputs and outputs to understand the model.

### Input example



```json
{
  "prompt": "",
  "prompt_enhancer": true,
  "seed": null,
  "detail": 50,
  "image": "",
  "resemblance": 50
}
```



### Output example



```json
{
}
```



## Model code examples

### JavaScript



```javascript
import { sunra } from "@sunra/client";

const result = await sunra.subscribe("ideogram/upscale/upscale", {
  input: {
  	image: '',
  	prompt: '',
  	prompt_enhancer: true,
  	resemblance: 50,
  	detail: 50,
  	seed: null
  },
  logs: true,
  onQueueUpdate: (update) => {
    console.log(`Status Update: ${update.status}, Request ID: ${update.request_id}`);
  },
});
console.log(result.data);
console.log(result.requestId);
```



### Python



```python
import sunra_client

result = sunra_client.subscribe(
    "ideogram/upscale/upscale",
    arguments={
        "image": "",
        "prompt": "",
        "prompt_enhancer": True,
        "resemblance": 50,
        "detail": 50,
        "seed": None
    },
    with_logs=True,
    on_enqueue=print,
    on_queue_update=print,
)
print(result)
```



### Java



```java
import ai.sunra.client.*;
import java.util.Map;
import com.google.gson.JsonObject;

var client = SunraClient.withEnvCredentials();

var response = client.subscribe(
    "ideogram/upscale/upscale",
    SubscribeOptions.<JsonObject>builder()
        .input(Map.of(
            "image", "",
            "prompt", "",
            "prompt_enhancer", true,
            "resemblance", 50,
            "detail", 50,
            "seed", null))
        .resultType(JsonObject.class)
        .onQueueUpdate(update -> System.out.printf(
            "\nStatus Update: %s, Request ID: %s%n",
            update.getStatus(),
            update.getRequestId()
        ))
        .logs(true)
        .build()
);

System.out.println("Completed!");
System.out.println(response.getData());
  
```



### Kotlin



```kotlin
import ai.sunra.client.kt.*
import com.google.gson.JsonObject

val client = createSunraClient()

val response = client.subscribe<JsonObject>(
    endpointId = "ideogram/upscale/upscale",
    input = mapOf(
            "image" to "",
            "prompt" to "",
            "prompt_enhancer" to true,
            "resemblance" to 50,
            "detail" to 50,
            "seed" to null),
    options = ai.sunra.client.kt.SubscribeOptions(logs = true),
    onUpdate = { update ->
        println("\nStatus Update: ${update.status}, Request ID: ${update.requestId}")
    }
)

println("Completed!")
println(response.data)
  
```



### Curl



```bash

curl --request POST \
  --url https://api.sunra.ai/v1/queue/ideogram/upscale/upscale \
  --header "Authorization: Key $SUNRA_KEY" \
  --header "Content-Type: application/json" \
  --data '{"image":"","prompt":"","prompt_enhancer":true,"resemblance":50,"detail":50,"seed":null}'
    
```



## Model readme

undefined