https://api.nexscope.ai/video/kling3OmniVideoGenerationRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/video/kling3OmniVideoGeneration |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
videoTime | integer | required | Video duration in seconds. Available options
Example: 10 |
prompt | string | required | Video generation prompt describing motion, subject consistency, camera movement, and the ecommerce scene. Maximum 2000 characters. Example: Keep the product consistent while the camera slowly orbits and highlights material details. |
promptOptimizer | boolean | optional | Whether Nexscope should optimize the video prompt before generation. Defaults to false. Example: false |
isPro | boolean | optional | Whether to use the model's professional generation mode when supported. Defaults to false. Example: false |
resolution | string | optional | Output resolution. Available options
Example: 1080p |
imageUrl | string | conditional | Public URL of a first-frame or primary reference image. Example: https://example.com/source-image.jpg |
imageList | array | conditional | Public reference image URLs. Provide 1 to 7 images. Example: [
"https://example.com/product.jpg",
"https://example.com/ref-2.jpg"
] |
aspectRatio | string | conditional | Target video aspect ratio supported by this model. Available options
Example: 1:1 |
lastFrameImageUrl | string | optional | Optional public URL of the final-frame image. Requires 1080p. Example: https://example.com/last-frame.jpg |
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. |
data: object · variant 1 — requires taskId, status, result 4 fields
| 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.result: object · variant 1 1 fields
| 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. |
data.result: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.result | null | required | Result value used by this API operation. |
data: null · variant 2 1 fields
| 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 API key (code 11209), 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. |