Skip to main content
POST
/
kling-v3-omni-video
/
async
curl --request POST \
  --url https://api.modellix.ai/api/v1/kling/kling-v3-omni-video/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "A woman leaves a subway station and walks into a rainy cyberpunk street, then the camera tracks beside her"
}
'
{
  "code": 0,
  "message": "success",
  "data": {
    "status": "pending",
    "task_id": "task-v2v-def456",
    "model_id": "model-123",
    "get_result": {
      "method": "GET",
      "url": "https://api.modellix.ai/api/v1/tasks/task-v2v-def456"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.modellix.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: Bearer YOUR_API_KEY.

Body

application/json

Conditional rules: when multi_shot=false, prompt is required and shot_type must be omitted. When multi_shot=true, shot_type must be intelligence and prompt is still required. When videos is provided, sound must be off and duration must be omitted.

​
prompt
string
required

Video generation prompt.

Required string length: 1 - 2500
Example:

"Transform the source clip into a cinematic sci-fi sequence"

​
multi_shot
boolean
default:false

Enable intelligent multi-shot generation.

Example:

false

​
shot_type
enum<string>

Required when multi_shot is true. Only intelligence is supported in the public API.

Available options:
intelligence
Example:

"intelligence"

​
images
string[]

Optional reference image list.

Minimum array length: 1

Reference image URL or Base64 string.

Minimum string length: 1
​
videos
string[]

Optional reference video list. When provided, sound must be off and duration must be omitted.

Required array length: 1 element

Reference video URL or Base64 string.

Minimum string length: 1
​
sound
enum<string>
default:off

Audio generation switch. Must remain off whenever videos is provided.

Available options:
on,
off
Example:

"off"

​
mode
enum<string>
default:pro

Generation mode.

Available options:
std,
pro
Example:

"pro"

​
aspect_ratio
enum<string>

Video aspect ratio.

Available options:
16:9,
9:16,
1:1
Example:

"16:9"

​
duration
enum<integer>
default:5

Video duration in seconds. Public API accepts integer values. Valid values are 3-15 when videos is not supplied.

Available options:
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15
Example:

8

Response

Task submitted successfully

​
code
integer
required

Response code, 0 indicates success

Example:

0

​
message
string
required

Response message

Example:

"success"

​
data
object
required

Detailed data about the submitted asynchronous task.