Product 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

Replace a selected product region in an ecommerce image. Review authentication, request parameters, response fields, and MCP usage.

Try this API

Endpoint

https://claw-callback.nexscope.ai/api/skill-api/v1/skills/product-replacement-api/run

MCP method

nexscope_product_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/product-replacement-api/run

Run an API

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

Slug	`product-replacement-api`
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/product-replacement-api/run \
  -H "Authorization: Bearer nk_xxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{   "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.55,   "imageOutputWidth": 1024,   "imageOutputHeight": 1024,   "outputNum": 1 }'

All categories/ Multimodal AI

POSThttps://claw-callback.nexscope.ai/api/skill-api/v1/skills/product-replacement-api/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://claw-callback.nexscope.ai/api/skill-api/v1/skills/product-replacement-api/run`
Auth	`Bearer API key`
Content-Type	`application/json`

Request body

Name	Type	Required	Description
`imageUrl`	`string`	required	Public URL of the base image. Example: https://example.com/source-image.jpg
`targetOriginUrl`	`string`	required	Public URL of the replacement product image. Example: https://example.com/product.jpg
`sourceImageUrl`	`string`	optional	Optional source product crop URL. Example: https://example.com/source-product.jpg
`targetImageUrl`	`string`	optional	Optional processed replacement product URL. Example: https://example.com/target-product.png
`denoiseStrength`	`number`	optional	Generation denoise strength. Example: 0.55
`imageOutputWidth`	`integer`	optional	Desired output width in pixels. Example: 1024
`imageOutputHeight`	`integer`	optional	Desired output height in pixels. Example: 1024
`outputNum`	`integer`	optional	Number of images to generate. Example: 1

Request example

{
  "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.55,
  "imageOutputWidth": 1024,
  "imageOutputHeight": 1024,
  "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 Image Generation API

Generate ecommerce images from reference images and a text prompt. Review authentication, request parameters, response fields, and MCP usage.

AI Native Video Generation API

Generate AI video from a prompt plus image or video references. Review authentication, request parameters, response fields, and MCP usage.

Multimodal AI Image Generation API

Generate and edit high-quality product images from multimodal inputs. Review authentication, request parameters, response fields, and MCP usage.

Multimodal Image Recognition API

Analyze an image and extract visual information with multimodal AI. Submit an image URL and ask questions about its visible content.

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_product_replacement_api",
    "arguments": {
      "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.55,
      "imageOutputWidth": 1024,
      "imageOutputHeight": 1024,
      "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/product-replacement-api/run

Task result endpoint

https://claw-callback.nexscope.ai/api/skill-api/v1/skills/product-replacement-api/tasks/{taskId}

MCP method

nexscope_product_replacement_api

API key*

JSON payload*

cURL

curl -X POST \
  https://claw-callback.nexscope.ai/api/skill-api/v1/skills/product-replacement-api/run \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "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.55, "imageOutputWidth": 1024, "imageOutputHeight": 1024, "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.

Task ID

Result response

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