Smart Image Edit & Manipulation v3

Perform general image editing with prompt, resolution, aspect ratio, and quality controls. Call it via REST API or MCP, or try it in the online playground.

CostEst. 116–140 credits / call

Try online

POST · https://api.nexscope.ai/ai/smartImageEditManipulationV3MCP · nexscope_smart_image_edit_manipulation_v3

Subscription required. Creative AI APIs are available only to users with an active subscription. Trial credits do not enable API key access. View subscription plans.

What this API does

Perform general image editing with prompt, resolution, aspect ratio, and quality controls. The request accepts imageUrl, prompt, provider, outputNum, resolution. Generation runs as a task: retain the task ID and retrieve the completed result before using the output.

Smart Image Edit & Manipulation v3 API use cases

Prepare listing image assets

To prepare listing image assets, a content editor submits imageUrl and prompt to Smart Image Edit & Manipulation v3. The returned completed generation results help prepare product visuals for a listing review.

Compare a product visual treatment

A content editor uses Smart Image Edit & Manipulation v3 with imageUrl and prompt to compare a product visual treatment. The returned completed generation results help compare the edited treatment with the source asset.

Review edited assets for a campaign

For this workflow, a content editor calls Smart Image Edit & Manipulation v3 with imageUrl and prompt to review edited assets for a campaign. The result helps select an approved asset for the campaign.

Smart Image Edit & Manipulation v3 API FAQ

What does the Smart Image Edit & Manipulation v3 API return?

Perform general image editing with prompt, resolution, aspect ratio, and quality controls. It corresponds to the supplied imageUrl, prompt, provider, outputNum, resolution. The initial response can contain a task ID and status; the completed task result contains the generated output. Example values illustrate the response shape, rather than live account results.

How many credits does the Smart Image Edit & Manipulation v3 API cost?

The current documented cost is Est. 116–140 credits / call. This is the same cost shown at the top of this page. If a range or estimate is displayed, the final charge depends on the request. Review your available credits and the pricing page before calling the API, and check API usage records for the actual charge.

How do I call the Smart Image Edit & Manipulation v3 API from my app or an MCP client?

Send a POST request to https://api.nexscope.ai/ai/smartImageEditManipulationV3 with your API key as a Bearer token and the JSON inputs shown in API integration. In a compatible MCP client such as Claude or Cursor, connect Nexscope and call nexscope_smart_image_edit_manipulation_v3. Use the MCP arguments shown in the MCP guide, or switch Online test to MCP to review its request before adding it to your app.

View plans and credits Connect this API with MCP

Try this API

Endpoint

https://api.nexscope.ai/ai/smartImageEditManipulationV3

MCP method

nexscope_smart_image_edit_manipulation_v3

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/ai/smartImageEditManipulationV3

Run an API

Perform general image editing with provider, prompt, resolution, aspect ratio, and quality controls.

Example request

Replace YOUR_API_KEY, then run this command in your terminal.

curl -X POST 'https://api.nexscope.ai/ai/smartImageEditManipulationV3' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "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"
}'

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"
}

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

View parameters & response Try online

All categories/ Multimodal AI

POSThttps://api.nexscope.ai/ai/smartImageEditManipulationV3

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/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 `BANANA` `BANANA_2` `BANANA_PRO` `WAN2_7` `QWEN_IMAGE_3_PRO` `SEEDREAM5` `GPT_2_IMAGE` `AIDRAW_EDIT` 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 `eco` `stable` Example: stable
`needOptimize`	`boolean`	optional	Whether the prompt should be optimized upstream. Example: true
`template`	`string`	optional	Optional Nexscope editing template. Available options `white-background` `product-main-image-retouching` `scene-generation` `poster-design` `add-person-or-object` `change-animal` `flat-lay-apparel` `3d-apparel` `mannequin-to-model` `cartoon-illustration` `body-reshape` `change-style` `remove-element` `remove-text` `remove-watermark` `add-watermark` 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 `low` `medium` `high` Example: medium

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.

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/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_smart_image_edit_manipulation_v3",
    "arguments": {
      "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"
    }
  }
}

Legacy MCP v1

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

GET / POST /mcp/legacy

What can you do with this API?

Data explained and practical use cases

AI Guide

Question

What does Smart Image Edit & Manipulation v3 do, and what does its response show?

AI answer

Smart Image Edit & Manipulation v3 starts an image editing task from a source image and a written instruction. The request offers model, template, format, and quality controls. The documented response shows a pending task, not a completed edit or documented media fields.

Returned field	What it shows
`code`	`0` means the request was accepted or succeeded; a nonzero value indicates a platform error.
`data.taskId`	The ID to retain for retrieving the task later.
`data.status`	The task state; the example shows `PENDING`.
`data.result`	The example shows `null` while the task is pending. Completed edit fields are not documented here.
`msg`, `traceId`	Message and trace values, which may be null.
`time`, `ts`, `cost`	Server local time, epoch milliseconds, and elapsed milliseconds. `cost` is not a credit charge.

Request a white background for a product photo; retain the task ID and inspect the completed result before using the edit in a listing.
- Prompt example: “I am preparing product creative for an online listing. Could you request a white background for a product photo; retain the task ID and inspect the completed result before using the edit in a listing? Show the relevant returned evidence and tell me what input you need from me.”
Request removal of an unwanted object; check the returned status while the edit is pending.
- Prompt example: “I am preparing product creative for an online listing. Could you request removal of an unwanted object; check the returned status while the edit is pending? Show the relevant returned evidence and tell me what input you need from me.”
Request a promotional poster from an existing image; retrieve the completed task result before evaluating the design.
- Prompt example: “I am preparing product creative for an online listing. Could you request a promotional poster from an existing image; retrieve the completed task result before evaluating the design? Show the relevant returned evidence and tell me what input you need from me.”
Request a different aspect ratio for a placement; verify the finished edit after the task completes, since the acknowledgement does not establish its dimensions.
- Prompt example: “I am preparing product creative for an online listing. Could you request a different aspect ratio for a placement; verify the finished edit after the task completes, since the acknowledgement does not establish its dimensions? Show the relevant returned evidence and tell me what input you need from me.”

Related APIs

Smart Image Outpainting

Generate an expanded image around the original content using target width, height, and optional prompt.

Smart Multi-Image Editing v3

Create an edited output from multiple source images using prompt, resolution, and quality controls.

AI Apparel Image Set & Photography v3

Create apparel ecommerce image sets from clothing images with optional model and scene references.

AI Product Marketing Image Set v4

Create ecommerce product marketing materials such as selling-point images and A+ style visuals from product images and brief.