Handheld Product Mockup

Place a product naturally into a handheld scene or mockup.

Choose an integration method

Multimodal AI

What this API does

Place a product naturally into a handheld scene or mockup. Review authentication, request parameters, response fields, and MCP usage.

Try this API

Endpoint

https://api.nexscope.ai/api/skill-api/v1/skills/handheld-product-mockup/run

MCP method

nexscope_handheld_product_mockup

Step 1 of 3 · Authenticate

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 .

Step 2 of 3 · Send a request

POSThttps://api.nexscope.ai/api/skill-api/v1/skills/handheld-product-mockup/run

Run an API

Generate natural hand-held product imagery from a person image and target product asset.

Example request

Replace YOUR_API_KEY, then run this command in your terminal.

curl -X POST 'https://api.nexscope.ai/api/skill-api/v1/skills/handheld-product-mockup/run' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "imageUrl": "https://example.com/product.jpg",
  "targetOriginUrl": "https://example.com/model-reference.jpg",
  "targetMaskUrl": "https://example.com/mask.png",
  "outputNum": 1
}'

Step 3 of 3 · Inspect the result

Check the response

Read code for the request status and data for the result. Open the parameter and response reference for the full field definitions.

HTTP status codes

Code	Description
200	HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
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.

View parameters & response Try online

All categories/ Multimodal AI

POSThttps://api.nexscope.ai/api/skill-api/v1/skills/handheld-product-mockup/run

Run this API

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

Open tester

Endpoint

Method	`POST`
Path	`https://api.nexscope.ai/api/skill-api/v1/skills/handheld-product-mockup/run`
Auth	`Bearer API key`
Content-Type	`application/json`

Step 1 of 2 · Connect your MCP client

MCP

V2 recommended

Connect remote agents through the standard MCP 2025-11-25 Streamable HTTP endpoint. Use OAuth 2.1 Authorization Code with PKCE, or an API key for compatibility.

POST https://api.nexscope.ai/api/skill-api/v2/mcp
MCP-Protocol-Version: 2025-11-25
Content-Type: application/json

Authentication

OAuth clients request the mcp:tools scope. The endpoint's 401 response advertises protected-resource metadata for authorization discovery.

Step 2 of 2 · Call the tool

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_handheld_product_mockup",
    "arguments": {
      "imageUrl": "https://example.com/product.jpg",
      "targetOriginUrl": "https://example.com/model-reference.jpg",
      "targetMaskUrl": "https://example.com/mask.png",
      "outputNum": 1
    }
  }
}

Legacy MCP v1

Existing API-key clients can continue using the compatibility endpoint. New integrations should use MCP v2.

GET / POST /api/skill-api/v1/mcp

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/handheld-product-mockup/run

Task result endpoint

https://api.nexscope.ai/api/skill-api/v1/skills/handheld-product-mockup/tasks/{taskId}

MCP method

nexscope_handheld_product_mockup

API key*

JSON payload*

cURL

curl -X POST \
  https://api.nexscope.ai/api/skill-api/v1/skills/handheld-product-mockup/run \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "imageUrl": "", "targetOriginUrl": "", "targetMaskUrl": "", "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.

Related APIs

AI Model Swap

Place an ecommerce product image onto a target model.

AI Model Swap API 2.0

Swap a product image onto a fixed model reference with the version 2.0 workflow.

AI Model Scene & Background Replacement

Place a model image into a new scene or background.

AI Clothes Changer API for Tops & Bottoms

Generate virtual try-on images for separate upper and lower garments.

Request parameters

Name	Type	Required	Description
`imageUrl`	`string`	required	Public URL of the product image. The image must be at most 20 MB and between 385 and 8192 pixels in both width and height. Example: https://example.com/product.jpg
`targetOriginUrl`	`string`	required	Public URL of the person or hand pose image. Example: https://example.com/model-reference.jpg
`targetMaskUrl`	`string`	required	Public URL of the black-and-white hand-held area mask. Required because this API accepts custom pose images rather than saved upstream materials. Example: https://example.com/mask.png
`outputNum`	`integer`	optional	Number of images to generate, from 1 to 4. Defaults to 1. Example: 1

Code example

{
  "imageUrl": "https://example.com/product.jpg",
  "targetOriginUrl": "https://example.com/model-reference.jpg",
  "targetMaskUrl": "https://example.com/mask.png",
  "outputNum": 1
}

Response example

Platform response envelope. code 0 indicates success or acceptance; data contains the business result.

{
  "data": {
    "taskId": "example-task",
    "status": "PENDING",
    "result": null
  },
  "code": 0,
  "msg": null,
  "ts": "0",
  "time": "2026-01-01 00:00:00",
  "cost": "-1",
  "traceId": null
}

Response fields

Name	Type	Required	Description
`data`	`any`	required	Data value used by this API operation.
`code`	`integer`	required	0 means accepted or successful; nonzero is a platform error.
`msg`	`string \| null`	required	Msg value used by this API operation.
`ts`	`string`	required	Epoch milliseconds.
`time`	`string`	required	Server local time: yyyy-MM-dd HH:mm:ss.
`cost`	`string`	required	Elapsed milliseconds, never credits; -1 outside web requests.
`traceId`	`string \| null`	required	Trace id value used by this API operation.

Any of option 1 — requires taskId, status, result

Name	Type	Required	Description
`data`	`object`	required	Data value used by this API operation.
`data.result`	`any`	required	Result value used by this API operation.
`data.status`	`string`	required	Status value used by this API operation. Allowed: PENDING, RUNNING, SUCCEEDED, FAILED, TIMEOUT
`data.taskId`	`string`	required	Task id value used by this API operation.

Any of option 1

Responses

Code	Description
200	HTTP request completed. Check JSON code; only 0 indicates business success or acceptance.
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.

Handheld Product Mockup

Handheld Product Mockup

What this API does

Authentication

Run an API

Example request

Check the response

HTTP status codes

Run this API

Endpoint

MCP

Call a tool

Legacy MCP v1

Online test

Try it

Related APIs

Request parameters

Code example

Response example

Response fields

Any of option 1 — requires taskId, status, result

Any of option 1

Responses

Data source, freshness, and limitations

Any of option 2

Any of option 2