v1 API Endpoints (deprecated)
Overview
API URL: https://api.celantur.com/v1/
Celantur Cloud API supports only images at the moment. Support for videos will be added soon.
Upload image
POST
https://api.celantur.com/v1/file
Upload image that is processed with the specified method.
The payload is limited to 4.45 MB. This limitation will be removed in the upcoming weeks.
Query Parameters
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
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
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.
bbox
Boolean
Anonymize bounding boxes of objects (instead of segmentation).
ignores
String
Specifies pixel coordinates of areas on the image in which no anonymization will be applied (as JSON).
Example:
[{"topLeftX":182, "topLeftY":154,
"width":2000,
"height":2000}]
mask-scale
Number
Specifies the ratio at which the mask file will be scaled down, range between 0 .. 100
.
Default: 100
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
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
webhook
String
A webhook URL to which a POST request is sent to after successful processing.
kernel-size-face
Number
Default: 0.35
kernel-size-person
Number
Default: 95
kernel-size-license-plate
Number
Default: 0.5
kernel-size-vehicle
Number
Default: 61
face-anonymization-gradient-start
Number
Default: 0.3
face-anonymization-gradient-stop
Number
Default: 0.0
license-plate-anonymization-gradient-start
Number
Default: 0.3
license-plate-anonymization-gradient-stop
Number
Default: 0.0
Headers
Authorization*
String
Authorization token
Content-Type*
String
"image/jpeg" or "image/png"
Request Body
-*
object
The image.
Payload is limited to 10 MB.
Response body JSON containing file information and parameters:
Correctly encode strings for query parameters
When setting format, ignores and webhook values, strings must be encoded.
See further string encoding examples in Java, C#, JavaScript and cUrl.
Get file status
GET
https://api.celantur.com/v1/file/{id}/status
Path Parameters
id*
String
id of the file
Headers
Authorization
String
Authorization
Get anonymized file
GET
https://api.celantur.com/v1/file/{id}/anonymized
Path Parameters
id*
String
id of the file
Headers
Authorization*
String
Authorization token
Get image binary segmentation mask
GET
https://api.celantur.com/v1/file/{id}/binary-mask
Path Parameters
id*
String
id of the file
Headers
Authorization*
String
Authorization token
Get image instance segmentation mask
GET
https://api.celantur.com/v1/file/{id}/instance-mask
Path Parameters
id*
String
id of the file
Headers
Authorization*
String
Authorization token
Get metadata
GET
https://api.celantur.com/v1/file/{id}/metadata
Returns metadata (detected objects) in JSON format
Query Parameters
id*
String
id of the file
Get original file
GET
https://api.celantur.com/v1/file/{id}/original
Path Parameters
id*
String
id of the file
Headers
Authorization*
String
Authorization token
List files
GET
https://api.celantur.com/v1/list
Returns a paginated JSON list of all files ('items' in this context) a user has sent.
The JSON result contains information about the total item count and respective total page count depending on the specified limit
.
E.g.: {'total_item_count': 46, 'total_page_count': 10, 'items': [...]}
The total page calculation: total item count / limit = total page count
Query Parameters
page*
Number
The page which will be queried
limit*
Number
The number of items per page
Headers
Authorization*
String
Authorization token
Sign in (authorization)
POST
https://api.celantur.com/v1/signin
Provide username/password as JSON payload to receive authorization token.
{ "username": "username@usermail.com", "password": "password" }
Request Body
json*
String
Credentials
Last updated