API Endpoints

Overview
API URL: https://api.celantur.com/v1/
Celantur Cloud API supports only images at the moment. Support for videos will be added soon.
post
https://api.celantur.com/v1
/file
Upload image
Upload image that is processed with the specified method.
The payload is limited to 10 MB.
Parameters
Query
method*
String
Specifies anonymization method:
blur, pixelate, blacken, detect
​
detect generates only binary and instance segmentation masks and metadata. No anonymized image will be generated.
​
Default: blur
face
Boolean
Specifies whether faces should be anonymized/detected.
license-plate
Boolean
Specifies whether license plates should be anonymized/detected.
person
Boolean
Specifies whether persons should be anonymized/detected.
vehicle
Boolean
Specifies whether vehicles should be anonymized/detected.
ignores
String
Specifies pixel coordinates of areas on the image in which no anonymization will be applied.
​
Example:
[{"topLeftX":182, "topLeftY":154,
"width":2000,
"height":2000}]
save_mask
String
Specifies whether only mask files should be generated. This speeds up processing time by not creating an anonymized image:
​
all, binary, instance
​
detect generates only binary and instance segmentation masks and metadata. No anonymized image will be generated.
​
Default: all
mask_scale
Number
Specifies the ratio at which the mask file will be scaled down, range between 0 .. 100.
​
Default: 100
webhook
String
A webhook URL to which a POST request is sent to after successful processing. 
The URL must be encoded.
​
More details here: Webhooks​
quality
Number
Specifies image quality of anonymized images in JPEG format: 0 .. 100
​
Default: 90
compress_level
Number
Specifies image compression level of anonymized images in PNG format.
​
Default: 5
bbox
Boolean
Anonymize bounding boxes of objects (instead of segmentation).
debug
Boolean
Print bounding boxes and segmentation masks of detected objects on the image.
​
Default: false
score
Boolean
Print the detection scores of objects on the image. Works only if debug is true
Header
Authorization*
String
Authorization token
Body
-*
object
The image.

Payload is limited to 10 MB.
Responses
200: OK
Response body with JSON 
get
https://api.celantur.com/v1
/file/{id}/status
Get file status
Parameters
Path
id*
String
id of the file
Header
Authorization
String
Authorization
Responses
200: OK
File status as JSON
get
https://api.celantur.com/v1
/file/{id}/anonymized
Get anonymized file
Parameters
Path
id*
String
id of the file
Header
Authorization*
String
Authorization token
Responses
200: OK
File
get
https://api.celantur.com/v1
/file/{id}/binary-mask
Get image binary segmentation mask
Parameters
Path
id*
String
id of the file
Header
Authorization*
String
Authorization token
Responses
200: OK
Binary segmentation mask
get
https://api.celantur.com/v1
/file/{id}/instance-mask
Get image instance segmentation mask
Parameters
Path
id*
String
id of the file
Header
Authorization*
String
Authorization token
Responses
200: OK
Instance segmentation mask
get
https://api.celantur.com/v1
/file/{id}/original
Get original file
Parameters
Path
id*
String
id of the file
Header
Authorization*
String
Authorization token
Responses
200: OK
Original image
get
https://api.celantur.com/v1
List files
Returns a list of all files a user has POSTed.
Parameters
Query
page*
Number
​
Header
Authorization*
String
Authorization token
Responses
200: OK
List of all files by page
post
https://api.celantur.com/v1
/signin
Sign in (authorization)
Provide username/password as JSON payload to receive authorization token. 
{ "username": "[email protected]", "password": "password" }
Parameters
Body
json*
String
Credentials
Responses
200: OK
Authentication result

Last modified 11d ago