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

Authorizations

Header parameters

X-API-KEYstringrequired

API KEY

Body

multipart/form-dataapplication/json

fileNamestring · binary

Image data base-64 encoded. Currently supported file types - https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html#fully-supported-formats

parametersstring · json

json string with processing parameters - the same as they would be send with application/json request

Example: {"width": 1000, "height": 1000, "enhancements": ["light", "color"], "fit": {"crop": "center"}}

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/rest_api/process_result' \
  --header 'X-API-KEY: text' \
  --header 'Content-Type: multipart/form-data'

200

400

403

404

429

200

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

Job processed successfuly

Schedules image processing job

Schedules image processing job

post

/rest_api/process

Authorizations

Header parameters

X-API-KEYstringrequired

API KEY

Body

multipart/form-dataapplication/json

fileNamestring · binary

Image data base-64 encoded. Currently supported file types - https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html#fully-supported-formats

parametersstring · json

json string with processing parameters - the same as they would be send with application/json request

Example: {"width": 1000, "height": 1000, "enhancements": ["light", "color"], "fit": {"crop": "center"}}

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/rest_api/process' \
  --header 'X-API-KEY: text' \
  --header 'Content-Type: multipart/form-data'

200

400

403

404

429

200

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

Job scheduled successfuly

Retrieves authenticated user's profile information.

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

get

/rest_api/me

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://deep-image.ai/rest_api/me' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

200

{
  "credits": 3872,
  "username": "John Doe",
  "email": "[e-mail]",
  "api_key": "xxxx",
  "language": "en",
  "webhooks": {},
  "address": {
    "tax": 277021597,
    "companyName": "test",
    "streetAddress": "test",
    "city": "test",
    "postalCode": 55555,
    "country": "DE",
    "countryName": "Germany",
    "isCompany": true
  }
}

Successful retrieval of user account details.

Returns processing job result.

get

/rest_api/result/{hash}

Authorizations

Path parameters

hashstringrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://deep-image.ai/rest_api/result/{hash}' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

404

500

5XX

200

{
  "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"
}

Returns processing result

Deletes completed job.

delete

/rest_api/result/{hash}

Authorizations

Path parameters

hashstringrequired

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://deep-image.ai/rest_api/result/{hash}' \
  --header 'X-API-KEY: YOUR_API_KEY'

200

404

500

5XX

200

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

Delete result information

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