Background Remover
Overview
The Background Remover is a powerful AI tool that automatically removes the background from your images, leaving only the main subject. Whether you need professional product photos, perfect profile pictures, or creative compositions, this tool makes it quick and easy.
Common Use Cases:
- E-commerce product photography
- Professional headshots
- Social media content
- Digital art and design
- Marketing materials
API Reference
- URL: https://api.maxstudio.ai/background-remover
- Method: POST
API Parameters
Name | Type | Required | Description |
---|---|---|---|
image | string | yes | Base64 encoded image |
⚠️ Important: When sending the base64 image, do not include the prefix (e.g., 'data:image/jpeg;base64,'). Send only the raw base64 string.
Headers
Name | Type | Required | Description |
---|---|---|---|
x-api-key | string | yes | Your API key obtained from the MaxStudio APIs Dashboard (opens in a new tab). Generate this key by logging into your account and navigating to the API Keys section. |
Code Examples
// TypeScript implementationinterface Params { image: string;}async function BackgroundRemove(params: Params): Promise<any> { try { const response = await fetch('https://api.maxstudio.ai/background-remover', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ image: params.image }) }); const jobId = await response.json(); return jobId; } catch (error) { console.error('Error:', error); throw error; }}
Success Response
{
"jobId": "<job_id>"
}
Error Response Examples
// Rate Limit Error
{
"status": 429,
"error": "Rate limit exceeded. Please try again later."
}
// Insufficient Credits
{
"status": 402,
"error": "Insufficient credits. Please Buy credits."
}
// Invalid Input
{
"status": 400,
"error": "Image size must be less than 5MB"
}
Get Job Status
Headers
Name | Type | Required | Description |
---|---|---|---|
x-api-key | string | yes | Your API key obtained from the MaxStudio APIs Dashboard (opens in a new tab). Generate this key by logging into your account and navigating to the API Keys section. |
To check the status of your job, use the following examples:
// TypeScript implementationasync function getJobStatus(jobId: string): Promise<any> { const url = `https://api.maxstudio.ai/background-remover/${jobId}`; try { const response = await axios.get(url); const jobId = await response.json(); return jobId; } catch (error) { console.error('Error:', error); throw error; }}
Job Status Reference
Status | Description |
---|---|
creating | Job is being initialized |
pending | Job is in processing queue |
running | Job is actively processing |
completed | Processing finished successfully |
failed | Processing encountered an error |
not-found | Invalid or expired job ID |
Output
{
"status": "<status>", // One of the status values from the table above
"result": "<result>" // Base64 encoded image data when status is 'completed'
}