Topaz Labs

App · 18 actions

Enhance images, estimate processing costs and track image and video jobs in Topaz Labs.

Actions

ActionWhat it does
Adjust image lightingAdjust image lighting.
Denoise an imageDenoise an image.
Enhance an imageEnhance an image.
Enhance an image with a generative modelEnhance an image with a generative model.
Estimate generative image processingEstimate generative image processing.
Estimate image processingEstimate image processing.
Get a video requestGet a video request.
Get an image input linkGet an image input link.
Get an image jobGet an image job.
Get an image output linkGet an image output link.
Get video job metricsGet video job metrics.
Get video job statusGet video job status.
Get video service statusGet video service status.
List image jobsList image jobs.
List video requestsList video requests.
Remove an image backgroundRemove an image background.
Restore an image with a generative modelRestore an image with a generative model.
Sharpen an imageSharpen an image.

Adjust image lighting

Adjust image lighting.

Inputs

Source URLsource_urltext
Source URL.
Source IDsource_idtext
Source ID.
ModelmodeltextRequired
Model.One of: Adjust, Adjust V2, White Balance, Colorize.
Output formatoutput_formattext
Output format.One of: jpeg, png, tiff, webp.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "eta": 1,
    "process_id": "example",
    "source_id": "example"
  }
}

Denoise an image

Denoise an image.

Inputs

Source URLsource_urltext
Source URL.
Source IDsource_idtext
Source ID.
ModelmodeltextRequired
Model.One of: Normal, Strong, Extreme.
Output formatoutput_formattext
Output format.One of: jpeg, png, tiff, webp.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "eta": 1,
    "process_id": "example",
    "source_id": "example"
  }
}

Enhance an image

Enhance an image.

Inputs

Source URLsource_urltext
Source URL.
Source IDsource_idtext
Source ID.
ModelmodeltextRequired
Model.One of: Standard V2, Low Resolution V2, CGI, High Fidelity V2, Text Refine.
Output formatoutput_formattext
Output format.One of: jpeg, png, tiff, webp.
Output widthoutput_widthnumber
Output width.
Output heightoutput_heightnumber
Output height.
Crop to fillcrop_to_filltrue/false
Crop to fill.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "eta": 1,
    "process_id": "example",
    "source_id": "example"
  }
}

Enhance an image with a generative model

Enhance an image with a generative model.

Inputs

Source URLsource_urltext
Source URL.
Source IDsource_idtext
Source ID.
ModelmodeltextRequired
Model.One of: Standard MAX, Recovery V2, Wonder, Redefine.
Output formatoutput_formattext
Output format.One of: jpeg, png, tiff, webp.
Output widthoutput_widthnumber
Output width.
Output heightoutput_heightnumber
Output height.
Crop to fillcrop_to_filltrue/false
Crop to fill.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "eta": 1,
    "process_id": "example",
    "source_id": "example"
  }
}

Estimate generative image processing

Estimate generative image processing.

Inputs

Categorycategorytext
Indicates which category of model is being used.One of: Enhance, Sharpen, Denoise, Restore, Lighting, Matting, Tool.
Modelmodeltext
The model to use for processing the image.One of: Standard MAX, Recovery V2, Wonder, Redefine, Super Focus V2, Dust-Scratch, Dust-Scratch V2.
Input heightinput_heightnumberRequired
The height of the input image in pixels.From 1 to 32000.
Input widthinput_widthnumberRequired
The width of the input image in pixels.From 1 to 32000.
Output heightoutput_heightnumber
The desired height of the output image in pixels. Your image will automatically be upscaled to this specified value. If only one of `output_height` and `output_width` is set, then the other dimension is scaled proportionally. Only applicable for Enhance models.From 1 to 32000.
Output widthoutput_widthnumber
The desired width of the output image in pixels. Your image will automatically be upscaled to this specified value. If only one of `output_height` and `output_width` is set, then the other dimension is scaled proportionally. Only applicable for Enhance models.From 1 to 32000.
Output formatoutput_formattext
The desired format of the output image.One of: jpeg, jpg, png, tiff, tif.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "credits": 1,
    "duration": 1
  }
}

Estimate image processing

Estimate image processing.

Inputs

Categorycategorytext
Indicates which category of model is being used.One of: Enhance, Sharpen, Denoise, Restore, Lighting, Matting, Tool.
Modelmodeltext
The model to use for processing the image.One of: Standard V2, Low Resolution V2, CGI, High Fidelity V2, Text Refine, Standard, Strong, Lens Blur, Lens Blur V2, Motion Blur, and 12 more.
Input heightinput_heightnumberRequired
The height of the input image in pixels.From 1 to 32000.
Input widthinput_widthnumberRequired
The width of the input image in pixels.From 1 to 32000.
Output heightoutput_heightnumber
The desired height of the output image in pixels. Your image will automatically be upscaled to this specified value. If only one of `output_height` and `output_width` is set, then the other dimension is scaled proportionally. Only applicable for Enhance models.From 1 to 32000.
Output widthoutput_widthnumber
The desired width of the output image in pixels. Your image will automatically be upscaled to this specified value. If only one of `output_height` and `output_width` is set, then the other dimension is scaled proportionally. Only applicable for Enhance models.From 1 to 32000.
Output formatoutput_formattext
The desired format of the output image.One of: jpeg, jpg, png, tiff, tif.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "credits": 1,
    "duration": 1
  }
}

