/generate/upscale

[DEPRECATED] This API is deprecated.

Upscale an image. You can use styles and presets to quickly get results or craft your very own settings.

Note: Please user POST /generate/custom/{modelId} endpoint instead. You can retrieve the model inputs from the GET /models/{modelId} endpoint. Please use model_scenario-upscale-v3 modelId for example. See https://docs.scenario.com/docs/upscale-generation for more details.

Query Params
string

If set to true, returns the original asset without transformation

string
Body Params
string
required

Image to upscale. Must reference an existing AssetId or be a data URL.

number
0 to 100

Amount of decay in creativity over the upscale process. The lowest the value, the less the creativity will be preserved over the upscale process.

boolean
Defaults to false

If set to true, during the upscaling process, the model will match tiles of the source image with tiles of the style image(s). This will result in a more coherent restyle. Works best with style images that have a similar composition.

number
0 to 2147483647

Used to reproduce previous results. Default: randomly generated number.

styleImages
array of strings

List of style images. Most of the time, only one image is enough. It must be existing AssetIds.

styleImages
number
1 to 16

Scaling factor (when targetWidth not specified)

string
enum
Defaults to balanced

Optimize the upscale for a specific use case. Precise: Upscale for high fidelity. Balanced: Upscale for a balance between fidelity and creativity. Creative: Upscale for creativity.

Allowed:
number
0 to 100

Condition the influence of the style image(s). The higher the value, the more the style images will influence the upscaled image.

number
-50 to 50

Amount of details to remove or add

number
0 to 100

Determine the scale at which the upscale process works.

  • With a small value, the upscale works at the largest scale, resulting in fewer added details and more coherent images. Ideal for portraits, for example.
  • With a large value, the upscale works at the smallest scale, resulting in more added details and more hallucinations. Ideal for landscapes, for example.

(info): A small value is slower and more expensive to run.

string

A negative full text prompt that discourages the upscale from generating certain characteristics. It is recommended to test without using a negative prompt. Default: empty string. Example: "Low resolution, blurry, pixelated, noisy."

boolean

Override the embeddings of the model. Only your prompt and negativePrompt will be used. Use with caution.

number
0 to 100

Increase the fidelity to the prompt during upscale. Default: optimized for your preset and style.

string
enum
Defaults to standard

Optimize the upscale for a specific style. standard works in most cases. Use one of the other styles to refine the outputs.

Allowed:
number
0 to 4

Additional refinement steps before scaling.

If scalingFactor == 1, the refinement process will be applied (1 + refinementSteps) times. If scalingFactor > 1, the refinement process will be applied refinementSteps times.

number
0 to 100

Allow the generation of "hallucinations" during the upscale process, which adds additional details and deviates from the original image. Default: optimized for your preset and style.

number
0 to 100

Strengthen the similarity to the original image during the upscale. Default: optimized for your preset and style.

string
enum
Defaults to seamfull

Preserve the seamless properties of skybox or texture images. Input has to be of same type (seamless).

Allowed:
string

A full text prompt to guide the upscale and forcing the generation of certain characteristics. Default: empty string. Example: "UHD 8K hyper detailed studio photo of man face with yellow skin, anatomical++, disturbing+++, black background. Bloody++."

number
1024 to 16000

Target width for the upscaled image, take priority over scaling factor

Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json