> For the complete documentation index, see [llms.txt](https://doc-api.blurit.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc-api.blurit.io/api-v1/using-the-api-v1/api-documentation/anonymization.md).

# Anonymization

## Get anonymization job status

> Check the status of an anonymization job.

```json
{"openapi":"3.0.1","info":{"title":"Wassa Innovation Services API","version":"1.0.0"},"servers":[{"url":"https://api.services.wassa.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token needed for all other routes. The token acquired with the login route."}},"schemas":{"Error400":{"allOf":[{"$ref":"#/components/schemas/BaseErrorResponse"}]},"BaseErrorResponse":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"code":{"type":"string","description":"Error code"}}},"Error401":{"allOf":[{"$ref":"#/components/schemas/BaseErrorResponse"}]},"Error403":{"allOf":[{"$ref":"#/components/schemas/BaseErrorResponse"}]}}},"paths":{"/innovation-service/anonymization":{"get":{"tags":["Anonymization"],"summary":"Get anonymization job status","description":"Check the status of an anonymization job.","parameters":[{"name":"anonymization_job_id","in":"query","required":true,"schema":{"type":"string","description":"Job ID received from POST request"}}],"responses":{"200":{"description":"Job status","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["Sent","Started","Succeeded","Failed"],"description":"Current status of the job"},"output_media":{"type":"string","description":"URL to download the processed media (when status is completed)"},"output_json":{"type":"string","description":"URL to download the JSON with detection coordinates (when status is completed)"},"error":{"type":"string","description":"Error message (when status is failed)"}}}}}},"400":{"description":"Bad Request - Invalid job ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400"}}}},"401":{"description":"Unauthorized - Invalid token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403"}}}}}}}}}
```

## Start an anonymization job

> 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.

```json
{"openapi":"3.0.1","info":{"title":"Wassa Innovation Services API","version":"1.0.0"},"servers":[{"url":"https://api.services.wassa.io"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token needed for all other routes. The token acquired with the login route."}},"schemas":{"Error400":{"allOf":[{"$ref":"#/components/schemas/BaseErrorResponse"}]},"BaseErrorResponse":{"type":"object","properties":{"error":{"type":"string","description":"Error message"},"code":{"type":"string","description":"Error code"}}},"Error401":{"allOf":[{"$ref":"#/components/schemas/BaseErrorResponse"}]},"Error402":{"allOf":[{"$ref":"#/components/schemas/BaseErrorResponse"}]},"Error403":{"allOf":[{"$ref":"#/components/schemas/BaseErrorResponse"}]},"Error413":{"allOf":[{"$ref":"#/components/schemas/BaseErrorResponse"}]}}},"paths":{"/innovation-service/anonymization":{"post":{"tags":["Anonymization"],"summary":"Start an anonymization job","description":"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.\n\nNote: For a basic request, only the `input_media` field is required. All other form fields should be disabled in the test interface.","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["input_media"],"properties":{"input_media":{"type":"string","format":"binary","description":"Image or video file to process. Accepted formats are JPEG, PNG, WEBP, MP4, AVI, MOV, MKV, ZIP."},"activation_faces_blur":{"type":"boolean","description":"Enable face detection and blurring"},"activation_plates_blur":{"type":"boolean","description":"Enable license plate detection and blurring"},"output_detections_url":{"type":"boolean","description":"Return URLs to download detection coordinates in JSON format"},"included_area":{"type":"object","properties":{"top":{"type":"number","minimum":0,"maximum":1},"bottom":{"type":"number","minimum":0,"maximum":1},"left":{"type":"number","minimum":0,"maximum":1},"right":{"type":"number","minimum":0,"maximum":1}},"description":"Optional area to restrict detection (normalized coordinates)"},"blur_type":{"type":"object","properties":{"anonymization_type":{"type":"string","enum":["blur","opaque","pixelate"],"description":"Type of anonymization to apply"},"smooth_padding":{"type":"number","description":"Blur intensity (only for **blur** type)","nullable":true},"hex_color":{"type":"string","description":"Color in hexadecimal (only for **opaque** type)","nullable":true},"num_pixels":{"type":"number","description":"Number of pixels (only for **pixelate** type)","nullable":true}}}}}}}},"responses":{"200":{"description":"Job successfully created","content":{"application/json":{"schema":{"type":"object","properties":{"anonymization_job_id":{"type":"string"}}}}}},"400":{"description":"Bad Request - Invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400"}}}},"401":{"description":"Unauthorized - Invalid token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error401"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error402"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error403"}}}},"413":{"description":"Payload Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error413"}}}}}}}}}
```