Get a video request

Get a video request.

Inputs

Requestrequest_idtextRequired
Request ID.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "adminId": 1,
    "destination": {
      "container": "example",
      "download": {
        "expiresAt": 1,
        "expiresIn": 1,
        "url": "example"
      },
      "duration": 1,
      "frameCount": 1,
      "frameRate": 1,
      "size": 1
    },
    "error": {
      "errorCode": "example",
      "message": "example"
    },
    "estimates": {
      "cost": [
        1
      ],
      "time": [
        1
      ]
    },
    "filters": [
      {
        "adjustExposure": 1,
        "auto": "example",
        "blur": 1,
        "boostSaturation": 1,
        "compression": 1,
        "details": 1,
        "fieldOrder": "example",
        "focusFixLevel": "example",
        "fullFrame": true,
        "grain": 1,
        "grainSigma": 1,
        "grainSize": 1,
        "grainType": "example",
        "halo": 1,
        "highlightThreshold": 1,
        "model": "example",
        "noise": 1,
        "preblur": 1,
        "prenoise": 1,
        "recoverOriginalDetailValue": 1,
        "reduceMotionJitter": 1,
        "rollingShutterCorrection": true,
        "strength": 1,
        "transferFunction": "example",
        "videoType": "example"
      }
    ],
    "id": "example",
    "lastEventTs": 1,
    "output": {
      "audioBitrate": "example",
      "audioCodec": "example",
      "audioTransfer": "example",
      "container": "example",
      "cropToFit": true,
      "dynamicCompressionLevel": "example",
      "frameRate": 1,
      "resolution": {
        "height": 1,
        "width": 1
      },
      "videoBitrate": "example",
      "videoEncoder": "example",
      "videoProfile": "example"
    },
    "overrides": {
      "forceHighPerformance": true,
      "shouldAddWatermark": true
    },
    "processing": {
      "topserving": {
        "lastUpdated": 1
      }
    },
    "source": {
      "container": "example",
      "download": {
        "expiresAt": 1,
        "expiresIn": 1,
        "url": "example"
      },
      "duration": 1,
      "endNumber": 1,
      "frameCount": 1,
      "frameRate": 1,
      "md5Hash": "example",
      "resolution": {
        "height": 1,
        "width": 1
      },
      "size": 1,
      "startNumber": 1
    },
    "status": "example",
    "transactions": [
      {
        "amount": 1,
        "operation": "example"
      }
    ],
    "ts": {
      "accepted": 1,
      "canceled": 1,
      "canceling": 1,
      "complete": 1,
      "failed": 1,
      "initializing": 1,
      "postprocessing": 1,
      "preprocessing": 1,
      "processing": 1,
      "requested": 1
    },
    "userId": 1,
    "version": "example"
  }
}

Get an image input link.

Inputs

Processprocess_idtextRequired
The UUID of the image processing job.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "download_url": "example",
    "expiry": 1,
    "head_url": "example"
  }
}

Get an image job

Get an image job.

Inputs

Processprocess_idtextRequired
The UUID of the image processing job.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "category": "example",
    "creation_time": 1,
    "credits": 1,
    "crop_to_fill": true,
    "eta": 1,
    "filename": "example",
    "input_format": "example",
    "input_height": 1,
    "input_width": 1,
    "model": "example",
    "model_type": "example",
    "modification_time": 1,
    "options_json": "example",
    "output_format": "example",
    "output_height": 1,
    "output_width": 1,
    "process_id": "example",
    "progress": 1,
    "source_id": "example",
    "status": "example"
  }
}

Get an image output link.

Inputs

Processprocess_idtextRequired
The UUID of the image processing job.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "download_url": "example",
    "expiry": 1,
    "head_url": "example"
  }
}

Get video job metrics

Get video job metrics.

Inputs

Requestrequest_idtextRequired
Request ID.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "chunks": [
      {
        "chunkIndex": 1,
        "tasks": [
          {}
        ]
      }
    ],
    "inputFrames": 1,
    "inputSize": "example",
    "minutesInState": {
      "initializing": 1,
      "pendingSourceUpload": 1,
      "postprocessing": 1,
      "preprocessing": 1,
      "processing": 1
    },
    "minutesToEnhance": 1,
    "outputFrames": 1,
    "outputSize": "example"
  }
}

