Provide an image for blurring

post

https://blurring.conxai.ai/api/v1/image

Provide an image and specify parameters for blurring.
The API blurs the specified image based on the provided parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Image blurring parameters

cameraId

string

Camera ID of the image. If an existing conxai camera ID is provided we will use the settings of that camera. Settings inside the request will override the camera settings.

classes

array of strings

List of classes to be blurred (if empty the default is person)

classes

color

string

Color of the blurring mask if fill is selected. Needs to be a valid hex color code (e.g. #000000). Defaults to #000000. If blur is selected this parameter has to be excluded.

exclusionZones

array of arrays of arrays of float64s

List of zones and their pixel-coordinates that should always be masked. Format needs to be [[[x1,y1],[x2,y2],...],...] where x and y are pixel coordinates for each point of the polygon exclusion zone.

exclusionZones

image

string

required

URL or Base64 encoded Image. If a URL is provided it needs to be either public or the credentials need to be embedded in the provided link. Allowed MimeTypes are jpeg and png.

maskShape

string

enum

Defaults to contour

Type of mask to be applied for blurring (defaults to blur)

Allowed:

maskType

string

enum

Defaults to blur

Allowed:

opacity

number

0 to 1

Defaults to 0.5

Opacity of the masking effect (0.0 - 1.0)

projectId

string

required

Project ID of the image. If an existing conxai project ID is provided we will use the settings of that project. Settings inside the request will override the project settings.

timeStamp

string

RFC3339 Timestamp of the image. If not supplied we will try to extract it from the image metadata or use the current time.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created

400Bad Request