Multimodal AI

Handheld Product Mockup API

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

post/api/skill-api/v1/skills/handheld-product-mockup/run

Request

  • Base URL: https://api.nexscope.ai
  • URL: https://api.nexscope.ai/api/skill-api/v1/skills/handheld-product-mockup/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 product image. The image must be at most 20 MB and between 385 and 8192 pixels in both width and height.

targetOriginUrlstring required

Public URL of the person or hand pose image.

targetMaskUrlstring 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.

outputNuminteger

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

Example request

{
  "imageUrl": "https://example.com/product.jpg",
  "targetOriginUrl": "https://example.com/model-reference.jpg",
  "targetMaskUrl": "https://example.com/mask.png",
  "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.