AI Model Scene & Background Replacement API

REST API and MCP service documentation generated from server-side API definitions. Responses shown here are the direct payload returned by each API execution.

API selector

Multimodal AI

API overview

Place a model image into a new scene or background. Review authentication, request parameters, response fields, and MCP usage.

Try this API

Endpoint

https://api.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-replacement/run

MCP method

nexscope_ai_model_scene_background_replacement

Authentication

All run endpoints require a user API key. Send it as a bearer token in the Authorization header.

Authorization: Bearer nk_xxxxxxxxxxxxxxxxx

Missing or invalid API keys return an authentication error. Manage keys from .

POSThttps://api.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-replacement/run

Run an API

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

Slug	`ai-model-scene-background-replacement`
Headers	`Authorization: Bearer nk_...` `Content-Type: application/json`
Request body	API-specific JSON object.
Response body	Direct API response payload. No data/result wrapper is added.

Status codes

Code	Description
200	API executed successfully. Body is the direct response payload.
400	Request JSON or required API parameters are invalid.
401	API key is missing, invalid, or cannot be matched to a user.
5xx	API execution or upstream service failed.

Example request

curl -X POST https://api.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-replacement/run \
  -H "Authorization: Bearer nk_xxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{   "imageUrl": "https://example.com/model-reference.jpg",   "scenePrompt": "bright studio showroom",   "sceneStrength": 0.7,   "genOriRes": false,   "realModel": true,   "outputNum": 1 }'

All categories/ Multimodal AI

POSThttps://api.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-replacement/run

Run this API

Send a JSON request to execute this API and receive the direct response payload.

Open tester

Endpoint

Method	`POST`
Path	`https://api.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-replacement/run`
Auth	`Bearer API key`
Content-Type	`application/json`

Request body

Name	Type	Required	Description
`imageUrl`	`string`	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. Example: https://example.com/model-reference.jpg
`sceneImgUrl`	`string`	conditional	Optional public URL of the target scene reference. Example: https://example.com/scene.jpg
`scenePrompt`	`string`	conditional	Optional text prompt describing the target scene. Example: bright studio showroom
`imageSegUrl`	`string`	optional	Optional model segmentation mask URL. Example: https://example.com/mask.png
`sceneStrength`	`number`	optional	Scene reference strength from 0 to 1. Defaults to 0.7. Example: 0.7
`genOriRes`	`boolean`	optional	Whether to generate the original resolution. Defaults to false. Example: false
`realModel`	`boolean`	optional	Whether to prefer realistic model rendering. Example: true
`outputNum`	`integer`	optional	Number of images to generate, from 1 to 4. Defaults to 1. Example: 1

Request example

{
  "imageUrl": "https://example.com/model-reference.jpg",
  "scenePrompt": "bright studio showroom",
  "sceneStrength": 0.7,
  "genOriRes": false,
  "realModel": true,
  "outputNum": 1
}

Response body

Creates a Nexscope asynchronous generation task. Use taskId with the task result endpoint to retrieve the completed output. The completed result replaces generated resource URLs with Nexscope-hosted URLs and replaces provider count with actual Nexscope credits charged.

Name	Type	Required	Description
`taskId`	`string`	required	Nexscope asynchronous task id used to query the generation result. Example: 6b3f1c61-1b7d-4a59-8a7d-3b23e4b0c9e2
`status`	`string`	required	Task status. Initial run returns PENDING; the query endpoint may return PENDING, RUNNING, SUCCESS, FAILED, or TIMEOUT. Example: PENDING
`message`	`string`	optional	User-facing task state message. Example: The task has been created. Use taskId to query the result.
`errcode`	`integer`	optional	Upstream status code returned by the provider.
`errmsg`	`string`	optional	Upstream status message returned by the provider.
`code`	`string`	optional	Provider-specific status code.
`msg`	`string`	optional	Provider-specific status message.
`type`	`string`	optional	Provider-specific render or payload type.
`title`	`string`	optional	Provider-specific response title.
`sourceType`	`string`	optional	Provider-specific source platform type.
`sourceTool`	`string`	optional	Provider-specific source tool name.
`costToken`	`integer`	optional	Token cost reported by the upstream provider.
`costTime`	`integer`	optional	Execution time reported by the upstream provider.
`page`	`integer`	optional	Current page returned by the upstream provider.
`pageSize`	`integer`	optional	Page size returned by the upstream provider.
`pageItemCount`	`integer`	optional	Item count on the current page returned by the upstream provider.
`totalPage`	`integer`	optional	Total page count returned by the upstream provider.
`dataSnapshotMonth`	`string`	optional	Data snapshot month returned by the upstream provider.

Response example

Direct response payload. No extra wrapper is added.

{
  "taskId": "6b3f1c61-1b7d-4a59-8a7d-3b23e4b0c9e2",
  "status": "PENDING",
  "message": "The task has been created. Use taskId to query the result."
}

Responses

Code	Description
200	API executed successfully. Body is the direct response payload.
400	Request JSON or required API parameters are invalid.
401	API key is missing, invalid, or cannot be matched to a user.
5xx	API execution or upstream service failed.

Data source, freshness, and limitations

Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.

Related APIs

AI Model Swap API

Place an ecommerce product image onto a target model. Review authentication, request parameters, response fields, and MCP usage.

AI Model Swap API 2.0

Swap a product image onto a fixed model reference with the version 2.0 workflow. Review request parameters, response fields, and MCP usage.

AI Clothes Changer API for Tops & Bottoms

Generate virtual try-on images for separate upper and lower garments. Review authentication, request parameters, response fields, and MCP usage.

AI Suit Virtual Try-On API

Generate virtual try-on images for one-piece outfits. Review authentication, request parameters, response fields, and MCP usage.

MCP

Use the MCP endpoint when an agent needs to discover and call API tools with JSON-RPC.

GET /api/skill-api/v1/mcp

POST /api/skill-api/v1/mcp
Authorization: Bearer nk_xxxxxxxxxxxxxxxxx
Content-Type: application/json

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_ai_model_scene_background_replacement",
    "arguments": {
      "imageUrl": "https://example.com/model-reference.jpg",
      "scenePrompt": "bright studio showroom",
      "sceneStrength": 0.7,
      "genOriRes": false,
      "realModel": true,
      "outputNum": 1
    }
  }
}

Online test

Execute the current API with your API key and JSON payload.

Try it

Send a real request with the same contract shown in the reference.

Endpoint

https://api.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-replacement/run

Task result endpoint

https://api.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-replacement/tasks/{taskId}

MCP method

nexscope_ai_model_scene_background_replacement

API key*

JSON payload*

cURL

curl -X POST \
  https://api.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-replacement/run \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "imageUrl": "", "scenePrompt": "bright studio showroom", "sceneStrength": 0.7, "genOriRes": false, "realModel": true, "outputNum": 1 }'

Response

No response yet. Run the request to see the response here.

Task result

Results are checked automatically after Run API. You can also enter a task ID and check it manually; completed resources use Nexscope URLs and show actual charged credits.

Task ID

Result response

No task result yet. Query the task to see the generated output here.