Multimodal AI

Product Replacement API

Use source and target product references to replace product content while preserving scene consistency.

post/api/skill-api/v1/skills/product-replacement/run

Request

  • Base URL: https://api.nexscope.ai
  • URL: https://api.nexscope.ai/api/skill-api/v1/skills/product-replacement/run
  • Auth: HTTP bearer

Headers

X-Nexscope-Http-Status'legacy' | 'semantic'

Use semantic for HTTP error statuses on run and task-result requests. Without this header v1 retains legacy status behavior. The JSON envelope is unchanged; code 0 means success or acceptance, not asynchronous completion.

Request body

imageUrlstring required

Public URL of the base image. The image must be up to 20 MB and between 384 and 8192 pixels in both width and height.

targetOriginUrlstring required

Public URL of the replacement product image.

sourceImageUrlstring

Optional source product crop URL.

targetImageUrlstring

Optional processed replacement product URL.

denoiseStrengthnumber

Generation denoise strength from 0 to 1. Defaults to 0.5.

imageOutputWidthinteger

Desired output width in pixels, from 32 to 4096.

imageOutputHeightinteger

Desired output height in pixels, from 32 to 4096.

outputNuminteger

Number of images to generate, from 1 to 4. Defaults to 1.

Example request

{
  "imageUrl": "https://example.com/source-image.jpg",
  "targetOriginUrl": "https://example.com/product.jpg",
  "sourceImageUrl": "https://example.com/source-product.jpg",
  "targetImageUrl": "https://example.com/target-product.png",
  "denoiseStrength": 0.5,
  "imageOutputWidth": 1024,
  "imageOutputHeight": 1024,
  "outputNum": 1
}

Response

Successful response.

codeinteger required

0 means accepted or successful; nonzero is a platform error.

msgstring nullable required
tsstring required

Epoch milliseconds.

timestring required

Server local time: yyyy-MM-dd HH:mm:ss.

coststring required

Elapsed milliseconds, never credits; -1 outside web requests.

traceIdstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.