https://claw-callback.nexscope.ai/api/skill-api/v1/skills/ai-image-generation-api/runRun this API
Send a JSON request to execute this API and receive the direct response payload.
Endpoint
| Method | POST |
| Path | https://claw-callback.nexscope.ai/api/skill-api/v1/skills/ai-image-generation-api/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
imageUrls | array | required | Public reference image URLs. Provide 1 to 10 images in jpg, jpeg, png, or webp format; each image should be no larger than 20 MB. Example: [
"https://example.com/product.jpg"
] |
prompt | string | required | Generation prompt. Describe the target product image, scene, composition, style, or constraints. Maximum 5000 characters. Example: Keep the product consistent and generate a clean white-background ecommerce hero image. |
outputNum | integer | required | Number of images to generate. Valid range: 1 to 10. Example: 1 |
provider | string | required | Image generation model code. Supported values include BANANA, BANANA_PRO, BANANA_2, BANANA_2_LITE, WAN2_7, SEEDREAM5, SEEDREAM5_PRO, and GPT_2_IMAGE. Example: BANANA_PRO |
extraParams | object | optional | Optional generation settings. Supported keys: resolution (1K, 2K, 4K; availability depends on provider), aspectRatio (for example 1:1, 16:9, 9:16, 3:4, 4:3, 21:9), and quality (low, medium, high; only effective for GPT_2_IMAGE). Example: {
"resolution": "2K",
"aspectRatio": "1:1",
"quality": "high"
} |
Request example
{
"imageUrls": [
"https://example.com/product.jpg"
],
"prompt": "Keep the product consistent and generate a clean white-background ecommerce hero image.",
"outputNum": 1,
"provider": "BANANA_PRO",
"extraParams": {
"resolution": "2K",
"aspectRatio": "1:1",
"quality": "high"
}
}Response body
Creates a Nexscope asynchronous generation task. Use taskId with the task result endpoint to retrieve the completed output. The completed result replaces generated resource URLs with Nexscope-hosted URLs and replaces provider count with actual Nexscope credits charged.
| Name | Type | Required | Description |
|---|---|---|---|
taskId | string | required | Nexscope asynchronous task id used to query the generation result. Example: 6b3f1c61-1b7d-4a59-8a7d-3b23e4b0c9e2 |
status | string | required | Task status. Initial run returns PENDING; the query endpoint may return PENDING, RUNNING, SUCCESS, FAILED, or TIMEOUT. Example: PENDING |
message | string | optional | User-facing task state message. Example: The task has been created. Use taskId to query the result. |
errcode | integer | optional | Upstream status code returned by the provider. |
errmsg | string | optional | Upstream status message returned by the provider. |
code | string | optional | Provider-specific status code. |
msg | string | optional | Provider-specific status message. |
type | string | optional | Provider-specific render or payload type. |
title | string | optional | Provider-specific response title. |
sourceType | string | optional | Provider-specific source platform type. |
sourceTool | string | optional | Provider-specific source tool name. |
costToken | integer | optional | Token cost reported by the upstream provider. |
costTime | integer | optional | Execution time reported by the upstream provider. |
page | integer | optional | Current page returned by the upstream provider. |
pageSize | integer | optional | Page size returned by the upstream provider. |
pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. |
totalPage | integer | optional | Total page count returned by the upstream provider. |
dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. |
Response example
Direct response payload. No extra wrapper is added.
{
"taskId": "6b3f1c61-1b7d-4a59-8a7d-3b23e4b0c9e2",
"status": "PENDING",
"message": "The task has been created. Use taskId to query the result."
}Responses
| Code | Description |
|---|---|
| 200 | API executed successfully. Body is the direct response payload. |
| 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.