# Kling V3 Omni Video — API Reference

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

---

## Authentication

Scenario API uses HTTP Basic Auth. Encode your credentials in Base64 and pass them as the `Authorization` header.

```
Authorization: Basic base64("<API_KEY>:<API_SECRET>")
```

- **API_KEY** and **API_SECRET** are found in your [Scenario Project Settings](https://app.scenario.com/team&tab=project_api_keys) under API Keys.
- In shell: `$(echo -n '<API_KEY>:<API_SECRET>' | base64)`
- In JavaScript: `btoa("<API_KEY>:<API_SECRET>")`
- In Python: `base64.b64encode(f"{api_key}:{api_secret}".encode()).decode()`

---

## 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. |
| `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. |
| `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 requests
import base64

api_key = "<API_KEY>"
api_secret = "<API_SECRET>"
token = base64.b64encode(f"{api_key}:{api_secret}".encode()).decode()

url = "https://api.cloud.scenario.com/v1/generate/custom/model_kling-v3-omni-video"
headers = {
    "Authorization": f"Basic {token}",
    "Content-Type": "application/json"
}
payload = {
    "prompt": "A fantasy landscape",
    "videoReferenceType": "feature",
    "keepOriginalSound": True,
    "generateAudio": False,
    "mode": "pro",
    "aspectRatio": "16:9",
    "duration": 5
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())
```

**JavaScript**

```javascript
const token = btoa("<API_KEY>:<API_SECRET>");

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

const response = await fetch(
  "https://api.cloud.scenario.com/v1/generate/custom/model_kling-v3-omni-video",
  {
    method: "POST",
    headers: {
      "Authorization": `Basic ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify(body),
  }
);

const data = await response.json();
console.log(data);
```

---

## Retrieve Results

After submitting a generation request, you receive a `jobId`. Poll the job status endpoint until the job completes.

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

**Headers:**
```
Authorization: Basic base64("<API_KEY>:<API_SECRET>")
```

Poll until `job.status` is `"success"`. The generated asset IDs are in `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/docs/content-delivery-network-cdn).

---

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