Multimodal AI

AI Model Scene & Background Replacement API

Generate scene variants for a model image using either a scene reference image or a text scene prompt.

post/api/skill-api/v1/skills/ai-model-scene-background-replacement/run

Request

  • Base URL: https://api.nexscope.ai
  • URL: https://api.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-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 model image. The image must be up to 20 MB and between 385 and 8192 pixels in both width and height.

sceneImgUrlstring

Optional public URL of the target scene reference.

scenePromptstring

Optional text prompt describing the target scene.

imageSegUrlstring

Optional model segmentation mask URL.

sceneStrengthnumber

Scene reference strength from 0 to 1. Defaults to 0.7.

genOriResboolean

Whether to generate the original resolution. Defaults to false.

realModelboolean

Whether to prefer realistic model rendering.

outputNuminteger

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

Example request

{
  "imageUrl": "https://example.com/model-reference.jpg",
  "scenePrompt": "bright studio showroom",
  "sceneStrength": 0.7,
  "genOriRes": false,
  "realModel": true,
  "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.