REST API (v1) mode
REST API mode for Celantur Container
Overview
You can start the Celantur Container in API mode and use the REST API to anonymize images and videos. There are two ways to process images and videos, via synchronous and asynchronous uploads.
When you upload files via synchronous upload, which is the default configuration, it takes some time for you to get the response. You can then immediately download the result.
When you upload files via the asynchronous upload, by adding the header parameter x-is-async: true
(and optionally a webhook via the query parameter), you'll immediately receive the response, but the processing is not necessarily finished. If you added a webhook, you'll be notified once processing is finished. Otherwise, you can query the GET /task/{id}
to check whether the processing is finished. See more information below.
Start the Container in REST API mode
Start the server with all object types (-a face -a license-plate -a person -a vehicle
) that you want to anonymize by using the API. You can select specific objects for individual images using API calls.
Video processing
For video processing, use the object detection model (--model object-detection-v2
) for faster processing speed. Currently, it only supports face and license plate blurring.
Task and files
There are two classes of endpoints:
/file
endpoints where you can upload and download files. When you upload a file withPOST /file
you will receive a JSON response including{ "id": "string", ... }
. You can use the id to query the status of processing viaGET /task/{id}
endpoint./task
endpoints where you can query the status of file processing and manage the tasks, especially important for asynchronous processing. For processing, the files are stored internally in the folders specified by the user with the--input
and--output
parameters. Currently, you need to manage the storage manually by deleting the files associated with a task with theDELETE /task/{id}
to free up stsorage.
Metadata, binary and instance segmentation masks are not yet supported for videos.
Webhook
If you specify a webhook URL in POST /file
with the query parameter webhook
(urlencoded). You can specify header authentication with web-auth-header-name
and web-auth-header-value
.
After the file has been processed, the Container will post a request to the he webhook URL with the following header and body (example):
Sychronous processing
Upload image with POST request Upload file. Processing is ready once the request returns with a successful response.
Download image with GET request Download anonymized image
Download segmentation masks and metadata:
GET request Download binary mask
GET request Download instance mask
GET request Download image metadata (JSON)
Asynchronous processing
Upload image with POST request Upload file with the header parameter
x-is-async: true
. Request returns immediately with a response. However processing runs asynchronously and is not necessary complete.Wait until processing is done.
Webhook: If you added webhook, you'll receive notification, once the processing is complete.
Otherwise query the task status with List all processing tasks
Download the assets as in #aynchronous-processing.
Delete the task with Delete a specific task
In asynchronous mode, you need to pay attention to the storage management. So delete all tasks including files that you have downloaded and are not required anymore. You can delete single tasks DELETE /tast/{id}
or all tasks DELETE /task/lists
.
Image and video anonymization
Upload file
POST
https://localhost/v1/file
Upload a file that is processed with the specified method. The container only holds data for one image at any time. A new POST request overwrites the old data.
Query Parameters
method*
String
Enum: blur
, pixelate
, blacken
, detect
Default: blur
Specifies processing method.
Method detect
only returns segmentation and binary masks, not an anonymized image.
debug
Boolean
Print bounding boxes and segmentation masks of detected objects on the image.
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)
format
String
Default: "whole"
Example: format={"number": [2,2], "overlap": [0, 0]}
Tiling of the input image
ignores
String
Default: ""Example: ignores=[{"topLeftX": 182,"topLeftY": 154,"width":2000,"height":2000}]
Areas of the image that are not going to be anonymized
face-threshold
Number
Specifies detection threshold 0..1
for faces.
Default: 0.5
segmentation-threshold
Number
DEPRECATED
Specifies detection threshold value for segmentation.
▶ Use person-threshold
and vehicle-threshold
instead.
vehicle-threshold
Number
Specifies detection threshold 0..1
for vehicles.
Default: 0.4
person-threshold
Number
Specifies detection threshold 0..1
for persons.
Default: 0.4
license-plate-threshold
Number
Specifies detection threshold 0..1
for license plates.
Default: 0.5
no-object-tracking
Boolean
Disables object tracking in videos.
Default: False
keep-bit-rate
Boolean
Specifies whether the bitrate of the anonymized video should remain very close to the one of the original video.
Enabling keep-bit-rate
will ensure a nearly identically file size of the processed video, at the cost of 10% to 20% higher processing time.
Default: false
webhook
String
Webhook URL (urlencoded)
webhook-auth-header-name
String
Webhook header auth key/name
webhook-auth-header-value
String
Webhook header auth value
Headers
x-is-async
String
Enables async processing.
Values: true
or false
Default: false
Request Body
fileobject*
string<binary> (Fileobject)
Images:
fileobject=@/path/to/input/image;
Videos:
Specify the video type
fileobject=@/path/to/input/video;type=video/mp4
Download anonymized image
GET
https://localhost/v1/file/{id}/anonymised
Download anonymized image
Path Parameters
id*
String
The id
(UUID) of the file that will be downloaded.
Query Parameters
download
String
Enum: JPEG
or PNG
Whether the image should be downloaded as a JPEG or PNG.
quality
Number
Specifies quality level for JPEG images ranging from 1 .. 100
.
Default: 90
compress-level
Number
Specifies compression level for PNG images ranging from 0 .. 9
.
Default: 5
Download anonymized video
GET
https://localhost/v1/file/{id}/video/anonymised
Download anonymized video
Path Parameters
id
String
The id
(UUID) of the file that will be downloaded.
Media type: "video/mp4"
Download binary mask
GET
https://localhost/v1/file/{id}/binary-mask
Path Parameters
id*
String
The id
(UUID) of the file whose binary segmentation mask will be downloaded.
Query Parameters
mask-scale
Number
Specifies the ratio at which the mask file will be scaled down, range between 0 .. 100
.
Default: 100
Media type: image/png
For conceptual information on segmentation masks, see:
Download instance mask
GET
https://localhost/v1/file/{id}/instance-mask
Path Parameters
id
String
The id
(UUID) of the file whose instance segmentation mask will be downloaded.
Query Parameters
mask-scale
Number
Specifies the ratio at which the mask file will be scaled down, range between 0 .. 100
.
Default: 100
For conceptual information on segmentation masks, see:
Download image metadata (JSON)
GET
https://localhost/v1/file/{id}/metadata
Path Parameters
id*
String
The id
(UUID) of the file whose metadata will be downloaded.
Download video metadata (JSON)
GET
https://localhost/v1/file/{id}/video/metadata
Returns the metadata for the specified range of frames of the last processed video as JSON.
Consecutive frame IDs start at 0.
Path Parameters
id*
String
The id
(UUID) of the video whose metadata will be downloaded.
Query Parameters
start_frame*
Number
Specifies the first frame of the range of frames for which the metadata will be downloaded. Range: 0 .. last_frame
.
Default: 0
end_frame*
Number
Specifies the last frame of the range of frames for which the metadata will be downloaded. Range: 1 .. last_frame
.
Default: last_frame
Container and Task management
Check Celantur Container status
GET
https://localhost/v1/status
Returns health status of of Celantur Container. 200 when running, 500 when down.
List all processing tasks
GET
https://localhost/v1/task/list
Returns a list of tasks.
Delete all existing tasks
DELETE
https://localhost/v1/task/list
Delete all the tasks' records and/or input and output files.
Query Parameters
confirm
Boolean
Provide true to confirm your action.
delete-scope
String
task-and-files
to delete everything.
only-files
to delete only files, keeping the records.
Default: task-and-files
Get information about a specific task
GET
https://localhost/v1/task/{id}
Path Parameters
id*
String
Delete a specific task
DELETE
https://localhost/v1/task/{id}
Remove the record and/or input and output files of a specific task.
Path Parameters
id*
String
Query Parameters
delete-scope
String
task-and-files
to delete everything.
only-files
to delete only files, keeping the records.
Default: task-and-files
Examples
Check server status
Check the server status by sending a GET request to the #checks-celantur-container-statusendpoint:
Anonymize images
Post image to pixelate faces
Post image to blur blur whole persons and show debug information
Post method returns image id with GET request links:
Download anonymized image
Photo Credits: Omar Lopez on Unsplash
Download segmentation mask
Download instance segmentation mask
Download downscaled instance segmentation mask
Download metadata
Last updated