POST
https://api.nexscope.ai/ai/smartImageEditManipulationV3Run 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/smartImageEditManipulationV3 |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
imageUrl | string | required | Public URL of the image to edit. The image must be between 300 and 4096 pixels in both width and height, and its width-to-height ratio must be between 0.4 and 2.5. Example: https://example.com/product.jpg |
prompt | string | required | Editing instruction. Example: make the background pure white and keep the product unchanged |
provider | string | required | Image model. Available options
Example: BANANA_PRO |
outputNum | integer | optional | Number of images to generate, from 1 to 4. Example: 1 |
resolution | string | optional | Target resolution preset. Example: 1K |
aspectRatio | string | optional | Target aspect ratio. Example: 1:1 |
supplyType | string | optional | Generation route. Defaults to stable. Available options
Example: stable |
needOptimize | boolean | optional | Whether the prompt should be optimized upstream. Example: true |
template | string | optional | Optional Nexscope editing template. Available options
Example: white-background |
source | string | optional | Optional traffic or product source code. Example: api |
quality | string | optional | GPT Image quality only. Defaults to medium. Available options
Example: medium |
Code example
{
"aspectRatio": "1:1",
"imageUrl": "https://example.com/product.jpg",
"needOptimize": true,
"outputNum": 1,
"prompt": "make the background pure white and keep the product unchanged",
"provider": "BANANA_PRO",
"quality": "medium",
"resolution": "1K",
"source": "api",
"supplyType": "stable",
"template": "white-background"
}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. |
data.usage | object | optional | Actual credits charged for a completed successful task; omitted when unavailable. |
data.usage.chargedCredits | integer | required | Charged credits value used by this API operation. Minimum: 0 |
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 | 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. |
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.