Imagine API Reference
  1. Image Editing
Imagine API Reference
  • Imagine API References
  • Image Generation
    • Text to Image API
      POST
    • Text to PNG API
      POST
  • Image Editing
    • Background Remover API
      POST
    • Image Upscale API
      POST
    • Generative Fill API
      POST
    • AI Resize API
      POST
    • Retouch API
      POST
  • E-Commerce
    • AI Backgrounds API
      POST
  • Video Generation
    • Text to Video API
      POST
    • Image to Video API
      POST
    • Status by ID
      GET
    • (Deprecated) Status by ID
      GET
    • Delete by ID
      DELETE
    • (Deprecated) Delete by ID
      DELETE
  1. Image Editing

Background Remover API

POST
/image/background/remover
image
This API endpoint allows you to remove the background from an image by uploading it. The response will contain the image with the background removed.

Request

Header Params
Authorization
string 
required
A bearer token that authenticates the user for making the request.
Example:
Bearer {{API Token}}
Body Params multipart/form-data
image
file 
required
The image file to be processed, encoded in Base64 format or as a standard file upload. The API will process this image and return the same image with its background removed.
Example:
cmMtdXBsb2FkLTE3Mjg1NjE5NzAzMTktNA==/model.jpg

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.vyro.ai/v2/image/background/remover' \
--header 'Authorization: Bearer vk-ad08a8e86d1a84404e5837be47d39ab44474f982671c0a' \
--form 'image=@"cmMtdXBsb2FkLTE3Mjg1NjE5NzAzMTktNA==/model.jpg"'

Responses

🟢200Success
application/octet-stream
If the request is successful, the API will return the image file with removed background.
Body
object {0}
Example
The response for 200 code is bytes.
🟠400Bad Request
🔴500Internal Server Error
🔴503Service Unavailable
🟠400Bad Request
🟢200Success
🔴500Internal Server Error
🔴503Service Unavailable
Modified at 2024-11-26 10:39:42
Previous
Text to PNG API
Next
Image Upscale API