Sign in
latestOpenAPI 3.0.02026-08-102019.8 KB

9ed46fbb4479

Apply processing to one or more images

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.

post/rest_api/process_result

Headers

X-API-KEYstring required

API KEY

Request body

urlstring uri

The URL of the input image

widthinteger

The desired width of the output image

heightinteger

The desired height of the output image

enhancementsstring[]

The list of enhancements to apply to the image

output_format'jpeg' | 'png' | 'webp'

The desired output format of the image

qualityinteger

The desired output image quality

max_file_sizestring

The maximum file size of the output image for JPEG or WEBP formats

Example request

{
  "url": "https://deep-image.ai/api-example.png",
  "background": {
    "color": "#FFFFFF",
    "replace": "https://images.pexels.com/photos/628281/pexels-photo-628281.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=1"
  },
  "width": 300,
  "enhancements": [
    "deblur",
    "denoise",
    "light",
    "color"
  ],
  "light_parameters": {
    "type": "hdr_light_advanced",
    "level": 0.8
  },
  "color_parameters": {
    "type": "hdr_light_advanced",
    "level": 0.8
  },
  "white_balance_parameters": {
    "level": 0.5
  },
  "caption": {
    "url": "http://ain.teonite.net/neuroapi-store/2023-02-07/d9a91e2e-9843-4d85-ae1a-e7baefc87746.png",
    "target_width_percentage": 25,
    "padding": 20,
    "opacity": 85
  },
  "quality": 85,
  "max_file_size": "10MB"
}

Response

Job processed successfuly

statusstring
jobstring
result_urlstring

Example response

{
  "status": "complete",
  "job": "44d46e9a-c3d5-11ed-af64-0242ac1f000f",
  "result_url": "https://deep-image.ai/images/2023-03-16/2c29a22b-8ebd-461a-89b0-5feb3a33e2b1.jpg"
}