API methods

The API address is https://deep-image.ai/rest_api/

There are two methods for the scheduling image processing and one for retrieving the results. With "process_result" method, image can be processed and if the result is available during 25 seconds, the url to the result will be returned. The second method - "process" - always schedules a processing job and the user has to wait for the result with "result" method.

Processing methods supports both form-data and json content types.

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

Authorization

Header parameters

Body

urlstring (uri)

The URL of the input image

Example: "https://deep-image.ai/api-example.png"

backgroundobject

Settings for background removal

widthinteger

The desired width of the output image

Example: 300

heightinteger

The desired height of the output image

Example: "400%"

enhancementsarray of enum

The list of enhancements to apply to the image

light_parametersobject

Settings for the light enhancement

color_parametersobject

Settings for the color enhancement

white_balance_parametersobject

Settings for the white balance enhancement

output_formatenum

The desired output format of the image

jpegpngwebp

captionobject

Settings for adding a caption to the image

fitobject

Settings for fitting the input image into the output image

qualityinteger

The desired output image quality

Example: 85

max_file_sizestring

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

Example: "10MB"

Response

Job processed successfuly

Body

statusstring

Example: "complete"

jobstring

Example: "44d46e9a-c3d5-11ed-af64-0242ac1f000f"

result_urlstring

Example: "https://deep-image.ai/images/2023-03-16/2c29a22b-8ebd-461a-89b0-5feb3a33e2b1.jpg"

Request

Response

Schedules image processing job

POST/rest_api/process

Authorization

Header parameters

Body

urlstring (uri)

The URL of the input image

Example: "https://deep-image.ai/api-example.png"

backgroundobject

Settings for background removal

widthinteger

The desired width of the output image

Example: 300

heightinteger

The desired height of the output image

Example: "400%"

enhancementsarray of enum

The list of enhancements to apply to the image

light_parametersobject

Settings for the light enhancement

color_parametersobject

Settings for the color enhancement

white_balance_parametersobject

Settings for the white balance enhancement

output_formatenum

The desired output format of the image

jpegpngwebp

captionobject

Settings for adding a caption to the image

fitobject

Settings for fitting the input image into the output image

qualityinteger

The desired output image quality

Example: 85

max_file_sizestring

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

Example: "10MB"

Response

Job scheduled successfuly

Body

jobstring

Example: "44d46e9a-c3d5-11ed-af64-0242ac1f000f"

Request

const response = await fetch('/rest_api/process', {
    method: 'POST',
    headers: {
      "X-API-KEY": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "https://deep-image.ai/api-example.png",
      "background": {
        "remove": "auto",
        "color": "#FFFFFF"
      },
      "width": 300,
      "height": 300,
      "enhancements": [
        "denoise",
        "light",
        "color"
      ],
      "light_parameters": {
        "type": "hdr_light_advanced",
        "level": 0.8
      },
      "color_parameters": {
        "type": "hdr_light_advanced",
        "level": 0.5
      },
      "output_format": "jpg",
      "caption": {
        "url": "http://ain.teonite.net/neuroapi-store/2023-02-07/d9a91e2e-9843-4d85-ae1a-e7baefc87746.png",
        "position": "RB",
        "target_width_percentage": 25,
        "padding": 20,
        "opacity": 85
      }
    }),
});
const data = await response.json();

Response

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

Retrieves authenticated user's profile information.

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

GEThttps://deep-image.ai/rest_api/me

Response

Successful retrieval of user account details.

Body

creditsinteger

Example: 3872

usernamestring

Example: "John Doe"

emailstring

Example: "johndoe@gmail.com"

api_keystring

Example: "xxxx"

languagestring

Example: "en"

webhooksobject

addressobject

Request

const response = await fetch('https://deep-image.ai/rest_api/me', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "credits": 3872,
  "username": "John Doe",
  "email": "johndoe@gmail.com",
  "api_key": "xxxx",
  "language": "en",
  "webhooks": {},
  "address": {
    "tax": 277021597,
    "companyName": "test",
    "streetAddress": "test",
    "city": "test",
    "postalCode": 55555,
    "country": "DE",
    "countryName": "Germany",
    "isCompany": true
  }
}

Returns processing job result.

GEThttps://deep-image.ai/rest_api/result/{hash}

Path parameters

hash*string

Response

Returns processing result

Body

statusenum

receivednot_startedin_progresscomplete

result_urlstring

job*string

Request

const response = await fetch('https://deep-image.ai/rest_api/result/{hash}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "status": "complete",
  "result_url": "https://neuroapi-store.s3.eu-central-1.amazonaws.com/2024-03-07/d894c96a-0dda-46cd-9197-10c596f7e27c.jpg",
  "job": "a8784c00-dc6b-11ee-ad50-9ec3ba0205c0"
}

Deletes completed job.

DELETEhttps://deep-image.ai/rest_api/result/{hash}

Path parameters

hash*string

Response

Delete result information

Body

messagestring

Request

const response = await fetch('https://deep-image.ai/rest_api/result/{hash}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "message": "Images of job xxx has been removed."
}

When processing is in progress, the result endpoint should be periodically checked for the complete status.

PreviousQuick Start NextHandling Large File Sets

Last updated 4 days ago

const response = await fetch('/rest_api/process', { method: 'POST', headers: { "X-API-KEY": "text", "Content-Type": "application/json" }, body: JSON.stringify({ "url": "https://deep-image.ai/api-example.png", "background": { "remove": "auto", "color": "#FFFFFF" }, "width": 300, "height": 300, "enhancements": [ "denoise", "light", "color" ], "light_parameters": { "type": "hdr_light_advanced", "level": 0.8 }, "color_parameters": { "type": "hdr_light_advanced", "level": 0.5 }, "output_format": "jpg", "caption": { "url": "http://ain.teonite.net/neuroapi-store/2023-02-07/d9a91e2e-9843-4d85-ae1a-e7baefc87746.png", "position": "RB", "target_width_percentage": 25, "padding": 20, "opacity": 85 } }), }); const data = await response.json();