Estimate
Our estimates will allow you to predict the amount of time required and the number of credits that would be consumed in order to run a set of enhancements on a given image with certain input parameters.
Validates the request against our standard models and returns the estimated time taken to complete a given processing job and the credits that would be consumed for that job.
Authentication via the Topaz generated key in the X-API-Key header.
Indicates which category of model is being used.
EnhancePossible values: The model to use for processing the image.
Standard V2Possible values: The height of the input image in pixels.
1080The width of the input image in pixels.
1920The 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.
1080The 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.
1920Default behavior is to letterbox the image if a differing aspect ratio is chosen. Enable crop_to_fill by setting this to true if you instead want to crop the image to fill the dimensions.
falseThe desired format of the output image.
jpegPossible values: Additional key-value pairs to be used as model settings. Only pairs relevant for your chosen model are used. Please see the available models for more details.
The estimated time taken in seconds and the credits that would be consumed on process.
The request contains malformed data in the body, path, or query parameters.
Authentication is required and has failed or has not yet been provided.
The API key doesn't have permissions to perform the request.
Too many requests hit the API too quickly. A backoff (e.g. exponential) is recommended for your requests.
Unexpected error on our end.
Validates the request against our generative models and returns the estimated time taken to complete a given processing job and the credits that would be consumed for that job.
Authentication via the Topaz generated key in the X-API-Key header.
Indicates which category of model is being used.
EnhancePossible values: The model to use for processing the image.
RedefinePossible values: The height of the input image in pixels.
1080The width of the input image in pixels.
1920The 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.
1080The 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.
1920Default behavior is to letterbox the image if a differing aspect ratio is chosen. Enable crop_to_fill by setting this to true if you instead want to crop the image to fill the dimensions.
falseThe desired format of the output image.
jpegPossible values: Additional key-value pairs to be used as model settings. Only pairs relevant for your chosen model are used. Please see the available models for more details.
The estimated time taken in seconds.
The request contains malformed data in the body, path, or query parameters.
Authentication is required and has failed or has not yet been provided.
The API key doesn't have permissions to perform the request.
Too many requests hit the API too quickly. A backoff (e.g. exponential) is recommended for your requests.
Unexpected error on our end.
Validates a list of requests and returns the estimated time taken to complete a given processing job and the credits that would be consumed for each job.
Authentication via the Topaz generated key in the X-API-Key header.
Indicates which category of model is being used.
EnhancePossible values: The model to use for processing the image.
Standard V2Possible values: The height of the input image in pixels.
1080The width of the input image in pixels.
1920The 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.
1080The 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.
1920Default behavior is to letterbox the image if a differing aspect ratio is chosen. Enable crop_to_fill by setting this to true if you instead want to crop the image to fill the dimensions.
falseThe desired format of the output image.
jpegPossible values: Additional key-value pairs to be used as model settings. Only pairs relevant for your chosen model are used. Please see the available models for more details.
The estimated time taken in seconds and the credits that would be consumed on process.
The request contains malformed data in the body, path, or query parameters.
Authentication is required and has failed or has not yet been provided.
The API key doesn't have permissions to perform the request.
Too many requests hit the API too quickly. A backoff (e.g. exponential) is recommended for your requests.
Unexpected error on our end.
Last updated