Background Replacer

POST

https://api.sellerpic.ai/v1/api/generate/replaceBackground

Before creating a task, please ensure all required resources have been uploaded.

Request Upload File URL

Upload File

Upload file limit:

Supported formats: JPG/JPEG/PNG/WEBP (no animations)

Max file size: 10MB

Max image resolution: 4096px

Mask Image: Must be black background and white subject, matching original dimensions

Product Image

Product Mask

API Developer Guide

Replace Type	Description	Required Parameters	Output Images	Credit Cost
AI_BACKGROUND	Replaces the background using a preset style Retrieve available styles (type: `AI_BACKGROUND`)	`presetBackgroundId` - ID of selected background style	4	4
TEXT_TO_BACKGROUND	Generates backgrounds based on text prompts	`customBackgroundPrompt` - Descriptive text input	4	4
PRESET_BACKGROUND_IMAGE	Applies a predefined image as background Retrieve available images (type: `BACKGROUND`)	`presetBackgroundId` - ID of preset background image	1	1
CUSTOM_BACKGROUND_IMAGE	Uses user-uploaded image as background Upload Process: 1. Get upload URL 2. Upload file	`backgroundImageKey` - Key of uploaded image	1	1
SOLID_COLOR_BACKGROUND	Sets background using HEX color code (e.g. `#80c699`)	`backgroundColor` - Valid HEX color string	1	1

Concurrency Limits: 10

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.sellerpic.ai/v1/api/generate/replaceBackground' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "replaceType": "string",
    "productImageKey": "string",
    "productMaskKey": "string",
    "presetBackgroundId": "string",
    "customBackgroundPrompt": "string",
    "backgroundColor": "string",
    "backgroundImageKey": "string",
    "productImageScale": 0
}'

Response Example

200 - Example 1

{
  "code": 0,
  "data": {
    "id": "string"
  },
  "msg": "string",
  "success": true,
  "traceId": "string"
}

Request

Header Params

Authorization

string

required

Example:

Bearer YOUR_API_KEY

Content-Type

string

required

Example:

application/json

Body Params application/json

replaceType

string

required

Replace type, must be one of: AI_BACKGROUND, TEXT_TO_BACKGROUND, PRESET_BACKGROUND_IMAGE, CUSTOM_BACKGROUND_IMAGE, SOLID_COLOR_BACKGROUND

productImageKey

string

required

Product image storage key

productMaskKey

string

optional

Product mask image storage key
System will perform automatic masking if not provided. For best results, uploading a custom mask is recommended.

presetBackgroundId

string

optional

Preset background ID (for types: AI_BACKGROUND, BACKGROUND) Retrieve Preset Model List

customBackgroundPrompt

string

optional

Custom background prompt

backgroundColor

string

optional

Background color in hex, e.g., #80c699

backgroundImageKey

string

optional

Background image storage key

productImageScale

number <double>

optional

Product image scale factor, default is 1.0 (range: 0.1–1.0). Only effective when backgroundReplaceType is PRESET_BACKGROUND_IMAGE, CUSTOM_BACKGROUND_IMAGE, or SOLID_COLOR_BACKGROUND.

Examples

Responses

🟢200OK

*/*

Body

code

integer <int32>

required

Result code, where 0 indicates success and non-0 indicates an error.
Please refer to Error Codes

data

object (IdData«string»)

optional

string

required

Task Id

msg

string

optional

Description of the result, providing additional context or information about the operation outcome.

success

boolean

required

traceId

string

required

Trace ID for tracking the request across distributed systems.

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Swap Fashion Model

Segment image by prompt