Get video job status

Get video job status.

Inputs

Requestrequest_idtextRequired
Request ID.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "averageFps": 1,
    "combinedFps": 1,
    "comparisonTool": "example",
    "download": {
      "expiresAt": 1,
      "expiresIn": 1,
      "url": "example"
    },
    "errorCode": "example",
    "estimates": {
      "cost": [
        1
      ],
      "time": [
        1
      ]
    },
    "message": "example",
    "outputSize": "example",
    "processingJobs": [
      {
        "averageFps": 1,
        "averageGpuMemoryUtilization": 1,
        "averageGpuUtilization": 1,
        "chunkId": "example",
        "chunkIndex": 1,
        "progress": 1,
        "status": "example",
        "taskIndex": 1
      }
    ],
    "progress": 1,
    "status": "example",
    "uploadId": "example",
    "urls": [
      "example"
    ]
  }
}

Get video service status

Get video service status.

Inputs

None.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "availabilityMessage": "example",
    "isAvailable": true,
    "isFrameInterpolationSupported": true,
    "supportedModels": [
      "example"
    ]
  }
}

List image jobs

List image jobs.

Inputs

Limitlimitnumber
Number of results per page when pagination is enabled. Ignored if `paginated=false`. Defaults to 50, maximum is 100.From 1 to 100.
Cursorcursortext
Cursor for pagination. Use the `next_cursor` value from the previous response to retrieve the next page. Ignored if `paginated=false`.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "data": [
      {
        "category": "example",
        "model": "example",
        "modification_time": 1,
        "process_id": "example",
        "progress": 1,
        "status": "example"
      }
    ],
    "pagination": {
      "has_next_page": true,
      "next_cursor": "example"
    }
  }
}

List video requests

List video requests.

Inputs

Cursorcursortext
Base64url-encoded cursor for pagination. Use the `nextCursor` value from a previous response to fetch the next page.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "nextCursor": "example",
    "result": [
      {
        "adminId": 1,
        "destination": {
          "container": {},
          "download": {},
          "duration": {},
          "frameCount": {},
          "frameRate": {},
          "size": {}
        },
        "error": {
          "errorCode": {},
          "message": {}
        },
        "estimates": {
          "cost": {},
          "time": {}
        },
        "filters": [
          {}
        ],
        "id": "example",
        "lastEventTs": 1,
        "output": {
          "audioBitrate": {},
          "audioCodec": {},
          "audioTransfer": {},
          "container": {},
          "cropToFit": {},
          "dynamicCompressionLevel": {},
          "frameRate": {},
          "resolution": {},
          "videoBitrate": {},
          "videoEncoder": {},
          "videoProfile": {}
        },
        "overrides": {
          "forceHighPerformance": {},
          "shouldAddWatermark": {}
        },
        "processing": {
          "topserving": {}
        },
        "source": {
          "container": {},
          "download": {},
          "duration": {},
          "endNumber": {},
          "frameCount": {},
          "frameRate": {},
          "md5Hash": {},
          "resolution": {},
          "size": {},
          "startNumber": {}
        },
        "status": "example",
        "transactions": [
          {}
        ],
        "ts": {
          "accepted": {},
          "canceled": {},
          "canceling": {},
          "complete": {},
          "failed": {},
          "initializing": {},
          "postprocessing": {},
          "preprocessing": {},
          "processing": {},
          "requested": {}
        },
        "userId": 1,
        "version": "example"
      }
    ]
  }
}

Remove an image background

Remove an image background.

Inputs

Source URLsource_urltext
Source URL.
Source IDsource_idtext
Source ID.
ModelmodeltextRequired
Model.One of: Object.
Output formatoutput_formattext
Output format.One of: jpeg, png, tiff, webp.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "eta": 1,
    "process_id": "example",
    "source_id": "example"
  }
}

Restore an image with a generative model

Restore an image with a generative model.

Inputs

Source URLsource_urltext
Source URL.
Source IDsource_idtext
Source ID.
ModelmodeltextRequired
Model.One of: Dust-Scratch, Dust-Scratch V2.
Output formatoutput_formattext
Output format.One of: jpeg, png, tiff, webp.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "eta": 1,
    "process_id": "example",
    "source_id": "example"
  }
}

Sharpen an image

Sharpen an image.

Inputs

Source URLsource_urltext
Source URL.
Source IDsource_idtext
Source ID.
ModelmodeltextRequired
Model.One of: Standard, Strong, Lens Blur, Lens Blur V2, Motion Blur, Natural, Refocus, Wildlife, Portrait.
Output formatoutput_formattext
Output format.One of: jpeg, png, tiff, webp.

Outputs

dataobject
The response from Topaz Labs.
Example output
{
  "data": {
    "eta": 1,
    "process_id": "example",
    "source_id": "example"
  }
}

On this page