> For the complete documentation index, see [llms.txt](https://docs.viesus.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.viesus.com/reference/cloud-api/image-enhancement.md). # Enhance Images Trigger image enhancements with createEnhancedImage. Parameters, status, AI upscaling limits, and polling vs webhooks. Once an image is uploaded, trigger enhancement with the `createEnhancedImage` mutation. Processing takes **2–180 seconds** depending on features and server load. *** ## Create an enhancement ```graphql mutation { createEnhancedImage( uploadId: "your-upload-id" input: { mode: ENHANCE noiseReductionProfilingMode: AUTO noiseReductionProfilingStrength: 0.5 artifactsDetectionRemoval: AUTO_AI enhanceFaceDetails: ENHANCE upscalingFactor: X2 } ) { id status fullUrl filename viesusDuration } } ``` Save the returned `id` — you need it to check status or retrieve the result later. *** ## Input parameters | Parameter | Type | Description | | ------------------------------------------- | ---------------------------------------------------- | ----------------------------------------- | | `mode` | `EnhancedImageEnhancementMode` | Overall enhancement mode | | `preset` | `EnhancedImageParametersPreset` | Pre-configured enhancement profile | | `noiseReductionProfilingMode` | `EnhancedImageParametersNoiseReductionProfilingMode` | Noise reduction mode | | `noiseReductionProfilingStrength` | `Decimal` | Noise reduction strength (`0.0`–`1.0`) | | `noiseReductionProfilingMonochromeStrength` | `Decimal` | Monochrome noise reduction (`0.0`–`1.0`) | | `artifactsDetectionRemoval` | `EnhancedImageParametersArtifactsDetectionRemoval` | JPEG artifact removal mode | | `enhanceFaceDetails` | `EnhancedImageParametersEnhanceFaceDetails` | Face detail enhancement | | `redEyeCorrectionsMode` | `EnhancedImageParametersRedEyeCorrectionsMode` | Red-eye correction mode | | `redEyeCorrectionsStrength` | `Decimal` | Red-eye correction strength (`0.0`–`1.0`) | | `redEyeCorrectionsEyeStrength` | `Decimal` | Eye correction strength (`0.0`–`1.0`) | | `noiseAdditionProfilingStrength` | `Decimal` | Grain addition strength (`0.0`–`1.0`) | | `upscalingFactor` | `EnhancedImageParametersUpscalingFactor` | AI upscaling factor (`X2`, `X4`, etc.) | | `upscalingCustomWidth` | `Int` | Target output width in pixels | | `upscalingCustomDPI` | `Int` | Target output DPI | | `backgroundRemovalMode` | `EnhancedImageParametersPortraitBackgroundMode` | Background removal/replacement | | `backgroundRemovalBlur` | `Decimal` | Background blur strength (`0.0`–`1.0`) | | `backgroundRemovalReplaceImageUrl` | `String` | URL of a replacement background image | | `customColorConfig` | `CustomColorConfigInput` | Manual color adjustments | For all enum values, open the schema browser at ****. *** ## AI upscaling limits | Constraint | Value | | ------------------------- | --------------------------- | | Maximum input dimension | 3,000 px (width or height) | | Maximum enlargement ratio | 4× | | Maximum output dimension | 11,996 px (width or height) | AI upscaling costs **4 credits** per image. See [Credits](/reference/cloud-api/credits.md). *** ## Check enhancement status ```graphql query { enhancedImage(id: "enhancement-id") { id status fullUrl filename viesusDuration errorCode } } ``` | Status | Meaning | | ---------- | ----------------------------------------- | | `QUEUED` | Waiting for a processing slot | | `FINISHED` | Complete — `fullUrl` is ready to download | | `ERROR` | Failed — inspect `errorCode` | When `status` is `FINISHED`, the enhanced image is available at `fullUrl`. The URL is valid for the duration of the upload's retention period. *** ## All enhancements for an upload Multiple enhancements can share a single upload (different parameters, different output variants): ```graphql query { upload(id: "upload-id") { id status EnhancedImages { id status fullUrl filename viesusDuration errorCode } } } ``` *** ## Polling vs webhooks **Polling** is straightforward but wastes requests when processing is slow: ```js async function waitForEnhancement(client, id, intervalMs = 3000) { while (true) { const { enhancedImage } = await client.request(STATUS_QUERY, { id }); if (enhancedImage.status === 'FINISHED') return enhancedImage.fullUrl; if (enhancedImage.status === 'ERROR') throw new Error(`Enhancement failed: ${enhancedImage.errorCode}`); await new Promise(r => setTimeout(r, intervalMs)); } } ``` **Webhooks** are recommended for production — your server is notified when the result is ready. See [Webhooks](/reference/cloud-api/webhooks.md). *** ## Minimal enhancement example (Node.js) ```js import { GraphQLClient, gql } from 'graphql-request'; const client = new GraphQLClient('https://api.viesus.cloud/graphql', { headers: { 'x-api-key': process.env.VIESUS_API_KEY }, }); const UPLOAD = gql` mutation ($url: String!) { createUploadFromUrl(input: { url: $url }) { id } } `; const ENHANCE = gql` mutation ($uploadId: ID!) { createEnhancedImage(uploadId: $uploadId, input: { mode: ENHANCE }) { id status } } `; const STATUS = gql` query ($id: ID!) { enhancedImage(id: $id) { status fullUrl errorCode } } `; async function enhance(imageUrl) { const { createUploadFromUrl } = await client.request(UPLOAD, { url: imageUrl }); const { createEnhancedImage } = await client.request(ENHANCE, { uploadId: createUploadFromUrl.id }); let result; do { await new Promise(r => setTimeout(r, 3000)); result = (await client.request(STATUS, { id: createEnhancedImage.id })).enhancedImage; } while (result.status === 'QUEUED'); if (result.status === 'ERROR') throw new Error(`Error: ${result.errorCode}`); return result.fullUrl; } ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.viesus.com/reference/cloud-api/image-enhancement.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.