About this endpoint
What it does
Removes masked areas from an uploaded image by taking a source image and a black/white mask image, then returning the processed image as binary output.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| method | String | No | Inpainting method. Allowed values: telea, ns. Default: telea. |
| radius | Integer | No | Radius used by the inpainting algorithm. Minimum: 1, maximum: 25. Default: 5. |
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| file | String | Yes | Source image. Binary file upload. Max size: 20 MB. |
| mask | String | Yes | Black/white mask image. Binary file upload; non-black pixels are removed. |
Response
Returns a binary file as the processed image. The output schema is a binary string, so the success response is not a JSON object and does not include named JSON fields.