Sign in
latestOpenAPI 3.0.02026-08-102019.8 KB

9ed46fbb4479

Schedules image processing job

Schedules image processing job

post/rest_api/process

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 scheduled successfuly

jobstring

Example response

{
  "job": "44d46e9a-c3d5-11ed-af64-0242ac1f000f"
}