# Kling 3.0 Omni Transformation
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v1/jobs/createTask:
post:
summary: Kling 3.0 Omni Transformation
deprecated: false
description: >-
## Query Task Status
After submitting a task, you can check the task progress and retrieve
generation results via the unified query endpoint:
Learn how to query task status and obtain generation results
::: tip[]
For production use, we recommend using the `callBackUrl` parameter to
receive automatic notifications when generation completes, rather than
polling the status endpoint.
:::
## Related Resources
Browse all available models
Check account credits and usage status
operationId: kling-3.0-omni-transformation
tags:
- docs/en/Market/Video Models/Kling
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- model
- input
properties:
model:
type: string
enum:
- kling-3.0-omni/transformation
default: kling-3.0-omni/transformation
description: >-
The name of the model used to generate the task. This field
is required.
- This endpoint requires the `kling-3.0-omni/transformation`
model
examples:
- kling-3.0-omni/transformation
callBackUrl:
type: string
format: uri
description: >-
The URL to receive generation task completion updates.
Optional but recommended for production use.
- System will POST task status and results to this URL when
generation completes
- Callback includes generated content URLs and task
information
- Your callback endpoint should accept POST requests with
JSON payload containing results
- Alternatively, use the Get Task Details endpoint to poll
task status
- To ensure callback security, see [Webhook Verification
Guide](/common-api/webhook-verification) for signature
verification implementation
examples:
- https://your-domain.com/api/callback
input:
type: object
description: Input parameters for the generation task.
oneOf:
- title: Video Input Only
type: object
required:
- prompt
- video_urls
properties:
prompt:
type: string
minLength: 1
maxLength: 3072
description: >-
Video description. It must not be empty after
leading and trailing whitespace is removed. Maximum
length: 3,072 characters.
examples:
- >-
Transform the input video into a cinematic night
scene while preserving the character movements
from the original video.
video_urls:
type: array
description: >-
Array of video URLs. Exactly 1 video is required.
HTTP, HTTPS, and OSS URLs are supported. Videos must
be in MP4 or MOV format; each file must not exceed
200 MB; duration must be between 3 and 15.5 seconds;
width and height must each be between 700 and 4,553
px; total pixels must not exceed 8,294,400; the
aspect ratio must be between 0.4 and 2; and the
frame rate must be between 24 and 60 fps.
minItems: 1
maxItems: 1
items:
type: string
format: uri
pattern: ^(https?|oss)://
examples:
- - https://example.com/source-video.mp4
resolution:
type: string
description: >-
Video resolution. `720p` outputs a 720p video,
`1080p` outputs a 1080p video, and `4k` outputs a 4K
video.
enum:
- 720p
- 1080p
- 4k
default: 720p
examples:
- 720p
aspect_ratio:
type: string
description: >-
Video aspect ratio. Only `auto` can be used with
video-only input.
enum:
- auto
default: auto
examples:
- auto
audio:
type: boolean
description: >-
No audio is generated when a video is provided; set
false.
enum:
- false
- true
examples:
- false
elements:
type: array
items:
type: object
required:
- name
- description
- element_input_urls
properties:
name:
type: string
description: >-
Subject name. It must be unique within the
same request and can be referenced in the
`prompt` field using `@name`.
minLength: 1
examples:
- element_dog
description:
type: string
description: Text description of the subject asset.
minLength: 1
examples:
- A happy golden retriever
element_input_urls:
type: array
description: >-
List of image URLs for a multi-image subject
(provide 2 to 4 images), or a video URL for a
video character subject (provide exactly 1
video). Images and videos cannot be mixed.
HTTP, HTTPS, and OSS URLs are supported.
minItems: 1
maxItems: 4
items:
type: string
format: uri
pattern: ^(https?|oss)://
examples:
- - https://example.com/dog-front.png
- https://example.com/dog-side.png
element_input_audio_urls:
type: array
description: >-
Optional list of subject audio asset URLs.
HTTP, HTTPS, and OSS URLs are supported.
default: []
items:
type: string
format: uri
pattern: ^(https?|oss)://
examples:
- []
x-apidog-orders:
- name
- description
- element_input_urls
- element_input_audio_urls
x-apidog-ignore-properties: []
description: >-
List of one-time subject assets. The default is an
empty array.
When using only multi-image subjects, up to 7
subjects can be uploaded.
When using only video character subjects, the number
of video character subjects must not exceed 3.
When using both video character and multi-image
subjects, the number of video character subjects
must not exceed 3, and the number of multi-image
subjects must not exceed 4.
default: []
additionalProperties: false
x-apidog-orders:
- prompt
- video_urls
- resolution
- aspect_ratio
- audio
- elements
x-apidog-ignore-properties: []
- title: Video with Images
type: object
required:
- prompt
- image_urls
- video_urls
properties:
prompt:
type: string
minLength: 1
maxLength: 3072
description: >-
Video description. It must not be empty after
leading and trailing whitespace is removed. Maximum
length: 3,072 characters.
examples:
- >-
Transform the video into a cinematic night scene
using the style of the input images as a
reference.
image_urls:
type: array
description: >-
Array of image URLs, with up to 4 images. HTTP,
HTTPS, and OSS URLs are supported. Images must be in
JPG, JPEG, or PNG format; each file must not exceed
50 MB; both width and height must be at least 300
px; and the aspect ratio must be between 0.4 and
2.5.
maxItems: 4
items:
type: string
format: uri
pattern: ^(https?|oss)://
examples:
- - https://example.com/reference-image.jpg
video_urls:
type: array
description: >-
Array of video URLs. Exactly 1 video is required.
HTTP, HTTPS, and OSS URLs are supported. Videos must
be in MP4 or MOV format; each file must not exceed
200 MB; duration must be between 3 and 15.5 seconds;
width and height must each be between 700 and 4,553
px; total pixels must not exceed 8,294,400; the
aspect ratio must be between 0.4 and 2; and the
frame rate must be between 24 and 60 fps.
minItems: 1
maxItems: 1
items:
type: string
format: uri
pattern: ^(https?|oss)://
examples:
- - https://example.com/source-video.mp4
duration:
type: string
description: >-
Video duration. This field may be configured when
using a video with images.
examples:
- '5'
resolution:
type: string
description: >-
Video resolution. `720p` outputs a 720p video,
`1080p` outputs a 1080p video, and `4k` outputs a 4K
video.
enum:
- 720p
- 1080p
- 4k
default: 720p
examples:
- 720p
aspect_ratio:
type: string
description: >-
Video aspect ratio. When using a video with images,
`16:9`, `9:16`, and `1:1` are supported; `auto` is
not supported.
enum:
- '16:9'
- '9:16'
- '1:1'
default: '16:9'
examples:
- '16:9'
audio:
type: boolean
description: >-
No audio is generated when a video is provided; set
false.
enum:
- false
- true
examples:
- false
elements:
type: array
items:
type: object
required:
- name
- description
- element_input_urls
properties:
name:
type: string
description: >-
Subject name. It must be unique within the
same request and can be referenced in the
`prompt` field using `@name`.
minLength: 1
examples:
- element_dog
description:
type: string
description: Text description of the subject asset.
minLength: 1
examples:
- A happy golden retriever
element_input_urls:
type: array
description: >-
List of image URLs for a multi-image subject
(provide 2 to 4 images), or a video URL for a
video character subject (provide exactly 1
video). Images and videos cannot be mixed.
HTTP, HTTPS, and OSS URLs are supported.
minItems: 1
maxItems: 4
items:
type: string
format: uri
pattern: ^(https?|oss)://
examples:
- - https://example.com/dog-front.png
- https://example.com/dog-side.png
element_input_audio_urls:
type: array
description: >-
Optional list of subject audio asset URLs.
HTTP, HTTPS, and OSS URLs are supported.
default: []
items:
type: string
format: uri
pattern: ^(https?|oss)://
examples:
- []
x-apidog-orders:
- name
- description
- element_input_urls
- element_input_audio_urls
x-apidog-ignore-properties: []
description: >-
List of one-time subject assets. The default is an
empty array.
When using only multi-image subjects, up to 7
subjects can be uploaded.
When using only video character subjects, the number
of video character subjects must not exceed 3.
When using both video character and multi-image
subjects, the number of video character subjects
must not exceed 3, and the number of multi-image
subjects must not exceed 4.
default: []
additionalProperties: false
x-apidog-orders:
- prompt
- image_urls
- video_urls
- duration
- resolution
- aspect_ratio
- audio
- elements
x-apidog-ignore-properties: []
x-apidog-orders:
- prompt
- video_urls
- image_urls
- duration
- resolution
- aspect_ratio
- audio
- elements
properties:
prompt:
type: string
minLength: 1
maxLength: 3072
description: >-
Video description. It must not be empty after leading
and trailing whitespace is removed. Maximum length:
3,072 characters.
examples:
- >-
Transform the input video into a cinematic night scene
while preserving the character movements from the
original video.
video_urls:
type: array
description: >-
Array of video URLs. Exactly 1 video is required. HTTP,
HTTPS, and OSS URLs are supported. Videos must be in MP4
or MOV format; each file must not exceed 200 MB;
duration must be between 3 and 15.5 seconds; width and
height must each be between 700 and 4,553 px; total
pixels must not exceed 8,294,400; the aspect ratio must
be between 0.4 and 2; and the frame rate must be between
24 and 60 fps.
minItems: 1
maxItems: 1
items:
type: string
format: uri
pattern: ^(https?|oss)://
examples:
- - https://example.com/source-video.mp4
image_urls:
type: array
description: >-
Array of image URLs. The maximum number of images
depends on the number and types of reference subjects.
When using only multi-image subjects, the combined
number of reference images and multi-image subjects must
not exceed 4. Video character subjects cannot be used
together with multi-image subjects or reference images.
HTTP, HTTPS, and OSS URLs are supported. Images must be
in JPG, JPEG, or PNG format; each file must not exceed
50 MB; both width and height must be at least 300 px;
and the aspect ratio must be between 0.4 and 2.5.
maxItems: 4
items:
type: string
format: uri
pattern: ^(https?|oss)://
examples:
- - https://example.com/reference-image.jpg
duration:
type: string
description: >-
Video duration. This field may be configured when using
a video with images.
examples:
- '5'
resolution:
type: string
description: >-
Video resolution. `720p` outputs a 720p video, `1080p`
outputs a 1080p video, and `4k` outputs a 4K video.
enum:
- 720p
- 1080p
- 4k
default: 720p
examples:
- 720p
aspect_ratio:
type: string
description: >-
Video aspect ratio. Only `auto` can be used with
video-only input. When using a video with images,
`16:9`, `9:16`, and `1:1` are supported; `auto` is not
supported.
enum:
- '16:9'
- '9:16'
- '1:1'
- auto
default: '16:9'
examples:
- '16:9'
audio:
type: boolean
description: >-
No audio is generated when a video is provided; set
false.
enum:
- false
- true
examples:
- false
elements:
type: array
items:
type: object
required:
- name
- description
- element_input_urls
properties:
name:
type: string
description: >-
Subject name. It must be unique within the same
request and can be referenced in the `prompt`
field using `@name`.
minLength: 1
examples:
- element_dog
description:
type: string
description: Text description of the subject asset.
minLength: 1
examples:
- A happy golden retriever
element_input_urls:
type: array
description: >-
List of image URLs for a multi-image subject
(provide 2 to 4 images), or a video URL for a
video character subject (provide exactly 1 video).
Images and videos cannot be mixed. HTTP, HTTPS,
and OSS URLs are supported.
minItems: 1
maxItems: 4
items:
type: string
format: uri
pattern: ^(https?|oss)://
examples:
- - https://example.com/dog-front.png
- https://example.com/dog-side.png
element_input_audio_urls:
type: array
description: >-
Optional list of subject audio asset URLs. HTTP,
HTTPS, and OSS URLs are supported.
default: []
items:
type: string
format: uri
pattern: ^(https?|oss)://
examples:
- []
x-apidog-orders:
- name
- description
- element_input_urls
- element_input_audio_urls
x-apidog-ignore-properties: []
description: >-
List of one-time subject assets. The default is an empty
array.
When using only multi-image subjects, up to 7 subjects
can be uploaded.
When using only video character subjects, the number of
video character subjects must not exceed 3.
When using both video character and multi-image
subjects, the number of video character subjects must
not exceed 3, and the number of multi-image subjects
must not exceed 4.
default: []
x-apidog-ignore-properties: []
x-apidog-orders:
- model
- callBackUrl
- input
examples:
- model: kling-3.0-omni/transformation
callBackUrl: https://your-domain.com/api/callback
input:
prompt: >-
Transform the input video into a cinematic night scene
while preserving the character movements from the original
video.
video_urls:
- https://example.com/source-video.mp4
resolution: 720p
aspect_ratio: auto
audio: false
- model: kling-3.0-omni/transformation
callBackUrl: https://your-domain.com/api/callback
input:
prompt: >-
Transform the video into a cinematic night scene using the
visual style of the reference image.
image_urls:
- https://example.com/reference-image.jpg
video_urls:
- https://example.com/source-video.mp4
duration: '5'
resolution: 720p
aspect_ratio: '16:9'
audio: false
x-apidog-ignore-properties: []
examples: {}
responses:
'200':
description: Request Successful
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/response%20not%20with%20recordId'
example:
code: 200
msg: success
data:
taskId: task_kling-2.6_1765182425861
headers: {}
x-apidog-name: ''
security:
- BearerAuth: []
x-apidog:
schemeGroups:
- id: kn8M4YUlc5i0A0179ezwx
schemeIds:
- BearerAuth
required: true
use:
id: kn8M4YUlc5i0A0179ezwx
scopes:
kn8M4YUlc5i0A0179ezwx:
BearerAuth: []
callbacks:
videoTaskCompleted:
'{request.body#/callBackUrl}':
post:
description: >-
The system sends this callback when the
`kling-3.0-omni/transformation` task succeeds or fails.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- code
- msg
- data
properties:
code:
type: integer
description: >-
Unified callback code: 200 for success, 501 for
failure.
enum:
- 200
- 501
msg:
type: string
description: Unified callback message.
enum:
- Playground task completed successfully.
- Playground task failed.
data:
type: object
required:
- taskId
- model
- state
- param
properties:
taskId:
type: string
description: The unique task identifier.
model:
type: string
description: The model used for the task.
enum:
- kling-3.0-omni/transformation
state:
type: string
description: Terminal task state.
enum:
- success
- fail
param:
type: string
description: >-
JSON string containing the submitted task
parameters.
resultJson:
type: string
nullable: true
description: >-
JSON string containing resultUrls,
firstFrameUrl, lastFrameUrl, or resultObject
when successful. Present only when state is
success.
failCode:
type: string
nullable: true
description: >-
Failure code, a numeric string such as "400" or
"500". Present only when state is fail.
failMsg:
type: string
nullable: true
description: Failure reason. Present only when state is fail.
costTime:
type: integer
format: int64
description: >-
Processing time in seconds. Present on both
success and failure callbacks.
completeTime:
type: integer
format: int64
description: Task completion timestamp.
createTime:
type: integer
format: int64
description: Task creation timestamp.
updateTime:
type: integer
format: int64
description: >-
Use completeTime as the completion time;
updateTime may equal createTime.
creditsConsumed:
type: number
description: >-
Credits consumed by the task; 0 for failed
tasks.
examples:
success:
summary: Task completed successfully
value:
code: 200
msg: Playground task completed successfully.
data:
taskId: task_example_video_webhook_001
model: kling-3.0-omni/transformation
state: success
param: >-
{"input":"{\"prompt\":\"Transform the input video
into a cinematic night scene while preserving the
character movements from the original
video.\",\"video_urls\":[\"https://example.com/source-video.mp4\"],\"resolution\":\"720p\",\"aspect_ratio\":\"auto\",\"audio\":false}","callBackUrl":"https://example.com/callback","model":"kling-3.0-omni/transformation"}
resultJson: >-
{"resultUrls":["https://example.com/generated-video.mp4"]}
costTime: 12
completeTime: 1234567890
createTime: 1234560000
updateTime: 1234567890
creditsConsumed: 1.23
failure:
summary: Task failed
value:
code: 501
msg: Playground task failed.
data:
taskId: task_example_video_webhook_001
model: kling-3.0-omni/transformation
state: fail
param: >-
{"input":"{\"prompt\":\"Transform the input video
into a cinematic night scene while preserving the
character movements from the original
video.\",\"video_urls\":[\"https://example.com/source-video.mp4\"],\"resolution\":\"720p\",\"aspect_ratio\":\"auto\",\"audio\":false}","callBackUrl":"https://example.com/callback","model":"kling-3.0-omni/transformation"}
failCode: '400'
failMsg:
costTime: 12
creditsConsumed: 0
responses:
'200':
description: Callback received successfully.
content:
application/json:
schema:
type: object
properties:
code:
type: integer
example: 200
msg:
type: string
example: success
example:
code: 200
msg: success
x-apidog-folder: docs/en/Market/Video Models/Kling
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/1184766/apis/api-41795699-run
components:
schemas:
response not with recordId:
type: object
required:
- data
properties:
code:
type: integer
description: >-
Status code of the request. The HTTP status is 200 even when the
request fails, so always check this field: 200 means success; any
other value means the request failed and msg describes the reason.
Common values: 401 invalid or missing API key; 402 insufficient
credits; 429 rate limit exceeded; 422 or 500 the request could not
be processed (read msg and check your parameters before retrying).
enum:
- 200
- 401
- 402
- 404
- 422
- 429
- 433
- 455
- 500
- 501
- 505
msg:
type: string
description: Response message, error description upon failure
examples:
- success
data:
type: object
required:
- taskId
properties:
taskId:
type: string
description: >-
The task ID can be used with the "Get Task Details" endpoint to
query the task status.
examples:
- dc1928bfcbc77cb6c85f3359a9c718b3
x-apidog-orders:
- taskId
x-apidog-ignore-properties: []
x-apidog-orders:
- code
- msg
- data
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes:
BearerAuth:
type: bearer
scheme: bearer
bearerFormat: API Key
description: >-
All API requests require a Bearer Token. Add the header `Authorization:
Bearer YOUR_API_KEY` to authenticate requests.
BearerAuth1:
type: bearer
scheme: bearer
bearerFormat: API Key
description: >-
所有 API 请求都需要 Bearer Token。请在请求头中添加 `Authorization: Bearer YOUR_API_KEY`
进行身份验证。
servers:
- url: https://api.kie.ai
description: 正式环境
security:
- BearerAuth: []
x-apidog:
schemeGroups:
- id: kn8M4YUlc5i0A0179ezwx
schemeIds:
- BearerAuth
required: true
use:
id: kn8M4YUlc5i0A0179ezwx
scopes:
kn8M4YUlc5i0A0179ezwx:
BearerAuth: []
```