Topaz Video Upscale
Topaz · Video · Video → Video
Video upscaling and enhancement with Topaz AI — Proteus, Artemis, Nyx, Gaia and Starlight models.
topaz-upscale-videoWorkflow: topaz/upscale/videoOverview
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/video' workflow directly — params are sent as-is.
const { result, usage } = await ai.apis.run('topaz/upscale/video', {
video_url: "https://v3.fal.media/files/kangaroo/y5-1YTGpun17eSeggZMzX_video-1733468228.mp4"
}, {
mode: ApiRunMode.SYNC,
});
console.log(result); // workflow-specific output
console.log(usage?.credits); // credits chargedAsync (submit & poll)
This model can run longer than the sync limit (~20s). In TypeScript, ai.apis.run(…, { mode: ApiRunMode.ASYNC }) polls for you; over HTTP, submit and poll yourself.
import { createClient, ApiRunMode } from '@picsart/ai-sdk';
const ai = createClient({
apiKey: process.env.PICSART_API_KEY,
apiUrl: 'https://api.picsart.com',
});
// mode: ASYNC submits the job and polls under the hood — you just await.
const { result } = await ai.apis.run('topaz/upscale/video', {
video_url: "https://v3.fal.media/files/kangaroo/y5-1YTGpun17eSeggZMzX_video-1733468228.mp4"
}, {
mode: ApiRunMode.ASYNC,
});
console.log(result);Parameters
11 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 |
|---|---|---|---|---|
haloHalo reduction level (0.0-1.0). Default varies by model. | number | no | — | 0–1 |
upscale_factorFactor to upscale the video by (e.g. 2.0 doubles width and height) | number | no | 2 | 1–4 |
recover_detailRecover original detail level (0.0-1.0). Higher values preserve more original detail. | number | no | — | 0–1 |
target_fpsTarget FPS for frame interpolation. If set, frame interpolation will be enabled. | integer | no | — | 16–60 |
compressionCompression artifact removal level (0.0-1.0). Default varies by model. | number | no | — | 0–1 |
noiseNoise reduction level (0.0-1.0). Default varies by model. | number | no | — | 0–1 |
H264_outputWhether to use H264 codec for output video. Default is H265. | boolean | no | false | — |
video_urlURL of the video to upscale | string | yes | — | e.g. https://v3.fal.media/files/kangaroo/y5-1YTGpun17eSeggZMzX_video-1733468228.mp4 |
grainFilm grain amount (0.0-0.1). Default varies by model. | number | no | — | 0–0.1 · multiple of 0.01 |
modelVideo enhancement model, grouped by family. Precision — Proteus fits most footage, Artemis denoises and sharpens degraded sources, Gaia HQ/CG refine rendered content, Gaia 2 handles animation and motion graphics at 2x. Denoise — Nyx models are dedicated noise reduction. Generative — Starlight models use diffusion for restoration and upscaling. Starlight Precise 1, Starlight Precise 2 and Starlight Fast 1 are deprecated by Topaz; prefer Starlight Precise 2.5 or Starlight Fast 2. | string | no | Proteus | ProteusArtemis HQArtemis MQArtemis LQGaia HQGaia CGGaia 2NyxNyx FastNyx XLNyx HFStarlight Precise 2.5Starlight HQStarlight MiniStarlight SharpStarlight Fast 2Starlight Precise 1Starlight Precise 2Starlight Fast 1 |
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": {
"video": {
"file_size": 4404019,
"file_name": "z9RV14K95DvU.png",
"content_type": "image/png",
"url": "https://cdn.picsart.com/…/result.mp4"
}
},
"usage": {
"credits": 3
}
}