Skip to content

API Documentation

Parameters
  • {configurationNameOrDecision} - Name of the confluence or decision,
  • throttling - Enables the mechanism that calculates the volume of traffic in the system and rejects the surplus request returning 429 status,
  • asynchronous/ synchronous - We return the file (synchronous) and in asynchronous we give the response when it is ready to the given URL.

Single

Synchronous

/v1​/process​/single​/{configurationNameOrDecision}
  • Use POST method with image as request body and get processed image.
Example of usage

​/v1​/process​/single​/{configurationNameOrDecision}​/details
  • Use POST method with image as request body and as response there will be url to processed image and retun special informations about photo.
Example of usage

Asynchronous

​/v1​/process​/single​/{configurationNameOrDecision}​/async
  • Single upload binary asynchronous, after successful processing the PhotoDto is sending to the provided url.
Example of usage

​/v1​/process​/single​/url​/{configurationNameOrDecision}​/async​/details
  • Single upload using url (has to return 'Content-Length' header) asynchronous, after successful processing the PhotoDto is sending to the provided url and details in which we get the mask url.
Example of usage

Multiple

Synchronous

/v1​/process​/multiple​/{configurationNameOrDecision}​/details
  • Process images from attached files. And return special data about photos.
Example of usage

/v1​/process​/multiple​/urls​/{configurationNameOrDecision}​/details
  • Process images from provided urls (has to return 'Content-Length' header).
Example of usage

Asynchronous

​/v1​/process​/multiple​/urls​/{configurationNameOrDecision}​/async​/details
  • Multiple images body asynchronous, after successful processing the list of PhotoDto is sending to the provided url.
Example of usage