Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
slazzercom authored Jun 19, 2021
1 parent d3fcc20 commit 1ebdfb3
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,18 +73,14 @@ Then you can use your image file instaid of inputFile to get output image.
|key | Request Body | Rrequired |
|---- | ----------- | --- |
|source_image_file (string($binary) ) | Source image file. Support only PNG, JPG, JPEG | Mandatory |
|format (string) | Output image format. Default value 'png'. Otherwise 'jpg' for JPG format and 'png' for PNG format. 'png' format support alpha transparency. |Optional |
|bg_color_code (string) | Output with solid background color. Has to be HEX color code. (e.g. #72E4B3, #B3D472). | Optional |
|bg_image_file (string($binary) ) | Output with image file background. This image will be resize according to the output image file aspect ratio. supported bg_image_file formats are 'png', 'jpg', 'jpeg'. | Optional |

#### Importent Note:
* Use any one background parameter("bg_color_code" or "bg_image_file") at a time when request API

### Error code from response

---
|Code | Response | Details |
|---- | ---------- | --------- |
|200 | {"output_image_url": "image_url"} | Successfully removed image background |
|200 | You will get binary image data after processed | Successfully removed image background |
|400 | {"error": "Source image file not found"} | Error: Invalid parameters or unable to process input image file (No credit deducted) |
|401 | {"error": "invalid api key"} | Error: API-KEY missing or invalid API-KEY (No credit deducted) |
|402 | {"error": "No credits remaining"} | Error: No credits remaining (No credit deducted) |
Expand Down

0 comments on commit 1ebdfb3

Please sign in to comment.