API Documentation

Everything you need to know to integrate Blurit API Calls

Authenticate to the API

post

Authenticate to the API using your client credentials. Returns a token needed for all other routes.

Body

application/json

clientIdstringRequired

Client Id available in the Developer Account section

Example: client_123456789

secretIdstringRequired

Secret ID available in the Developer Account section

Example: secret_987654321

Responses

200

Successfully authenticated

application/json

400

Bad Request - Invalid parameters

application/json

401

Invalid credentials

application/json

post

/login

HTTPcURLJavaScriptPython

POST /login HTTP/1.1
Host: api.services.wassa.io
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "clientId": "client_123456789",
  "secretId": "secret_987654321"
}

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "rt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expireTime": 3600
}

Refresh access token

post

Refresh an expired access token using the refresh token. The Bearer token can be expired.

Authorizations

bearerAuth

AuthorizationstringRequired

JWT token needed for all other routes. The token acquired with the login route.

Body

application/json

refreshTokenstringRequired

Refresh token received from login

Example: rt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Responses

200

Token successfully refreshed

application/json

400

Bad Request - Invalid parameters

application/json

401

Unauthorized - Invalid token

application/json

403

Forbidden - Insufficient permissions

application/json

post

/token

HTTPcURLJavaScriptPython

POST /token HTTP/1.1
Host: api.services.wassa.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "refreshToken": "rt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "refreshToken": "rt_eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expireTime": 3600
}

Get anonymization job status

get

Check the status of an anonymization job.

Authorizations

bearerAuth

AuthorizationstringRequired

JWT token needed for all other routes. The token acquired with the login route.

Query parameters

anonymization_job_idstringRequired

Job ID received from POST request

Example: client_uuid-SRV_ANONYMIZATION-abc123def456

Responses

200

Job status

application/json

400

Bad Request - Invalid job ID

application/json

401

Unauthorized - Invalid token

application/json

403

Forbidden - Insufficient permissions

application/json

get

/innovation-service/anonymization

HTTPcURLJavaScriptPython

GET /innovation-service/anonymization?anonymization_job_id=client_uuid-SRV_ANONYMIZATION-abc123def456 HTTP/1.1
Host: api.services.wassa.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "Succeeded",
  "output_media": "https://api.services.wassa.io/innovation-service/result/b83603c4-b9c7-4e86-9fe4-a2eeba2dfa06.jpeg",
  "output_json": "https://api.services.wassa.io/innovation-service/result/b83603c4-b9c7-4e86-9fe4-a2eeba2dfa06.json",
  "error": "Error message"
}

Start an anonymization job

post

This route will create a job for anonymizing faces and/or license plates in images or videos. The process is asynchronous and will return a job ID that can be used to check the status.

Note: For a basic request, only the input_media field is required. All other form fields should be disabled in the test interface.

Authorizations

bearerAuth

AuthorizationstringRequired

JWT token needed for all other routes. The token acquired with the login route.

Body

multipart/form-data

input_mediastring · binaryRequired

Image or video file to process. Accepted formats are JPEG, JPG, PNG, WEBP, BMP, TIFF, MP4, AVI, MOV, MKV, ZIP.

activation_faces_blurbooleanOptional

Enable face detection and blurring

Example: true

activation_plates_blurbooleanOptional

Enable license plate detection and blurring

Example: true

output_detections_urlbooleanOptional

Return URLs to download detection coordinates in JSON format

Example: true

Responses

200

Job successfully created

application/json

400

Bad Request - Invalid parameters

application/json

401

Unauthorized - Invalid token

application/json

402

Payment Required

application/json

403

Forbidden - Insufficient permissions

application/json

413

Payload Too Large

application/json

post

/innovation-service/anonymization

HTTPcURLJavaScriptPython

POST /innovation-service/anonymization HTTP/1.1
Host: api.services.wassa.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 286

{
  "input_media": "binary",
  "activation_faces_blur": true,
  "activation_plates_blur": true,
  "output_detections_url": true,
  "included_area": {
    "top": 0.05,
    "bottom": 0.95,
    "left": 0.05,
    "right": 0.95
  },
  "blur_type": {
    "anonymization_type": "blur_double",
    "smooth_padding": null,
    "hex_color": null,
    "num_pixels": null
  }
}

{
  "anonymization_job_id": "client_uuid-SRV_ANONYMIZATION-abc123def456"
}

Get result file

get

Download result file from BlurIt anonymization service.

Authorizations

bearerAuth

AuthorizationstringRequired

JWT token needed for all other routes. The token acquired with the login route.

Path parameters

fileNamestringRequired

File name received in output_media

Example: b83603c4-b9c7-4e86-9fe4-a2eeba2dfa06.jpeg

Responses

200

File content

application/octet-stream

Responsestring · binary

400

Bad Request - Invalid filename

application/json

401

Unauthorized - Invalid token

application/json

403

Forbidden - Insufficient permissions

application/json

get

/innovation-service/result/{fileName}

HTTPcURLJavaScriptPython

GET /innovation-service/result/{fileName} HTTP/1.1
Host: api.services.wassa.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary