# Kling V3 Omni Video — API Reference

Model ID: `model_kling-v3-omni-video`

---

## Authentication

- **API_KEY** and **API_SECRET** are found in your [Scenario Project Settings](https://app.scenario.com/team&tab=project_api_keys) under API Keys.
- Set them as environment variables `SCENARIO_SDK_API_KEY` and `SCENARIO_SDK_API_SECRET` — both SDKs pick them up by default.
- For raw HTTP (cURL), use Basic Auth: `Authorization: Basic base64("<API_KEY>:<API_SECRET>")`.

### Install the SDK

- JavaScript / TypeScript: `npm install @scenario-labs/sdk`
- Python: `pip install scenario-sdk`

---

## Generate

**Endpoint:** `POST https://api.cloud.scenario.com/v1/generate/custom/model_kling-v3-omni-video`

### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `prompt` | string | yes | - | Text prompt for video generation. Supports <<<image_1>>>, <<<video_1>>> template references. Max 2500 characters. |
| `startImage` | assetId | - | - | First frame image. Max 10MB, min 300px, aspect ratio 1:2.5 to 2.5:1. |
| `endImage` | assetId | - | - | Last frame image. Requires a Start Image. Max 10MB, min 300px. |
| `referenceImages` | assetId[] | - | - | Reference images for elements, scenes, or styles. Max 7 without video, 4 with video. |
| `referenceVideo` | assetId | - | - | Reference video. Duration 3-10s, resolution 720-2160px per side, max 200MB. Not supported with 4K. |
| `videoReferenceType` | string | - | `feature` | How to use reference video: 'Feature' for style/camera reference, 'Base' for video editing. |
| `keepOriginalSound` | boolean | - | `true` | Keep original sound from reference video. |
| `generateAudio` | boolean | - | `false` | Generate native audio. Mutually exclusive with reference video. |
| `mode` | string | - | `pro` | 'Standard' generates 720p, 'Pro' generates 1080p, '4k' generates 4K. 4K mode does not support reference video. |
| `aspectRatio` | string | - | `16:9` | Aspect ratio. Required when not using start frame or video editing. |
| `duration` | number | - | `5` | Video duration in seconds (3-15). Ignored for video editing (base). |
| `multiPrompt` | string | - | - | JSON array of shot definitions for multi-shot mode. Each shot: {"prompt": "...", "duration": N}. Max 6 shots, min duration 1s per shot, total must equal duration. Example: [{"prompt":"A cat jumps","duration":3},{"prompt":"It lands","duration":2}] |

### Example Requests

**cURL**

```bash
curl -X POST "https://api.cloud.scenario.com/v1/generate/custom/model_kling-v3-omni-video" \
  -H "Authorization: Basic $(echo -n '<API_KEY>:<API_SECRET>' | base64)" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'EOF'
{
  "prompt": "A fantasy landscape",
  "videoReferenceType": "feature",
  "keepOriginalSound": true,
  "generateAudio": false,
  "mode": "pro",
  "aspectRatio": "16:9",
  "duration": 5
}
EOF
```

**Python**

```python
import os
from scenario_sdk import Scenario

client = Scenario(
    api_key=os.environ.get("SCENARIO_SDK_API_KEY"),
    api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"),
)

body = {
    "prompt": "A fantasy landscape",
    "videoReferenceType": "feature",
    "keepOriginalSound": True,
    "generateAudio": False,
    "mode": "pro",
    "aspectRatio": "16:9",
    "duration": 5
}

response = client.generate.run_model(
    model_id="model_kling-v3-omni-video",
    body=body,
)
print(response)
```

**JavaScript**

```javascript
import Scenario from "@scenario-labs/sdk";

const client = new Scenario({
  apiKey: process.env["SCENARIO_SDK_API_KEY"],
  apiSecret: process.env["SCENARIO_SDK_API_SECRET"],
});

const body = {
  "prompt": "A fantasy landscape",
  "videoReferenceType": "feature",
  "keepOriginalSound": true,
  "generateAudio": false,
  "mode": "pro",
  "aspectRatio": "16:9",
  "duration": 5
};

const response = await client.generate.runModel("model_kling-v3-omni-video", { body });
console.info(response);
```

---

## Retrieve Results

After submitting a generation request, you receive a `jobId`. Poll the job until `job.status` is `"success"`. The generated asset IDs are in `job.metadata.assetIds`.

**Endpoint:** `GET https://api.cloud.scenario.com/v1/jobs/{jobId}`

### Example Requests

**cURL**

```bash
curl -X GET "https://api.cloud.scenario.com/v1/jobs/<JOB_ID>" \
  -H "Authorization: Basic $(echo -n '<API_KEY>:<API_SECRET>' | base64)"
```

**Python**

```python
job = client.jobs.retrieve(job_id="<JOB_ID>")
print(job.status)
print(job.metadata.asset_ids)
```

**JavaScript**

```javascript
// Option 1 — wait on the response from runModel using the SDK helper
const completed = await response.job.wait();
console.info(completed.status);
console.info(completed.metadata?.assetIds);

// Option 2 — retrieve a job by its ID
const job = await client.jobs.retrieve("<JOB_ID>");
console.info(job.status);
console.info(job.metadata?.assetIds);
```

**Example response:**

```json
{
  "job": {
    "jobId": "job_abc123",
    "status": "success",
    "metadata": {
      "assetIds": [
        "asset_abc123"
      ]
    }
  }
}
```

> **Important:** Generated asset URLs are **temporary** and expire after a short period. Download and store any images you wish to keep before the URL expires. More info: [Content Delivery Network (CDN)](https://docs.scenario.com/get-started/documentation/content-delivery-network-cdn).

---

*Generated by [Scenario](https://app.scenario.com)*