Matryal Background Remover
Sign inGet started

API Documentation

Integrate our powerful AI-driven image processing services into your applications with our comprehensive API

API v2.0 AvailableWebhook SupportSDK AvailableBatch ProcessingPerformance OptimizedReal-time MonitoringTesting Suite
API Access
Use API keys to authenticate your requests
🚀 New API v2.0 Features
Enhanced capabilities and improved developer experience

🔄 Webhook Support

Get real-time notifications when async jobs complete

📊 Usage Dashboard

Monitor API usage, rate limits, and performance metrics

🔧 Enhanced SDK

TypeScript SDK with retry logic and error handling

⚡ Better Performance

Improved response times and job cancellation

View API v2.0 DetailsWebhook API
Background Removal
POST /api/v1/background/remove

Request Body

{
  "image_url": "https://example.com/image.jpg",  // OR
  "image_base64": "base64_encoded_image",
  "output_format": "png",  // png, webp, jpg
  "quality": 95,           // 1-100
  "return_mask": false,    // Return mask image
  "async": false,          // Async processing
  "webhook_url": "https://your-webhook.com/callback"
}

Response

{
  "status": "success",
  "data": {
    "input_url": "https://your-domain.com/api/media/input.jpg",
    "output_url": "https://your-domain.com/api/media/output.png",
    "mask_url": "https://your-domain.com/api/media/mask.png"
  }
}
Image Upscaling
POST /api/v1/image/upscale

Request Body

{
  "image_url": "https://example.com/image.jpg",
  "scale": 2,              // 2-4x upscaling
  "model": "realesrgan",   // realesrgan, esrgan
  "output_format": "png",
  "async": false
}
Image Restoration
POST /api/v1/image/restore

Request Body

{
  "image_url": "https://example.com/image.jpg",
  "model": "gfpgan",       // gfpgan, codeformer
  "strength": 0.5,         // 0-1 restoration strength
  "output_format": "png",
  "async": false
}
Image Resize
POST /api/v1/image/resize

Request Body

{
  "image_url": "https://example.com/image.jpg",
  "width": 1000,           // 1-10000 pixels
  "height": 1000,          // 1-10000 pixels
  "fit": "cover",          // cover, contain, fill, inside, outside
  "background": "white",   // Color name or hex (#ffffff)
  "output_format": "webp", // png, webp, jpg
  "quality": 95,           // 1-100
  "async": false
}

Response

{
  "status": "success",
  "data": {
    "input_url": "https://your-domain.com/api/media/input.jpg",
    "output_url": "https://your-domain.com/api/media/resized.webp",
    "dimensions": {
      "width": 1000,
      "height": 1000
    },
    "background": "white",
    "output_format": "webp"
  }
}
Complete Enhancement
POST /api/v1/image/enhance

Request Body

{
  "image_url": "https://example.com/image.jpg",
  "remove_background": true,
  "upscale": true,
  "restore": true,
  "resize": {
    "width": 1920,
    "height": 1080
  },
  "output_format": "webp",
  "quality": 95,
  "async": false
}