Appearance
Kling-3.0 motion-control
OpenAPI Specification
yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/v1/jobs/createTask:
post:
summary: Kling-3.0 motion-control
deprecated: false
description: >
## File Upload Requirements
Before using the Motion Control API, you need to upload your image and
video files:
<Step title="Upload Reference Image">
Use the File Upload API to upload your reference image showing the subject.
**File Upload API**
Learn how to upload images and get file URLs
**Requirements:**
- **File Type**: JPEG, PNG, or JPG format
- **Max File Size**: 10MB per file, size needs to be greater than 340px, aspect ratio 2:5 to 5:2.
- **Content**: Clear image showing the subject's head, shoulders, and torso
</Step>
<Step title="Upload Motion Video">
Upload a video that defines the motion pattern you want to apply.
**Requirements:**
- **File Type**: MP4, or QuickTime format
- **Duration**: Between 3-30 seconds per video
- **Max File Size**: 100MB per file, size needs to be greater than 340px, aspect ratio 2:5 to 5:2.
- **Content**: Video clearly showing the subject's head, shoulders, and torso
</Step>
<Step title="Get File URLs">
After upload, you'll receive file URLs that you can use in the `input_urls` and `video_urls` parameters.
</Step>
::: warning[]
- Supported image formats: JPEG, PNG, JPG (Max: 10MB), size needs to be
greater than 340px, aspect ratio 2:5 to 5:2.
- Supported video formats: MP4, QuickTime (Max: 100MB, 3-30 seconds),
size needs to be greater than 340px, aspect ratio 2:5 to 5:2.
- Videos must clearly show the subject's head, shoulders, and torso
- Maximum one image and one video per request
:::
## Query Task Status
After submitting a task, use the unified query endpoint to check
progress and retrieve results:
**Get Task Details**
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
**Market Overview**
Explore all available models
**Common API**
Check credits and account usage
tags:
- docs/en/Market/Video Models/Kling
parameters: []
requestBody:
content:
application/json:
schema:
type: object
properties:
model:
type: string
description: |-
The model name to use for generation. Required field.
- Must be `kling-3.0/motion-control` for this endpoint
enum:
- kling-3.0/motion-control
x-apidog-enum:
- value: kling-3.0/motion-control
name: ''
description: ''
default: kling-3.0/motion-control
examples:
- kling-3.0/motion-control
callBackUrl:
description: >-
Callback address. Once the model is generated, it will
notify this URL.
type: string
input:
type: object
properties:
prompt:
description: >-
(Optional) Text prompt words, used to guide the
generation of animation content. Can be empty or 0 -
2500 characters long.
type: string
input_urls:
type: array
items:
type: string
description: (Required) Include a URL of an image
video_urls:
type: array
items:
type: string
description: (Required) Include a video URL
mode:
description: >-
(Optional) Video Quality Mode. std: Standard Mode
(720p). pro: Professional Mode (1080p)
type: string
character_orientation:
description: >-
(Optional) Reference source for character orientation.
video: Refer to video (recommended); image: Refer to
image. Default value: video
type: string
background_source:
description: >-
(Optional) Background source. input_video: Use video
background; input_image: Use image background. Default
value: input_video
type: string
required:
- input_urls
- video_urls
x-apidog-orders:
- prompt
- input_urls
- video_urls
- mode
- character_orientation
- background_source
x-apidog-ignore-properties: []
required:
- model
- callBackUrl
- input
x-apidog-orders:
- model
- callBackUrl
- input
x-apidog-ignore-properties: []
example:
model: kling-3.0/motion-control
callBackUrl: https://your-domain.com/api/callback
input:
prompt: The cartoon character is dancing.
input_urls:
- >-
https://static.aiquickdraw.com/tools/example/1767694885407_pObJoMcy.png
video_urls:
- >-
https://static.aiquickdraw.com/tools/example/1767525918769_QyvTNib2.mp4
mode: 720p
character_orientation: image
background_source: input_video
responses:
'200':
description: Request successful
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
example:
code: 200
msg: success
data:
taskId: task_kling-3.0_1734696787838
headers: {}
x-apidog-name: 成功
'500':
description: request failed
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: >-
Response status code
- **200**: Success - Request has been processed
successfully
- **401**: Unauthorized - Authentication credentials are
missing or invalid
- **402**: Insufficient Credits - Account does not have
enough credits to perform the operation
- **404**: Not Found - The requested resource or endpoint
does not exist
- **408**: Upstream is currently experiencing service
issues. No result has been returned for over 10 minutes.
- **422**: Validation Error - The request parameters
failed validation checks
- **429**: Rate Limited - Request limit has been exceeded
for this resource
- **455**: Service Unavailable - System is currently
undergoing maintenance
- **500**: Server Error - An unexpected error occurred
while processing the request
- **501**: Generation Failed - Content generation task
failed
- **505**: Feature Disabled - The requested feature is
currently disabled
msg:
type: string
description: Response message, error description when failed
data:
type: object
properties: {}
x-apidog-orders: []
x-apidog-ignore-properties: []
x-apidog-orders:
- code
- msg
- data
required:
- code
- msg
- data
x-apidog-ignore-properties: []
example:
code: 500
msg: >-
Server Error - An unexpected error occurred while processing
the request
data: null
headers: {}
x-apidog-name: 'Error '
security:
- BearerAuth: []
x-apidog:
schemeGroups:
- id: kn8M4YUlc5i0A0179ezwx
schemeIds:
- BearerAuth
required: true
use:
id: kn8M4YUlc5i0A0179ezwx
scopes:
kn8M4YUlc5i0A0179ezwx:
BearerAuth: []
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-30079657-run
components:
schemas:
ApiResponse:
type: object
properties:
code:
type: integer
description: >-
Response status code
- **200**: Success - Request has been processed successfully
- **401**: Unauthorized - Authentication credentials are missing or
invalid
- **402**: Insufficient Credits - Account does not have enough
credits to perform the operation
- **404**: Not Found - The requested resource or endpoint does not
exist
- **422**: Validation Error - The request parameters failed
validation checks
- **429**: Rate Limited - Request limit has been exceeded for this
resource
- **433**: Request Limit - Sub-key Usage Exceeds Limit
- **455**: Service Unavailable - System is currently undergoing
maintenance
- **500**: Server Error - An unexpected error occurred while
processing the request
- **501**: Generation Failed - Content generation task failed
- **505**: Feature Disabled - The requested feature is currently
disabled
enum:
- 200
- 401
- 402
- 404
- 422
- 429
- 433
- 455
- 500
- 501
- 505
x-apidog-enum:
- value: 200
name: ''
description: ''
- value: 401
name: ''
description: ''
- value: 402
name: ''
description: ''
- value: 404
name: ''
description: ''
- value: 422
name: ''
description: ''
- value: 429
name: ''
description: ''
- value: 433
name: ''
description: ''
- value: 455
name: ''
description: ''
- value: 500
name: ''
description: ''
- value: 501
name: ''
description: ''
- value: 505
name: ''
description: ''
msg:
type: string
description: Response message, error description when failed
examples:
- success
data:
type: object
properties:
taskId:
type: string
description: >-
Task ID, can be used with Get Task Details endpoint to query
task status
x-apidog-orders:
- taskId
required:
- taskId
x-apidog-ignore-properties: []
x-apidog-orders:
- code
- msg
- data
title: response not with recordId
required:
- data
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes:
BearerAuth:
type: bearer
scheme: bearer
bearerFormat: API Key
description: |-
所有 API 都需要通过 Bearer Token 进行身份验证。
获取 API Key：
1. 访问 API Key 管理页面 获取您的 API Key
使用方法：
在请求头中添加：
Authorization: Bearer YOUR_API_KEY
注意事项：
- 请妥善保管您的 API Key，切勿泄露给他人
- 若怀疑 API Key 泄露，请立即在管理页面重置
BearerAuth1:
type: bearer
scheme: bearer
bearerFormat: API Key
description: |-
所有 API 都需要通过 Bearer Token 进行身份验证。
获取 API Key：
1. 访问 API Key 管理页面 获取您的 API Key
使用方法：
在请求头中添加：
Authorization: Bearer YOUR_API_KEY
注意事项：
- 请妥善保管您的 API Key，切勿泄露给他人
- 若怀疑 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: []