--- title: "Topaz Image Upscale" description: "Topaz increases the resolution of one image by 2×, 3× or 4× and repairs its detail. It is the roasOS last step before delivery." url: https://docs.roasos.com/models/image-edit/topaz-image --- # Topaz Image Upscale Family `image-edit` · model `topaz-image` · catalog `model-catalog@2026-10-06.v5` · pricing `customer-pricing@2026-11-05.v15` . ## Endpoint ```http POST https://api.roasos.com/v1/image-edit/topaz-image ``` Send your API key as a bearer token. The key needs the scope `api:write`. Every paid request also needs an `Idempotency-Key` header. The envelope fields `quote_only`, `quote_id`, `webhook_url` and `wait_timeout_seconds` behave the same on each model endpoint. Refer to [Jobs](/concepts/jobs) and [Quotes and credits](/concepts/quotes-and-credits). ## Good at Topaz upscales one image and keeps the picture the same: same aspect ratio, more pixels, cleaner detail. Select the enhancement model for the source: `Standard V2` fits most photos, `High Fidelity V2` keeps the detail of professional shots, `Low Resolution V2` recovers a compressed source, `CGI` targets art and rendered graphics, `Text Refine` keeps text and shapes crisp. Turn on `face_enhancement` when a person is the subject; keep it off for product images, because it can change a logo or a label. Use it after the image is otherwise final. It does not generate new content or change composition. The output is capped at 24 megapixels. ## Pricing The unit is one **operation**. Pricing key: `topaz-image`. | Request | Credits | | --------- | ------- | | `1_image` | 1 | The credits come from the roasOS pricing table. No other field changes the price. To get the exact price of your request, send it with `quote_only: true` first. ## Modes * `upscale` Provider endpoints: `fal-ai/topaz/upscale/image`. ## Request fields | Field | Type | Required | Default | Rule | | ---------------------- | ------------ | -------- | ------------- | ------------------------------------------------------------------------------------------------------- | | `face_enhancement` | boolean | no | `false` | — | | `image_url` | string | yes | — | https URL; ≤ 4,096 characters | | `model` | enum | no | `Standard V2` | `Standard V2`, `Low Resolution V2`, `CGI`, `High Fidelity V2`, `Text Refine`, `Recovery V2`, `Redefine` | | `quote_id` | string | no | — | UUID | | `quote_only` | boolean | no | `false` | — | | `upscale_factor` | integer enum | no | `2` | `2`, `3`, `4` | | `wait_timeout_seconds` | integer | no | `0` | 0–60 | | `webhook_url` | string | no | — | https URL; ≤ 4,096 characters | The schema is strict. A field that is not in this table gets `400 unsupported_option`. The field names are the roasOS role names. One role has one name in every family. ## Media This endpoint accepts these media roles: * `image_url` — first frame (or the single source image) | Role | Items | Maximum size | Content types | Duration | | ----------- | ----- | ------------ | --------------------------------------- | -------- | | `image_url` | ≤ 1 | 10 MB | `image/jpeg`, `image/png`, `image/webp` | — | Every other role is refused: `avatar_id`, `elements`, `product_id`, `product_images`, `references`, `reference_images`, `end_image_url`, `scene_id`, `scene_image`, `video_urls`, `video_url`, `audio_urls`, `audio_url`, `voice_id`. A refused role gets `400 unsupported_option`. Each media URL must be an immutable object on `https://cdn.roasos.com` that your workspace owns. Any other URL gets `400 reference_media_not_workspace_owned` . Refer to [Reference media and uploads](/concepts/reference-media) to learn how to put a file there. ## Prompt None. roasOS sends no prompt to this model. fal has a `prompt` field for the `Redefine` model only, and roasOS does not send it. A `prompt` field returns 400 invalid\_request. ## Not exposed These catalog entries describe omitted inputs, pinned values and source constraints. They do not imply that the provider accepts every listed field. * `autoprompt` — not accepted by this public endpoint. * `creativity` — not accepted by this public endpoint. * `crop_to_fill` — not accepted by this public endpoint. * `denoise` — not accepted by this public endpoint. * `detail` — not accepted by this public endpoint. * `enhancement_strength` — not accepted by this public endpoint. * `face_enhancement_creativity` — not accepted by this public endpoint. * `face_enhancement_strength` — not accepted by this public endpoint. * `fix_compression` — not accepted by this public endpoint. * `output_format` — pinned to `png`. * `prompt` — not accepted by this public endpoint. * `sharpen` — not accepted by this public endpoint. * `strength` — not accepted by this public endpoint. * `subject_detection` — not accepted by this public endpoint. * `texture` — not accepted by this public endpoint. ## Result The result kind is `image`. Always present: nothing. Present when the run makes it: `avatar_id`, `full_body_url`, `images`, `portrait_url`, `provider_seed`, `reference_sheet`, `url`. ```json { "data": { "id": "gen_…", "kind": "image", "model": "topaz-image", "status": "completed", "result": { "avatar_id": "00000000-0000-4000-8000-000000000000", "full_body_url": "https://cdn.roasos.com/workspaces/ws_01/full_body_url", "images": [ "https://cdn.roasos.com/workspaces/ws_01/images-1.png" ], "portrait_url": "https://cdn.roasos.com/workspaces/ws_01/portrait_url", "provider_seed": 0, "reference_sheet": "https://cdn.roasos.com/workspaces/ws_01/reference_sheet", "url": "https://cdn.roasos.com/workspaces/ws_01/result" } } } ``` The files are immutable objects on `https://cdn.roasos.com`. A result URL is a valid media input for your next request. ## Example The three steps are always the same: quote, run, poll. cURL JavaScript Python ```bash # 1. Quote. Nothing is spent. curl -X POST https://api.roasos.com/v1/image-edit/topaz-image \ -H "Authorization: Bearer roasos_sk_live_..." \ -H "Idempotency-Key: 0f1c9e2a-topaz-image-0001" \ -H "Content-Type: application/json" \ -d '{"quote_only":true,"image_url":"https://cdn.roasos.com/workspaces/ws_01/uploads/image_url.png"}' # 200 { "data": { "kind": "quote", "quote_id": "q_7Hk...", "credits": 1, "expires_at": "...", # "confirmation": { "model": "topaz-image", "example": "1_image" } } } # 2. Run. Same body, same Idempotency-Key, quote_id in place of quote_only. curl -X POST https://api.roasos.com/v1/image-edit/topaz-image \ -H "Authorization: Bearer roasos_sk_live_..." \ -H "Idempotency-Key: 0f1c9e2a-topaz-image-0001" \ -H "Content-Type: application/json" \ -d '{"quote_id":"q_7Hk...","image_url":"https://cdn.roasos.com/workspaces/ws_01/uploads/image_url.png"}' # 201 { "data": { "id": "gen_...", "status": "queued", "credits_reserved": 1 } } # 3. Poll, then read the result. curl https://api.roasos.com/v1/jobs/gen_.../status -H "Authorization: Bearer roasos_sk_live_..." curl https://api.roasos.com/v1/jobs/gen_.../result -H "Authorization: Bearer roasos_sk_live_..." ``` ```javascript const key = process.env.ROASOS_API_KEY; const url = "https://api.roasos.com/v1/image-edit/topaz-image"; const idempotencyKey = "0f1c9e2a-topaz-image-0001"; const input = { "image_url": "https://cdn.roasos.com/workspaces/ws_01/uploads/image_url.png" }; const post = (payload) => fetch(url, { method: "POST", headers: { Authorization: `Bearer ${key}`, "Idempotency-Key": idempotencyKey, "Content-Type": "application/json", }, body: JSON.stringify(payload), }).then((response) => response.json()); // 1. Quote. Nothing is spent. const quote = await post({ quote_only: true, ...input }); console.log(quote.data.credits); // 2. Run. const job = await post({ quote_id: quote.data.quote_id, ...input }); // 3. Poll, then read the result. let status = "queued"; while (status !== "completed" && status !== "failed" && status !== "canceled") { await new Promise((done) => setTimeout(done, 3000)); const poll = await fetch(`${url.split("/v1")[0]}/v1/jobs/${job.data.id}/status`, { headers: { Authorization: `Bearer ${key}` }, }).then((response) => response.json()); status = poll.data.status; } const result = await fetch(`${url.split("/v1")[0]}/v1/jobs/${job.data.id}/result`, { headers: { Authorization: `Bearer ${key}` }, }).then((response) => response.json()); console.log(result.data.result); ``` ```python import os, time, requests key = os.environ["ROASOS_API_KEY"] url = "https://api.roasos.com/v1/image-edit/topaz-image" headers = { "Authorization": f"Bearer {key}", "Idempotency-Key": "0f1c9e2a-topaz-image-0001", } payload = { "image_url": "https://cdn.roasos.com/workspaces/ws_01/uploads/image_url.png" } # 1. Quote. Nothing is spent. quote = requests.post(url, headers=headers, json={"quote_only": True, **payload}).json() print(quote["data"]["credits"]) # 2. Run. job = requests.post(url, headers=headers, json={"quote_id": quote["data"]["quote_id"], **payload}).json() job_id = job["data"]["id"] # 3. Poll, then read the result. jobs = "https://api.roasos.com/v1/jobs" status = "queued" while status not in ("completed", "failed", "canceled"): time.sleep(3) status = requests.get(f"{jobs}/{job_id}/status", headers=headers).json()["data"]["status"] result = requests.get(f"{jobs}/{job_id}/result", headers=headers).json() print(result["data"]["result"]) ``` ## Today `POST /v1/image-edit/topaz-image` is live. `POST /v1/generations` has no `upscale` type, so this endpoint is the only public surface; the app Effects page sends the same operation as `scale`, `topazEnhanceModel` and `faceEnhancement`. Before the quote, the source object is verified and pinned: the endpoint reads its true dimensions, proves that width x height x factor^2 stays at or under 24 megapixels, and copies the exact bytes, so the image that is quoted is the image that is upscaled. ## See also * [`llms.txt` for this model](https://docs.roasos.com/models/image-edit/topaz-image/llms.txt) — the same facts as one plain-text file for an agent. * `GET https://api.roasos.com/v1/catalog/topaz-image` — the machine-readable form: enums, defaults, limits and prices. Refer to the [API reference](/api-reference/overview). * [Jobs](/concepts/jobs) — how to poll a job and read its result. * Provider endpoints: `fal-ai/topaz/upscale/image`.