Video Generation - Text to Video

Create Task

Protocol	Request URL	Request Method	Request Format	Response Format
https	/v1/videos/text2video	POST	application/json	application/json

Request Header

Field	Value	Description
Content-Type	application/json	Data Exchange Format
Authorization	Authentication information, refer to API authentication	Authentication information, refer to API authentication

Request Body

💡

Please note that in order to maintain naming consistency, the original model field has been changed to model_name, so in the future, please use this field to specify the version of the model that needs to be called.

• At the same time, we keep the behavior forward-compatible, if you continue to use the original model field, it will not have any impact on the interface call, there will not be any exception, which is equivalent to the default behavior when model_name is empty (i.e., call the V1 model).

Field	Type	Required Field	Default	Description
model_name	string	Optional	kling-v1	Model Name Enum values：kling-v1, kling-v1-6, kling-v2-master, kling-v2-1-master
prompt	string	Required	None	Positive text prompt Cannot exceed 2500 characters
negative_prompt	string	Optional	Null	Negative text prompt Cannot exceed 2500 characters
cfg_scale	float	Optional	0.5	Flexibility in video generation; The higher the value, the lower the model’s degree of flexibility, and the stronger the relevance to the user’s prompt. Value range: [0, 1]
mode	string	Optional	std	Video generation mode Enum values: std, pro std: Standard Mode, which is cost-effective pro: Professional Mode, generates videos use longer duration but higher quality video output
camera_control	object	Optional	Null	Terms of controlling camera movement ( If not specified, the model will intelligently match based on the input text/images) The support range for different model versions and video modes varies. For more details, please refer to the current document's "3-0 Capability Map"
camera_control type	string	Optional	None	Predefined camera movements type Enum values: “simple”, “down_back”, “forward_up”, “right_turn_forward”, “left_turn_forward” simple: Camera movement，Under this Type, you can choose one out of six options for camera movement in the “config”. down_back: Camera descends and moves backward ➡️ Pan down and zoom out, Under this Type, the config parameter must be set to “None”. forward_up: Camera moves forward and tilts up ➡️ Zoom in and pan up, the config parameter must be set to “None”. right_turn_forward: Rotate right and move forward ➡️ Rotate right and advance, the config parameter must be set to “None”. left_turn_forward: Rotate left and move forward ➡️ Rotate left and advance, the config parameter must be set to “None”.
camera_control config	object	Optional	None	Contains 6 Fields, used to specify the camera’s movement or change in different directions When the camera movement Type is set to simple, the Required Field must be filled out; when other Types are specified, it should be left blank. Choose one out of the following six parameters, meaning only one parameter should be non-zero, while the rest should be zero.
config horizontal	float	Optional	None	Horizontal, controls the camera’s movement along the horizontal axis (translation along the x-axis). Value range：[-10, 10], a negative Value indicates a translation to the left, while a positive Value indicates a translation to the right.
config vertical	float	Optional	None	Vertical, controls the camera’s movement along the vertical axis (translation along the y-axis). Value range：[-10, 10], a negative Value indicates a downward translation, while a positive Value indicates an upward translation.
config pan	float	Optional	None	Pan, controls the camera’s rotation in the vertical plane (rotation around the x-axis). Value range：[-10, 10]，a negative Value indicates a downward rotation around the x-axis, while a positive Value indicates an upward rotation around the x-axis.
config tilt	float	Optional	None	Tilt, controls the camera’s rotation in the horizontal plane (rotation around the y-axis). Value range：[-10, 10]，a negative Value indicates a rotation to the left around the y-axis, while a positive Value indicates a rotation to the right around the y-axis.
config roll	float	Optional	None	Roll, controls the camera’s rolling amount (rotation around the z-axis). Value range：[-10, 10]，a negative Value indicates a counterclockwise rotation around the z-axis, while a positive Value indicates a clockwise rotation around the z-axis.
config zoom	float	Optional	None	Zoom, controls the change in the camera’s focal length, affecting the proximity of the field of view. Value range：[-10, 10], A negative Value indicates an increase in focal length, resulting in a narrower field of view, while a positive Value indicates a decrease in focal length, resulting in a wider field of view.
aspect_ratio	string	Optional	16:9	The aspect ratio of the generated video frame (width:height) Enum values：16:9, 9:16, 1:1
duration	string	Optional	5	Video Length, unit: s (seconds) Enum values: 5，10
callback_url	string	Optional	None	The callback notification address for the result of this task. If configured, the server will actively notify when the task status changes The specific message schema of the notification can be found in “Callback Protocol”
external_task_id	string	Optional	None	Customized Task ID Users can provide a customized task ID, which will not overwrite the system-generated task ID but can be used for task queries. Please note that the customized task ID must be unique within a single user account.

Response Body

JSONCopyCollapse

1234567891011121314{
  "code": 0, //Error codes；Specific definitions can be found in "Error Code"
  "message": "string", //Error information
  "request_id": "string", //Request ID, generated by the system
  "data":{
  	"task_id": "string", //Task ID, generated by the system
    "task_status": "string", //Task status, Enum values：submitted、processing、succeed、failed
    "task_info":{ //Task creation parameters
    	"external_task_id": "string" //Customer-defined task ID
    },
    "created_at": 1722769557708, //Task creation time, Unix timestamp, unit ms
    "updated_at": 1722769557708 //Task update time, Unix timestamp, unit ms
  }
}

Query Task (Single)

Protocol	Request URL	Request Method	Request Format	Response Format
https	/v1/videos/text2video/{id}	GET	application/json	application/json

Request Header

Field	Value	Description
Content-Type	application/json	Data Exchange Format
Authorization	Authentication information, refer to API authentication	Authentication information, refer to API authentication

Request Path Parameters

Field	Type	Required Field	Default	Description
task_id	string	Optional	None	Task ID for Text to Video Request Path Parameters，directly fill the Value in the request path When creating a task, you can choose to query by external_task_id or task_id.
external_task_id	string	Optional	None	Customized Task ID for Text-to-Video Request Path Parameters，directly fill the Value in the request path When creating a task, you can choose to query by external_task_id or task_id.

Request Body

None

Response Body

JSONCopyCollapse

123456789101112131415161718192021222324{
  "code": 0, //Error codes；Specific definitions can be found in "Error Code"
  "message": "string", //Error information
  "request_id": "string", //Request ID, generated by thTask ID, generated by the system is used to track requests and troubleshoot problems
  "data":{
  	"task_id": "string", //Task ID, generated by the system
    "task_status": "string", //Task status, Enum values：submitted、processing、succeed、failed
    "task_status_msg": "string", //Task status information, displaying the failure reason when the task fails (such as triggering the content risk control of the platform, etc.)
    "task_info":{ //Task creation parameters
    	"external_task_id": "string" //Customer-defined task ID
    },
    "created_at": 1722769557708, //Task creation time, Unix timestamp, unit: ms
    "updated_at": 1722769557708, //Task update time, Unix timestamp, unit: ms
    "task_result":{
      "videos":[
        {
        	"id": "string", //Generated video ID; globally unique
      		"url": "string", //URL for generating videos，such as https://p1.a.kwimgs.com/bs2/upload-ylab-stunt/special-effect/output/HB1_PROD_ai_web_46554461/-2878350957757294165/output.mp4(To ensure information security, generated images/videos will be cleared after 30 days. Please make sure to save them promptly.)
      		"duration": "string" //Total video duration, unit: s (seconds)
        }
      ]
    }
  }
}