API docs by Redocly

Deep Image (1)

Download OpenAPI specification:Download

Schedules a job to perform selected enhancement options and waits for the result.

It's convenient method that returns the url to the result immediately if the processing time is less than 25 seconds. Otherwise it will return a job hash and the result will be available via "result" method.

Authorizations:
ApiKeyAuth
Request Body schema:
required
url
string (ImageUrl)

Image url, Base64 encoded image or storage url (storage://{storage_name}/{?path})

target
string (StorageUrl)
integer or string (Width)
  • string f.e. - "200%" - it will upscale image by factor 2.
  • integer f.e. - 200 - it will upscale/downscale image to have width 200 pixels. If the height is not given it will be calculated to match image ratio.
Find more info here
integer or string (Height)
  • string f.e. - "200%" - it will upscale image by factor 2.
  • integer f.e. - 200 - it will upscale/downscale image to have height 200 pixels. If the width is not given it will be calculated to match image ratio.
Find more info here
min_length
integer (MinLength)

Integer f.e. - 200 - it will upscale/downscale image to have minimum 200 pixels width or height. That will also be applied to identified item/content when removing background.

Find more info here
integer or string (Padding)

When margin is needed, parameter padding can be used for that. It can be specified either in pixels or in percentages.

Find more info here
FitTypes (string) or object (FitType)
Default: "canvas"
  • canvas - Whole image is placed into width x height canvas, missing space is filled with background color.
  • crop - Image is cropped to match destination width x height canvas. Crop is content aware by default. It can be changed to be on center as well.
  • bounds - Image is upscaled to fit specified width x height.
  • cover - Image is upscaled to fully cover specified width x height.
Find more info here
enhancements
Array of strings (EnhancementTypes)
Items Enum: "denoise" "deblur" "clean" "face_enhance" "light" "color" "white_balance" "exposure_correction"
object (BackgroundParameters)
CustomPreset (string) or PresetTypes (string) (Preset)
Find more info here
output_format
string (OutputFormat)
Enum: "jpeg" "jpg" "png" "webp"

The format of the output image.

Find more info here
max_file_size
string (MaxFileSize)

Integer or string value with maximum file size. It supports "kb", "mb" and "gb" units. It is used with output_format equals jpeg or webp. When specified, Deep Image API tries to match highest possible jpeg quality and specified max_file_size.

Find more info here
quality
integer (Quality) [ 0 .. 100 ]
Default: 85

Integer value for the level of jpeg or webp compression.

Find more info here
dpi
integer (Dpi)
Default: 300

To use the dpi effectively, the print_size needs to be sent along with it.

print_size
string (PrintSize)
Enum: "a0" "a1" "a2" "a3" "a4" "a5" "a6" "a7" "a8" "a9" "a10" "b0" "b1" "b2" "b3" "b4" "b5" "b6" "b7" "b8" "b9" "b10" "a2extra" "a3extra" "a3super" "supera3" "a4extra" "a4super" "supera4" "a4long" "a5extra" "sob5extra" "letter" "legal" "executive" "tabloid" "statement" "halfletter" "folio" "flsa" "flse" "note" "11x17" "10x14" "c0" "c1" "c2" "c3" "c4" "c5" "c6" "c7" "c8" "c9" "c10" "juniorlegal" "memo" "governmentletter" "governmentlegal" "ledger" "arch1" "arch2" "arch3" "arch4" "arch5" "arch6" "archa" "archb" "archc" "archd" "arche1" "arche" "arche2" "arche3"

Name of the paper size format, f.e. A4, B0, letter, etc.

print_reorientation
boolean (PrintReorientation)
Default: true

true/false - swap target width and height values to match paper size orientation.

object (DenoiseParameters)

To use the denoise parameters effectively, the denoise enhancement needs to be sent along with it.

Find more info here
object (DeblurParameters)

To use the deblur parameters effectively, the deblur enhancement needs to be sent along with it.

Find more info here
object (LightParameters)

To use the light parameters effectively, the light enhancement needs to be sent along with it.

Find more info here
object (ColorParameters)

To use the color parameters effectively, the color enhancement needs to be sent along with it.

Find more info here
object (WhiteBalanceParameters)

To use the white balance parameters effectively, the white_balance enhancement needs to be sent along with it.

Find more info here

Responses

Request samples

Content type
Example
{}

Response samples

Content type
application/json
{}

Schedules a job to perform selected enhancement options.

Authorizations:
ApiKeyAuth
Request Body schema:
required
url
string (ImageUrl)

Image url, Base64 encoded image or storage url (storage://{storage_name}/{?path})

target
string (StorageUrl)
integer or string (Width)
  • string f.e. - "200%" - it will upscale image by factor 2.
  • integer f.e. - 200 - it will upscale/downscale image to have width 200 pixels. If the height is not given it will be calculated to match image ratio.
Find more info here
integer or string (Height)
  • string f.e. - "200%" - it will upscale image by factor 2.
  • integer f.e. - 200 - it will upscale/downscale image to have height 200 pixels. If the width is not given it will be calculated to match image ratio.
Find more info here
min_length
integer (MinLength)

Integer f.e. - 200 - it will upscale/downscale image to have minimum 200 pixels width or height. That will also be applied to identified item/content when removing background.

Find more info here
integer or string (Padding)

When margin is needed, parameter padding can be used for that. It can be specified either in pixels or in percentages.

Find more info here
FitTypes (string) or object (FitType)
Default: "canvas"
  • canvas - Whole image is placed into width x height canvas, missing space is filled with background color.
  • crop - Image is cropped to match destination width x height canvas. Crop is content aware by default. It can be changed to be on center as well.
  • bounds - Image is upscaled to fit specified width x height.
  • cover - Image is upscaled to fully cover specified width x height.
Find more info here
enhancements
Array of strings (EnhancementTypes)
Items Enum: "denoise" "deblur" "clean" "face_enhance" "light" "color" "white_balance" "exposure_correction"
object (BackgroundParameters)
CustomPreset (string) or PresetTypes (string) (Preset)
Find more info here
output_format
string (OutputFormat)
Enum: "jpeg" "jpg" "png" "webp"

The format of the output image.

Find more info here
max_file_size
string (MaxFileSize)

Integer or string value with maximum file size. It supports "kb", "mb" and "gb" units. It is used with output_format equals jpeg or webp. When specified, Deep Image API tries to match highest possible jpeg quality and specified max_file_size.

Find more info here
quality
integer (Quality) [ 0 .. 100 ]
Default: 85

Integer value for the level of jpeg or webp compression.

Find more info here
dpi
integer (Dpi)
Default: 300

To use the dpi effectively, the print_size needs to be sent along with it.

print_size
string (PrintSize)
Enum: "a0" "a1" "a2" "a3" "a4" "a5" "a6" "a7" "a8" "a9" "a10" "b0" "b1" "b2" "b3" "b4" "b5" "b6" "b7" "b8" "b9" "b10" "a2extra" "a3extra" "a3super" "supera3" "a4extra" "a4super" "supera4" "a4long" "a5extra" "sob5extra" "letter" "legal" "executive" "tabloid" "statement" "halfletter" "folio" "flsa" "flse" "note" "11x17" "10x14" "c0" "c1" "c2" "c3" "c4" "c5" "c6" "c7" "c8" "c9" "c10" "juniorlegal" "memo" "governmentletter" "governmentlegal" "ledger" "arch1" "arch2" "arch3" "arch4" "arch5" "arch6" "archa" "archb" "archc" "archd" "arche1" "arche" "arche2" "arche3"

Name of the paper size format, f.e. A4, B0, letter, etc.

print_reorientation
boolean (PrintReorientation)
Default: true

true/false - swap target width and height values to match paper size orientation.

object (DenoiseParameters)

To use the denoise parameters effectively, the denoise enhancement needs to be sent along with it.

Find more info here
object (DeblurParameters)

To use the deblur parameters effectively, the deblur enhancement needs to be sent along with it.

Find more info here
object (LightParameters)

To use the light parameters effectively, the light enhancement needs to be sent along with it.

Find more info here
object (ColorParameters)

To use the color parameters effectively, the color enhancement needs to be sent along with it.

Find more info here
object (WhiteBalanceParameters)

To use the white balance parameters effectively, the white_balance enhancement needs to be sent along with it.

Find more info here

Responses

Request samples

Content type
Example
{}

Response samples

Content type
application/json
{}

Returns processing job result.

Authorizations:
ApiKeyAuth
path Parameters
hash
required
string

Responses

Response samples

Content type
application/json
{}

Deletes completed job.

Authorizations:
ApiKeyAuth
path Parameters
hash
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "Images of job xxx has been removed."
}

Retrieves authenticated user's profile information.

Returns account details including credits, username, email, API key, language preference, webhook settings, and billing address.

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "credits": 3872,
  • "username": "John Doe",
  • "email": "johndoe@gmail.com",
  • "api_key": "xxxx",
  • "language": "en",
  • "webhooks": { },
  • "address": {
    }
}