https://api.nexscope.ai/ai/imageCaptioningRun 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/imageCaptioning |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
type | integer | required | Analysis type. Available options
Example: 71 |
imageUrlList | array | required | Public image URLs used for analysis. Provide no more than 6 images for modes that accept multiple images. Example: [
"https://example.com/product.jpg"
] |
keyword | string | optional | Optional keyword context. Example: phone case |
provider | string | optional | Analysis provider. Available options
Example: API_PRE_POINT |
refVideoUrl | string | conditional | Reference video URL. Required when type is 89. Example: https://example.com/reference-video.mp4 |
saleCountry | string | optional | Target sale country code. Example: US |
targetLanguage | string | optional | Target language for generated text. Used by video-reclone analysis. Example: English |
duration | integer | optional | Target duration in seconds. Used by video-reclone analysis. Example: 15 |
Code example
{
"imageUrlList": [
"https://example.com/product.jpg"
],
"keyword": "phone case",
"provider": "API_PRE_POINT",
"type": 71
}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. |