# Topaz Labs

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

App · 18 actions. Web page: https://docs.lodol.com/docs/integrations/topaz-labs

## Actions

### Adjust image lighting

Adjust image lighting.

**Inputs**

- Source URL (`source_url`, text): Source URL.
- Source ID (`source_id`, text): Source ID.
- Model (`model`, text, required): Model. One of: `Adjust`, `Adjust V2`, `White Balance`, `Colorize`.
- Output format (`output_format`, text): Output format. One of: `jpeg`, `png`, `tiff`, `webp`.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "data": {
    "eta": 1,
    "process_id": "example",
    "source_id": "example"
  }
}
```

### Denoise an image

Denoise an image.

**Inputs**

- Source URL (`source_url`, text): Source URL.
- Source ID (`source_id`, text): Source ID.
- Model (`model`, text, required): Model. One of: `Normal`, `Strong`, `Extreme`.
- Output format (`output_format`, text): Output format. One of: `jpeg`, `png`, `tiff`, `webp`.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "data": {
    "eta": 1,
    "process_id": "example",
    "source_id": "example"
  }
}
```

### Enhance an image

Enhance an image.

**Inputs**

- Source URL (`source_url`, text): Source URL.
- Source ID (`source_id`, text): Source ID.
- Model (`model`, text, required): Model. One of: `Standard V2`, `Low Resolution V2`, `CGI`, `High Fidelity V2`, `Text Refine`.
- Output format (`output_format`, text): Output format. One of: `jpeg`, `png`, `tiff`, `webp`.
- Output width (`output_width`, number): Output width.
- Output height (`output_height`, number): Output height.
- Crop to fill (`crop_to_fill`, true/false): Crop to fill.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "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 URL (`source_url`, text): Source URL.
- Source ID (`source_id`, text): Source ID.
- Model (`model`, text, required): Model. One of: `Standard MAX`, `Recovery V2`, `Wonder`, `Redefine`.
- Output format (`output_format`, text): Output format. One of: `jpeg`, `png`, `tiff`, `webp`.
- Output width (`output_width`, number): Output width.
- Output height (`output_height`, number): Output height.
- Crop to fill (`crop_to_fill`, true/false): Crop to fill.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "data": {
    "eta": 1,
    "process_id": "example",
    "source_id": "example"
  }
}
```

### Estimate generative image processing

Estimate generative image processing.

**Inputs**

- Category (`category`, text): Indicates which category of model is being used. One of: `Enhance`, `Sharpen`, `Denoise`, `Restore`, `Lighting`, `Matting`, `Tool`.
- Model (`model`, text): 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 height (`input_height`, number, required): The height of the input image in pixels. From 1 to 32000.
- Input width (`input_width`, number, required): The width of the input image in pixels. From 1 to 32000.
- Output height (`output_height`, number): 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 width (`output_width`, number): 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 format (`output_format`, text): The desired format of the output image. One of: `jpeg`, `jpg`, `png`, `tiff`, `tif`.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "data": {
    "credits": 1,
    "duration": 1
  }
}
```

### Estimate image processing

Estimate image processing.

**Inputs**

- Category (`category`, text): Indicates which category of model is being used. One of: `Enhance`, `Sharpen`, `Denoise`, `Restore`, `Lighting`, `Matting`, `Tool`.
- Model (`model`, text): 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 height (`input_height`, number, required): The height of the input image in pixels. From 1 to 32000.
- Input width (`input_width`, number, required): The width of the input image in pixels. From 1 to 32000.
- Output height (`output_height`, number): 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 width (`output_width`, number): 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 format (`output_format`, text): The desired format of the output image. One of: `jpeg`, `jpg`, `png`, `tiff`, `tif`.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "data": {
    "credits": 1,
    "duration": 1
  }
}
```

### Get a video request

Get a video request.

**Inputs**

- Request (`request_id`, text, required): Request ID.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "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

Get an image input link.

**Inputs**

- Process (`process_id`, text, required): The UUID of the image processing job.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "data": {
    "download_url": "example",
    "expiry": 1,
    "head_url": "example"
  }
}
```

### Get an image job

Get an image job.

**Inputs**

- Process (`process_id`, text, required): The UUID of the image processing job.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "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

Get an image output link.

**Inputs**

- Process (`process_id`, text, required): The UUID of the image processing job.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "data": {
    "download_url": "example",
    "expiry": 1,
    "head_url": "example"
  }
}
```

### Get video job metrics

Get video job metrics.

**Inputs**

- Request (`request_id`, text, required): Request ID.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "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**

- Request (`request_id`, text, required): Request ID.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "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**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "data": {
    "availabilityMessage": "example",
    "isAvailable": true,
    "isFrameInterpolationSupported": true,
    "supportedModels": [
      "example"
    ]
  }
}
```

### List image jobs

List image jobs.

**Inputs**

- Limit (`limit`, number): Number of results per page when pagination is enabled. Ignored if `paginated=false`. Defaults to 50, maximum is 100. From 1 to 100.
- Cursor (`cursor`, text): Cursor for pagination. Use the `next_cursor` value from the previous response to retrieve the next page. Ignored if `paginated=false`.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "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**

- Cursor (`cursor`, text): Base64url-encoded cursor for pagination. Use the `nextCursor` value from a previous response to fetch the next page.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "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 URL (`source_url`, text): Source URL.
- Source ID (`source_id`, text): Source ID.
- Model (`model`, text, required): Model. One of: `Object`.
- Output format (`output_format`, text): Output format. One of: `jpeg`, `png`, `tiff`, `webp`.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "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 URL (`source_url`, text): Source URL.
- Source ID (`source_id`, text): Source ID.
- Model (`model`, text, required): Model. One of: `Dust-Scratch`, `Dust-Scratch V2`.
- Output format (`output_format`, text): Output format. One of: `jpeg`, `png`, `tiff`, `webp`.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "data": {
    "eta": 1,
    "process_id": "example",
    "source_id": "example"
  }
}
```

### Sharpen an image

Sharpen an image.

**Inputs**

- Source URL (`source_url`, text): Source URL.
- Source ID (`source_id`, text): Source ID.
- Model (`model`, text, required): Model. One of: `Standard`, `Strong`, `Lens Blur`, `Lens Blur V2`, `Motion Blur`, `Natural`, `Refocus`, `Wildlife`, `Portrait`.
- Output format (`output_format`, text): Output format. One of: `jpeg`, `png`, `tiff`, `webp`.

**Outputs**

- `data` (object): The response from Topaz Labs.

**Example output**

```json
{
  "data": {
    "eta": 1,
    "process_id": "example",
    "source_id": "example"
  }
}
```
