# Kling V2.1 Pro
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v1/jobs/createTask:
post:
summary: Kling V2.1 Pro
deprecated: false
description: >
## Query Task Status
After submitting a task, use the unified query endpoint to check
progress and retrieve results:
Learn how to query task status and retrieve 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
Explore all available models
Check credits and account usage
operationId: kling-v2-1-pro
tags:
- docs/en/Market/Video Models/Kling
parameters: []
requestBody:
content:
application/json:
schema:
type: object
required:
- model
properties:
model:
type: string
enum:
- kling/v2-1-pro
default: kling/v2-1-pro
description: |-
The model name to use for generation. Required field.
- Must be `kling/v2-1-pro` for this endpoint
examples:
- kling/v2-1-pro
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
properties:
prompt:
description: >-
Text prompt describing the video to generate (Max
length: 5000 characters)
type: string
maxLength: 5000
examples:
- >-
POV shot of a gravity surfer diving between ancient
ruins suspended midair, glowing moss lights the path,
the board hisses as it carves through thin mist,
echoes rise with speed
image_url:
description: >-
URL of the image to be used for the video (File URL
after upload, not file content; Accepted types:
image/jpeg, image/png; Max size: 10.0MB)
type: string
examples:
- https://example.com/your-image.png
duration:
description: Required. "5" or "10" (seconds).
type: string
enum:
- '5'
- '10'
examples:
- '5'
negative_prompt:
description: >-
Terms to avoid in the generated video (Max length: 500
characters)
type: string
maxLength: 500
examples:
- blur, distort, and low quality
cfg_scale:
description: >-
The CFG (Classifier Free Guidance) scale is a measure of
how close you want the model to stick to your prompt
(Min: 0, Max: 1, Step: 0.1) (step: 0.1)
type: number
minimum: 0
maximum: 1
default: 0.5
examples:
- 0.5
tail_image_url:
description: >-
URL of the image to be used for the end of the video
(File URL after upload, not file content; Accepted
types: image/jpeg, image/png; Max size: 10.0MB)
type: string
examples:
- ''
required:
- prompt
- image_url
- duration
x-apidog-orders:
- prompt
- image_url
- duration
- negative_prompt
- cfg_scale
- tail_image_url
x-apidog-ignore-properties: []
x-apidog-orders:
- model
- callBackUrl
- input
x-apidog-ignore-properties: []
example:
model: kling/v2-1-pro
callBackUrl: https://your-domain.com/api/callback
input:
prompt: >-
POV shot of a gravity surfer diving between ancient ruins
suspended midair, glowing moss lights the path, the board
hisses as it carves through thin mist, echoes rise with speed
image_url: https://example.com/your-image.png
duration: '5'
negative_prompt: blur, distort, and low quality
cfg_scale: 0.5
tail_image_url: ''
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_1765187774173
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/v2-1-pro` 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/v2-1-pro
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/v2-1-pro
state: success
param: >-
{"input":"{\"prompt\":\"POV shot of a gravity
surfer diving between ancient ruins suspended
midair, glowing moss lights the path, the board
h...\",\"image_url\":\"https://example.com/input-image.jpg\",\"duration\":\"5\",\"negative_prompt\":\"blur,
distort, and low
quality\",\"cfg_scale\":0.5,\"tail_image_url\":\"https://example.com/input-image.jpg\"}","callBackUrl":"https://example.com/callback","model":"kling/v2-1-pro"}
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/v2-1-pro
state: fail
param: >-
{"input":"{\"prompt\":\"POV shot of a gravity
surfer diving between ancient ruins suspended
midair, glowing moss lights the path, the board
h...\",\"image_url\":\"https://example.com/input-image.jpg\",\"duration\":\"5\",\"negative_prompt\":\"blur,
distort, and low
quality\",\"cfg_scale\":0.5,\"tail_image_url\":\"https://example.com/input-image.jpg\"}","callBackUrl":"https://example.com/callback","model":"kling/v2-1-pro"}
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-28506389-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: []
```