API Documentation

API Reference

Remove Background

POST

https://api.soreal.app/create-image/remove-background

Description

Remove the background from an existing image.

This endpoint requires 4 credits per image processed.

Parameters

NameTypeRequiredDescription
imageUrlstringYesURL of the image to process. Must be a valid and accessible image URL.

Example Request Headers

{
  "Authorization": "Bearer YOUR_API_KEY",
  "Content-Type": "application/json"
}

Example Request Body

{
  "imageUrl": "https://example.com/path/to/image.jpg"
}

Example Response

{
    "success": true,
    "message": "Image generated successfully",
    "data": "https://api.soreal.app/assets/users/1/generations/1749381948150.png"
}

Error Codes

Status CodeDescription
400Bad Request - Invalid parameters, Insufficient credits
401Unauthorized - Invalid API key
429Too Many Requests - Rate limit exceeded
500Internal Server Error