POST
https://api.nexscope.ai/ai/apparelImageSetPhotographyV3Run this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/ai/apparelImageSetPhotographyV3 |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
imageList | array | required | Public apparel image URLs. Provide no more than 5 JPG, JPEG, PNG, or WEBP images; each image must be at most 10 MB and between 384 and 4096 pixels. Example: [
"https://example.com/product.jpg"
] |
provider | string | optional | Image model. Defaults to BANANA_2. Available options
Example: BANANA_2 |
sellerPoint | string | conditional | Product selling points, up to 2500 characters. Required when isExtractPrePoint is false. Example: Lightweight breathable summer dress |
isExtractPrePoint | boolean | optional | Whether to automatically extract selling points. Defaults to false. When false, sellerPoint is required. Example: false |
resolution | string | optional | Target resolution supported by the selected provider. Example: 2K |
aspectRatio | string | optional | Target aspect ratio. Example: 1:1 |
noText | boolean | optional | Whether generated images should avoid text. Example: false |
brandKey | string | optional | Optional brand information serialized as a JSON string. Supported keys: brandColor, fontStyle, salesRegion, language, platform, customSettings. Example: {"brandColor":"#0775FA","fontStyle":"sans serif","salesRegion":"North America","language":"English","platform":"Amazon"} |
quality | string | optional | GPT Image quality only. Available options
Example: medium |
sensitiveLibraryId | integer | optional | Optional sensitive-word library ID used to screen generated copy. Example: 1001 |
replaceLibraryId | integer | optional | Optional replacement-word library ID used to rewrite generated copy. Example: 1002 |
modelImageUrl | string | optional | Optional model reference image URL. Example: https://example.com/model-reference.jpg |
sceneImageUrl | string | optional | Optional scene reference image URL. Example: https://example.com/scene.jpg |
isExactScene | boolean | optional | Whether to match the provided scene closely. Defaults to true. Example: true |
modelAndSceneInfo | string | optional | Model and scene information serialized as a JSON string or concise structured text. Example: {"model":"female adult","scene":"studio"} |
aPlusNum | integer | optional | Number of standard A+ images, from 0 to 12. Defaults to 0. Example: 0 |
aPlusProNum | integer | optional | Number of premium A+ images, from 0 to 12. Defaults to 0. Example: 0 |
aPlusHasPhone | boolean | optional | Whether A+ output includes phone display layouts. Example: false |
aPlusAspectRatio | string | optional | A+ output aspect ratio. Available options
Example: 1:1 |
modelTypeNum | integer | optional | Number of model images, from 0 to 12. Defaults to 0. Example: 0 |
insTypeNum | integer | optional | Number of social-style images, from 0 to 12. Defaults to 0. Example: 0 |
sellerTypeNum | integer | optional | Number of selling-point images, from 0 to 12. Defaults to 0. Example: 0 |
sizeTypeNum | integer | optional | Number of size-information images, from 0 to 12. Defaults to 0. Example: 0 |
whiteTypeNum | integer | optional | Number of white-background images, from 0 to 12. Defaults to 0. Example: 0 |
aPlusStyles | array | optional | Optional A+ style entries. Each item may contain a saved style id or a custom prompt. Example: [
{
"id": 1
},
{
"prompt": "clean editorial layout"
}
] |
pointStyles | array | optional | Optional selling-point style entries. Each item may contain a saved style id or a custom prompt. Example: [
{
"id": 2
},
{
"prompt": "minimal feature callouts"
}
] |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"result": null,
"status": "PENDING",
"taskId": "example-task"
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Response fields
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
data | any | required | Data value used by this API operation. |
msg | string | null | required | Msg value used by this API operation. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds. |
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
| Name | Type | Required | Description |
|---|---|---|---|
data.result | object | required | Completed generation output retained from the task result. Fields vary by capability; generated resources use Nexscope-hosted URLs and any count represents charged Nexscope credits. This is the business output, not a task creation receipt. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.result | null | required | Result value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing or invalid API key (code 11209, including an incomplete or corrupted copy) or an expired website login session (code 12001), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |