Topaz Image Upscale
Topaz · Image · Image → Image
Image upscaling and enhancement with Topaz AI — Standard, Hi-Fi, CGI, Recovery and Wonder models.
topaz-upscale-imageWorkflow: topaz/upscale/imageOverview
Alongside the unified model APIs, we expose compatibility APIs that take each vendor's original parameters exactly as the vendor defines them — nothing renamed, nothing reshaped on the way through.
That makes them the shortest path onto Picsart if you already work with the vendor directly: the request bodies you've already written keep working as they are. You keep their parameter names and defaults, and you get the vendor's full parameter set rather than the subset that is shared across every model.
The cost is that a request is written for one vendor — switching models later means rewriting it, and results come back in the vendor's own shape. When you'd rather write once and change models freely, use the unified API.
Make a request
Call the workflow with ai.apis.run() in TypeScript, or hit /workflows/{workflow}/execute directly — params is passed through untouched either way.
These endpoints are addressed by workflow name rather than model id: the one in this model's header, since one model runs as one workflow. Authentication is unchanged — your Picsart API key as a bearer token (see Authentication).
import { createClient, ApiRunMode } from '@picsart/ai-sdk';
const ai = createClient({
apiKey: process.env.PICSART_API_KEY,
apiUrl: 'https://api.picsart.com',
});
// Calls the 'topaz/upscale/image' workflow directly — params are sent as-is.
const { result, usage } = await ai.apis.run('topaz/upscale/image', {
prompt: "A serene mountain lake at golden hour, ultra detailed",
image_url: "https://storage.googleapis.com/falserverless/model_tests/codeformer/codeformer_poor_1.jpeg"
}, {
mode: ApiRunMode.SYNC,
});
console.log(result); // workflow-specific output
console.log(usage?.credits); // credits chargedParameters
20 parameters, sent inside params. These are the vendor's own names, so they line up one-for-one with the vendor's documentation. Required ones must be supplied; the rest fall back to their defaults.
| Parameter | Type | Required | Default | Details |
|---|---|---|---|---|
face_enhancement_creativityCreativity level for face enhancement. 0.0 means no creativity, 1.0 means maximum creativity. Ignored if face enhancement is disabled. | number | no | 0 | 0–1 |
strengthEnhancement strength (0.01-1.0). Applies to Text Refine model only. | number | no | — | 0.01–1 |
creativityCreativity level for generative upscaling (1-6). Higher values produce more creative/hallucinated details. Applies to Redefine model only. | integer | no | — | 1–6 |
face_enhancement_strengthStrength of the face enhancement. 0.0 means no enhancement, 1.0 means maximum enhancement. Ignored if face enhancement is disabled. | number | no | 0.8 | 0–1 |
fix_compressionCompression artifact removal level (0.0-1.0). Applies to Standard V2, Low Resolution V2, High Fidelity V2, and Text Refine models. | number | no | — | 0–1 |
detailDetail recovery level (0.0-1.0). Applies to Recovery V2 model only. | number | no | — | 0–1 |
face_enhancementWhether to apply face enhancement to the image. Applies to standard enhance and Recovery V2 models. | boolean | no | true | — |
autopromptEnable automatic prompt generation for generative upscaling. Applies to Redefine model only. | boolean | no | — | — |
modelModel to use for image enhancement, grouped by family. Precision — Standard V2 fits most photos, High Fidelity V2 preserves detail in professional shots, Low Resolution V2 recovers compressed sources, CGI targets art and rendered graphics, Text Refine keeps text and shapes crisp. Generative — Wonder 3 is Topaz's most advanced generative model, Redefine adds prompt-guided creative detail, Standard MAX maximizes quality, Recovery/Recovery V2 rebuild extreme low-resolution images. | string | no | Standard V2 | Standard V2High Fidelity V2Low Resolution V2CGIText RefineWonder 3WonderStandard MAXRedefineRecovery V2Recovery |
subject_detectionSubject detection mode for the image enhancement. Applies to standard enhance and Recovery V2 models. | string | no | All | AllForegroundBackground |
upscale_factorFactor to upscale the image by (e.g. 2.0 doubles width and height) | number | no | 2 | 1–4 |
promptText prompt to guide generative upscaling (max 1024 chars). Applies to Redefine model only. | string | no | — | max 1024 chars |
output_formatOutput format of the upscaled image. | string | no | jpeg | jpegpng |
sharpenSharpening level (0.0-1.0). Applies to Standard V2, Low Resolution V2, CGI, High Fidelity V2, Text Refine, and Redefine models. | number | no | — | 0–1 |
enhancement_strengthEnhancement strength for generative upscaling. Applies to Wonder 3 model only. When omitted, Topaz auto-configures it. | string | no | — | lowmediumhigh |
denoiseDenoising level (0.0-1.0). Applies to Standard V2, Low Resolution V2, CGI, High Fidelity V2, Text Refine, and Redefine models. | number | no | — | 0–1 |
image_urlUrl of the image to be upscaled | string | yes | — | min 1 chars e.g. https://storage.googleapis.com/falserverless/model_tests/codeformer/codeformer_poor_1.jpeg |
textureTexture detail level for generative upscaling (1-5). Applies to Redefine model only. | integer | no | — | 1–5 |
crop_to_fill | boolean | no | false | — |
optionsPlatform-specific options for safety checks and Picsart Drive integration. | object | no | — | — |
└ safety_checksSafety check configuration. | object | no | — | — |
└ enabledEnable or disable text safety checks. Defaults to true. | boolean | no | true | — |
└ drivePicsart Drive storage options. When provided, the result will be saved to the user's Drive. | object | no | — | — |
└ nameFilename to save the result as in Picsart Drive. | string | yes | — | — |
└ attributesAdditional file metadata attributes. | object | no | — | — |
└ folderDestination folder in Picsart Drive. | object | no | — | — |
Response
Over HTTP the output arrives inside a status envelope, at response.result. ai.apis.run() unwraps that envelope for you and resolves to { result, usage } instead. Either way the resultitself is the vendor's own shape.
{
"result": {
"image": {
"file_size": 4404019,
"file_name": "z9RV14K95DvU.png",
"content_type": "image/png",
"url": "https://cdn.picsart.com/…/result.jpg"
}
},
"usage": {
"credits": 3
}
}