v1

latestOpenAPI 3.0.32026-07-241112213.6 KB

Submit Text to Video Generation Task

Convert text prompts to video content. Supports multiple AI models with customizable resolution, aspect ratio, duration, and other parameters. Returns a taskId for asynchronous result polling.

post/v1/common_task/text2video/task/submit

Headers

Topview-Uidstring required

User ID

Authorizationstring required

API Key for authentication

Request body

modelstring required

Model name, e.g., 'Seedance 1.5 pro', 'Kling V3', 'Sora 2', 'Topview Pro', etc.

promptstring required

Positive prompt describing the video content to generate (required)

aspectRatiostring

Aspect ratio such as '16:9', '9:16', '1:1', etc. (optional, depends on model support)

resolution480 | 720 | 1080

Video resolution: 480 or 720 or 1080 (optional)

durationinteger

Video duration in seconds. Supported values depend on the model used (optional)

sound'on' | 'off'

Whether to include sound effects: 'on' or 'off' (optional, default: 'off')

generatingCountinteger

Number of videos to generate: 1-4 (optional, default: 1)

boardIdstring

Board ID. When provided, creates a board task record in the system (optional)

noticeUrlstring

Please refer to the API documentation for details NoticeUrl

Response

Task submitted successfully

codestring

messagestring

Example response

{
  "code": "200",
  "message": "Success"
}