https://api.nexscope.ai/ai/productDescriptionGeneratorRun 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/productDescriptionGenerator |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
operation | string | optional | create (default) or query. Example: create |
prompt | string | conditional | Product-copy generation instruction; required by create. Example: Write a product description for a wireless speaker. |
imageUrls | array | optional | Media URLs used as context. Pass an empty array for text-only generation; use up to 10 images or typically one video. Example: [] |
thinkingLevel | string | conditional | Reasoning level required by create. GEM_3_1_PRO does not support minimal. Example: minimal |
model | string | optional | Text-generation model. GEM_3_FLASH is the default. Example: GEM_3_FLASH |
memberId | string | optional | Optional provider member identifier used by create and query. Example: |
taskId | string | conditional | Provider task ID returned by create; required by operation=query. Example: 123456789 |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"completionTokens": 350,
"content": "Example product description.",
"costToken": 1,
"promptTokens": 120,
"status": "PROCESSING",
"taskId": "123456789",
"totalTokens": 470
},
"msg": "Generation failed.",
"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
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.completionTokens | integer | optional | Output token count when the task succeeds. Example: 350 |
data.content | string | optional | Generated product copy when the task succeeds. Example: Example product description. |
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
data.costToken | integer | optional | Provider-reported token cost. Example: 1 |
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
data.promptTokens | integer | optional | Input token count when the task succeeds. Example: 120 |
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
data.status | string | optional | Task status such as PROCESSING, SUCCESS, or FAILED. Example: PROCESSING |
data.taskId | string | optional | Asynchronous generation task ID. Example: 123456789 |
data.title | string | optional | Provider-specific response title. Example: null |
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
data.totalTokens | integer | optional | Total token count when the task succeeds. Example: 470 |
data.type | string | optional | Provider-specific render or payload type. Example: null |
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. |
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.