Nexscope logo

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://claw-callback.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-replacement-api/run
MCP method
nexscope_ai_model_scene_background_replacement_api

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://claw-callback.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-replacement-api/run

Run an API

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

Slugai-model-scene-background-replacement-api
HeadersAuthorization: Bearer nk_...
Content-Type: application/json
Request bodyAPI-specific JSON object.
Response bodyDirect API response payload. No data/result wrapper is added.

Status codes

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

Example request

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

Run this API

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

Open tester

Endpoint

MethodPOST
Pathhttps://claw-callback.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-replacement-api/run
AuthBearer API key
Content-Typeapplication/json

Request body

NameTypeRequiredDescription
imageUrlstringrequired
Public URL of the model image.
Example: https://example.com/model-reference.jpg
sceneImgUrlstringoptional
Optional public URL of the target scene reference.
Example: https://example.com/scene.jpg
scenePromptstringoptional
Optional text prompt describing the target scene.
Example: bright studio showroom
imageSegUrlstringoptional
Optional model segmentation mask URL.
Example: https://example.com/mask.png
sceneStrengthnumberoptional
Scene reference strength.
Example: 0.7
genOriResbooleanoptional
Whether to generate the original resolution.
Example: true
realModelbooleanoptional
Whether to prefer realistic model rendering.
Example: true
outputNumintegeroptional
Number of images to generate.
Example: 1

Request example

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

NameTypeRequiredDescription
taskIdstringrequired
Nexscope asynchronous task id used to query the generation result.
Example: 6b3f1c61-1b7d-4a59-8a7d-3b23e4b0c9e2
statusstringrequired
Task status. Initial run returns PENDING; the query endpoint may return PENDING, RUNNING, SUCCESS, FAILED, or TIMEOUT.
Example: PENDING
messagestringoptional
User-facing task state message.
Example: The task has been created. Use taskId to query the result.
errcodeintegeroptional
Upstream status code returned by the provider.
errmsgstringoptional
Upstream status message returned by the provider.
codestringoptional
Provider-specific status code.
msgstringoptional
Provider-specific status message.
typestringoptional
Provider-specific render or payload type.
titlestringoptional
Provider-specific response title.
sourceTypestringoptional
Provider-specific source platform type.
sourceToolstringoptional
Provider-specific source tool name.
costTokenintegeroptional
Token cost reported by the upstream provider.
costTimeintegeroptional
Execution time reported by the upstream provider.
pageintegeroptional
Current page returned by the upstream provider.
pageSizeintegeroptional
Page size returned by the upstream provider.
pageItemCountintegeroptional
Item count on the current page returned by the upstream provider.
totalPageintegeroptional
Total page count returned by the upstream provider.
dataSnapshotMonthstringoptional
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

CodeDescription
200API executed successfully. Body is the direct response payload.
400Request JSON or required API parameters are invalid.
401API key is missing, invalid, or cannot be matched to a user.
5xxAPI 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

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_api",
    "arguments": {
      "imageUrl": "https://example.com/model-reference.jpg",
      "sceneImgUrl": "https://example.com/scene.jpg",
      "scenePrompt": "bright studio showroom",
      "imageSegUrl": "https://example.com/mask.png",
      "sceneStrength": 0.7,
      "genOriRes": true,
      "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://claw-callback.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-replacement-api/run
Task result endpoint
https://claw-callback.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-replacement-api/tasks/{taskId}
MCP method
nexscope_ai_model_scene_background_replacement_api
cURL
curl -X POST \
  https://claw-callback.nexscope.ai/api/skill-api/v1/skills/ai-model-scene-background-replacement-api/run \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "imageUrl": "https://example.com/model-reference.jpg", "sceneImgUrl": "https://example.com/scene.jpg", "scenePrompt": "bright studio showroom", "imageSegUrl": "https://example.com/mask.png", "sceneStrength": 0.7, "genOriRes": true, "realModel": true, "outputNum": 1 }'
Response
No response yet. Run the request to see the response here.
Task result

Use the task ID returned by Run API to fetch the generated assets. The result replaces generated resource URLs with Nexscope URLs and replaces count with actual charged credits.

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