Getting started using the Web API

Get API credentials

First of all sign in with your Deep Art Effects account and get your API key, your access key and your secret key. Next, you have to choose one of the usage plans in order to access the API. Of course you can choose the free plan to test your implementation. You will need the credentials to authenticate to the API. You don't have to implement the authentication part if you are using one of our SDKs . If you're missing a SDK for your language, please contact us. If you are using the Web API described in this Guide, you have to set the HTTP header x-api-key for each request. Try the out the Web API at http://docs.deeparteffects.com.

Get a list of available styles

If you want to get a list of all available styles use the styles method. You will get the identifier and a URL to an image representing the specific style.

Request URL:

[GET] https://api.deeparteffects.com/v1/noauth/styles

JSON Response:

{
  "styles": [
    {
      "id": "c7984d3c-1560-11e7-afe2-06d95fe194ed",
      "title": "Abstract 1",
      "url": "https://www.deeparteffects.com/images/styles/0e915d45-83dc-47fe-9f2f-1c75e75601bd.jpg",
      "description": ""
    },
    {
      "id": "ed8e394f-1b90-11e7-afe2-06d95fe194ed",
      "title": "Colorful",
      "url": "https://www.deeparteffects.com/images/styles/d84d1c9f-51fd-4489-8824-da1ad2800f92.jpg",
      "description": ""
    },
    ...
    ]
}

Upload an image

To upload an image, set the styleId you want and transfer the image binary data converted to Base64. After uploading the image, you will get a submissionId to collect the result. You can also indicate a preferred image size with the imageSize parameter. Use the partnerId parameter if you use a dedicated server access.

Request URL:

[POST] https://api.deeparteffects.com/v1/noauth/upload

JSON Request:

{
	"styleId" : "c7984b32-1560-11e7-afe2-06d95fe194ed",
	"imageBase64Encoded" : "iVBORw0KGgoAAAANSUhEUgAAA...",
	"imageSize" : "512", //Optional
	"partnerId" : "f537a85f-e354-4554-997b-8185dffcab92", //Optional
	"optimizeForPrint": "true", //Optional
	"useOriginalColors': "false", //Optional
}

JSON Response:

{
	"submissionId" : "1ffb37d6-4d4d-4b6f-ab9d-19e6c77b1424"
}

Get the result

You can insert the submissionId to the result function in order to receive the status for your submission. If your submission is in finished state, you can use the result URL to download your artwork. The artwork will be available for an hour. After that, it will be automatically be deleted from the server. A submission can be in following states: new,processing,finished or error.

Request URL:

[GET] https://api.deeparteffects.com/v1/noauth/result?submissionId=1ffb37d6-4d4d-4b6f-ab9d-19e6c77b1424

JSON Response:

{
	"status" : "finished",
	"url" : "https://www.deeparteffects.com/images/generated/e749c695-d3dd-474b-aeeb-0790dc9275be.jpg"
}

Browse API Documentation online

Get a more detailed description of the API and its methods on http://docs.deeparteffects.com.

Use a Deep Art Effects SDK

Download one of our SDKs and get our examples. If you do so you can integrate Deep Art Effects in your application within a few minutes.