Developer API

Image API

The Image API is the active image-processing controller in the current catalogue. Its published background-removal route can be integrated into server-side or application workflows while subscription, API-key and request-limit controls remain managed by the Vismrit API platform.

Capabilities

What this API is designed to do

Image-processing API currently publishing a background-removal route.

Call the active /image/background_remover route
Process image input through a managed API subscription
Control access with API keys and whitelist rules
Track request volume and errors
Use cases

Where it can fit

These are common integration scenarios; the exact implementation depends on your application, data-handling requirements and subscription tier.

Product-photo cleanup
Profile-image preparation
Design and content tooling
Automated image-processing pipelines
Endpoint catalogue

Published routes and methods

The endpoint list below is read from the existing API controller catalogue. Website Management can explain the API, but it cannot invent or replace live endpoint routes.

MethodRoutePurpose
ANY/image/background_removerBackground Remover
Integration reference

Authentication, request shape and response handling

These examples are presentation content managed by Website Management. Always compare them with the live API documentation and endpoint catalogue before production integration.

Authentication & access

Use Authorization: Bearer YOUR_API_KEY or X-API-Key. The image endpoint accepts image or image_base64 from form/query input, or JSON containing either field.

Example request
curl -X POST "https://api.sinhcoms.com/image/background_remover" 
  -H "Authorization: Bearer YOUR_API_KEY" 
  -H "Content-Type: application/json" 
  -d '{
    "image_base64": "data:image/png;base64,..."
  }'
Example response
{
  "status": "success",
  "data": {
    "message": "Background removed successfully",
    "image_base64": "..."
  },
  "timestamp": "YYYY-MM-DD HH:MM:SS"
}
Error handling

Documented error states

400Image is required or request image data cannot be encoded
401API key authentication or product authorization failed
429Daily request limit exceeded
502Invalid/failed background-removal upstream response
504Background-removal WebSocket timeout
Integration flow

From subscription to first request

Use the customer dashboard as the control point for keys, whitelist rules and plan limits.

01

Choose an Image API plan

02

Generate or assign an API key

03

Prepare the supported image input format

04

Call the published background-removal endpoint

05

Store or return the processed image according to your application workflow

Integration notes

Before you go live

Large image payloads can affect response time and bandwidth. Validate file size and type before sending requests and use server-side integration for sensitive uploads.