One Click General Film

One Click General Film | Vidu API

API REFERENCE

Update Notice

Video Generating

Image Generating

Reference To Image

Audio Generating

Other Generating

Solutions

Task Management

On this page

Overview

API REFERENCE

Update Notice

Video Generating

Image Generating

Reference To Image

Audio Generating

Other Generating

Solutions

Task Management

Solutions

[ One Click General Film ] Instruction

POST https://api.vidu.com/ent/v2/one-click/general_one_click

Field	Value	Description
Content-Type	application/json	Data Exchange Format
Authorization	Token \{your api key\}	Replace \{your api key\} with your token

Field	Required to pass	Type	Description
images	is	Array[String]	Model images or style images when users generating Note 1: Supports passing in Base64-encoded images or image URLs (ensure they are accessible); Note 2: Supports inputting 1 to 7 images; Note 3: Images support png, jpeg, jpg, webp formats; Note 4: The aspect ratio of the image needs to be less than 1:4 or 4:1; Note 5: The size of the image does not exceed 50 MB; Note 6: Please note that the byte length after base64 decode needs to be less than 10M, and the encoding must include an appropriate content type string, for example: `data:image/png;base64,(base64_encode)`
prompt	Optional	string	User Prompt Generate a text description for the video Note 1: The character length cannot exceed 3000 characters
aspect_ratio	Optional	string	Output Ratio, default 16:9 可选值 1:1、16:9、9:16、4:3、3:4
duration	is	Int	Video duration. available: 10 - 180
callback_url	Optional	String	Callback When creating a task, you need to actively set the callback_url with a POST request. When the video generation task changes its status, Vidu will send a callback request to this URL, containing the latest status of the task. The structure of the callback request content will be the same as the return body of the Get Generation API. The "status" in the callback response includes the following states: - processing: Task is being processed. - success: Task is completed (if sending fails, it will retry the callback three times). - failed: Task failed (if sending fails, it will retry the callback three times). Vidu uses a callback signature algorithm for verification, check out the details here: Callback Signature
payload	Optional	String	transparent transmission parameters No processing, only data transmission，with a maximum length of 1048576 characters

Field	Type	Description
id	string	Task ID generated by the vidu for this task

{
  "id": "your_id_here"
}

GET https://api.vidu.com/ent/v2/one-click/general_one_click/{id}

Field	Value	Description
Content-Type	application/json	Data Exchange Format
Authorization	Token \{your api key\}	Replace \{your api key\} with your token

Parameter Name	Type	Required	Parameter Description
id	String	is	Clip ID or subtask ID

Field	Subfield		Type	Description
id			String	Task ID
state			String	Processing Status Optional values: created - Creation successful processing - Task in progress success - Task succeeded failed - Task failed
err_code			String	Error code, see the error code table for details
err_msg			String	Error-related information
created_at			String	Creation Time
signed_url			String	URL of the generated video (available if the video is less than 3 minutes)
job_records			Array	Shot List + Composite Video
	type		String	Optional values: generate_video Video Storyboard compose Compose All Storyboards
	index		Int	Shot Index
	jobs		Array	Single shot modification history
		id	String	job task id
		type	String	generate_video/compose
		state	String	Processing Status Optional values: created - Creation successful processing - Task in progress success - Task succeeded failed - Task failed
		signed_url	String	URL of the storyboard or composite product

{
    "id": "901243326567555072",
    "type": "one_click",
    "creator_id": "869085108764676096",
    "state": "success",
    "input": "",
    "job_records": [
        {
            "type": "generate_video",
            "jobs": [
                {
                    "id": "901245331704909824",
                    "type": "generate_video",
                    "input": "",
                    "output": "",
                    "state": "success",
                    "created_at": "2025-12-24T02:59:06.937309Z",
                    "updated_at": "2025-12-24T02:59:35.473978Z",
                    "err_code": "",
                    "err_msg": "",
                    "signed_url": "your_url",
                    "mv_generate_video_input": {
                        "duration": 3,
                        "prompt": "2.5d建模风格，明亮活泼的色调，极光在北极圈上空舞动，粒子光效闪烁，镜头缓慢推进，营造神秘又欢快的氛围。",
                        "lyric_text": "前奏",
                        "signed_images": []
                    },
                    "index": 0
                }
            ],
            "index": 0
        },
        {
            "type": "compose",
            "jobs": [
                {
                    "id": "901245503243554816",
                    "type": "compose",
                    "input": "",
                    "output": "",
                    "state": "success",
                    "created_at": "2025-12-24T02:59:47.431993Z",
                    "updated_at": "2025-12-24T03:00:13.727780Z",
                    "err_code": "",
                    "err_msg": "",
                    "signed_url": "your_url",
                    "index": 0
                }
            ],
            "index": 0
        }
    ],
    "created_at": "2025-12-24T02:51:34.070650Z",
    "updated_at": "2025-12-24T03:00:13.734086Z",
    "err_code": "",
    "err_msg": "",
    "signed_url": "your_url"
}

POST https://api.vidu.com/ent/v2/one-click/general_one_click/{id}/edit

Field	Value	Description
Content-Type	application/json	Data Exchange Format
Authorization	Token \{your api key\}	Replace \{your api key\} with your token

Field	Required to pass	Type	Description
id	is	String	Task ID, placed in the path
job_id	is	String	ID of the shot to be edited
prompt	is	string	User prompt Generate a text description for the video.. Note 1: The character length cannot exceed 3000 characters
callback_url	Optional	String	Callback When creating a task, you need to actively set the callback_url with a POST request. When the video generation task changes its status, Vidu will send a callback request to this URL, containing the latest status of the task. The structure of the callback request content will be the same as the return body of the Get Generation API. The "status" in the callback response includes the following states： - processing: Task is being processed. - success: Task is completed (if sending fails, it will retry the callback three times). - failed: Task failed (if sending fails, it will retry the callback three times). Vidu uses a callback signature algorithm for verification, check out the details here: Callback Signature

Field	Type	Description
id	string	Task ID generated by the vidu for this task

{
  "id": "your_job_id_here"
}

POST https://api.vidu.com/ent/v2/one-click/general_one_click/{id}/compose

Field	Value	Description
Content-Type	application/json	Data Exchange Format
Authorization	Token \{your api key\}	Replace \{your api key\} with your token

Field	Required to pass	Type	Description
id	is	String	Task ID, placed in the path
job_ids	is	String	ID of the shot to be edited
callback_url	optional	String	Callback When creating a task, you need to actively set the callback_url with a POST request. When the video generation task changes its status, Vidu will send a callback request to this URL, containing the latest status of the task. The structure of the callback request content will be the same as the return body of the GET Generation API. The “status” in the callback response includes the following states: - processing: Task is being processed. - success: Task is completed (if sending fails, it will retry the callback three times). - failed: Task failed (if sending fails, it will retry the callback three times). Vidu uses a callback signature algorithm for verification, check out the details here: Callback Signature

Field	Type	Description
id	string	Task ID generated by the vidu for this task

{
  "id": "your_job_id_here"
}

On this page

Overview

Solutions

[ One Click General Film ] Instruction

POST https://api.vidu.com/ent/v2/one-click/general_one_click

Field	Value	Description
Content-Type	application/json	Data Exchange Format
Authorization	Token \{your api key\}	Replace \{your api key\} with your token

Field	Required to pass	Type	Description
images	is	Array[String]	Model images or style images when users generating Note 1: Supports passing in Base64-encoded images or image URLs (ensure they are accessible); Note 2: Supports inputting 1 to 7 images; Note 3: Images support png, jpeg, jpg, webp formats; Note 4: The aspect ratio of the image needs to be less than 1:4 or 4:1; Note 5: The size of the image does not exceed 50 MB; Note 6: Please note that the byte length after base64 decode needs to be less than 10M, and the encoding must include an appropriate content type string, for example: `data:image/png;base64,(base64_encode)`
prompt	Optional	string	User Prompt Generate a text description for the video Note 1: The character length cannot exceed 3000 characters
aspect_ratio	Optional	string	Output Ratio, default 16:9 可选值 1:1、16:9、9:16、4:3、3:4
duration	is	Int	Video duration. available: 10 - 180
callback_url	Optional	String	Callback When creating a task, you need to actively set the callback_url with a POST request. When the video generation task changes its status, Vidu will send a callback request to this URL, containing the latest status of the task. The structure of the callback request content will be the same as the return body of the Get Generation API. The "status" in the callback response includes the following states: - processing: Task is being processed. - success: Task is completed (if sending fails, it will retry the callback three times). - failed: Task failed (if sending fails, it will retry the callback three times). Vidu uses a callback signature algorithm for verification, check out the details here: Callback Signature
payload	Optional	String	transparent transmission parameters No processing, only data transmission，with a maximum length of 1048576 characters

Field	Type	Description
id	string	Task ID generated by the vidu for this task

{
  "id": "your_id_here"
}

GET https://api.vidu.com/ent/v2/one-click/general_one_click/{id}

Field	Value	Description
Content-Type	application/json	Data Exchange Format
Authorization	Token \{your api key\}	Replace \{your api key\} with your token

Parameter Name	Type	Required	Parameter Description
id	String	is	Clip ID or subtask ID

Field	Subfield		Type	Description
id			String	Task ID
state			String	Processing Status Optional values: created - Creation successful processing - Task in progress success - Task succeeded failed - Task failed
err_code			String	Error code, see the error code table for details
err_msg			String	Error-related information
created_at			String	Creation Time
signed_url			String	URL of the generated video (available if the video is less than 3 minutes)
job_records			Array	Shot List + Composite Video
	type		String	Optional values: generate_video Video Storyboard compose Compose All Storyboards
	index		Int	Shot Index
	jobs		Array	Single shot modification history
		id	String	job task id
		type	String	generate_video/compose
		state	String	Processing Status Optional values: created - Creation successful processing - Task in progress success - Task succeeded failed - Task failed
		signed_url	String	URL of the storyboard or composite product

{
    "id": "901243326567555072",
    "type": "one_click",
    "creator_id": "869085108764676096",
    "state": "success",
    "input": "",
    "job_records": [
        {
            "type": "generate_video",
            "jobs": [
                {
                    "id": "901245331704909824",
                    "type": "generate_video",
                    "input": "",
                    "output": "",
                    "state": "success",
                    "created_at": "2025-12-24T02:59:06.937309Z",
                    "updated_at": "2025-12-24T02:59:35.473978Z",
                    "err_code": "",
                    "err_msg": "",
                    "signed_url": "your_url",
                    "mv_generate_video_input": {
                        "duration": 3,
                        "prompt": "2.5d建模风格，明亮活泼的色调，极光在北极圈上空舞动，粒子光效闪烁，镜头缓慢推进，营造神秘又欢快的氛围。",
                        "lyric_text": "前奏",
                        "signed_images": []
                    },
                    "index": 0
                }
            ],
            "index": 0
        },
        {
            "type": "compose",
            "jobs": [
                {
                    "id": "901245503243554816",
                    "type": "compose",
                    "input": "",
                    "output": "",
                    "state": "success",
                    "created_at": "2025-12-24T02:59:47.431993Z",
                    "updated_at": "2025-12-24T03:00:13.727780Z",
                    "err_code": "",
                    "err_msg": "",
                    "signed_url": "your_url",
                    "index": 0
                }
            ],
            "index": 0
        }
    ],
    "created_at": "2025-12-24T02:51:34.070650Z",
    "updated_at": "2025-12-24T03:00:13.734086Z",
    "err_code": "",
    "err_msg": "",
    "signed_url": "your_url"
}

POST https://api.vidu.com/ent/v2/one-click/general_one_click/{id}/edit

Field	Value	Description
Content-Type	application/json	Data Exchange Format
Authorization	Token \{your api key\}	Replace \{your api key\} with your token

Field	Required to pass	Type	Description
id	is	String	Task ID, placed in the path
job_id	is	String	ID of the shot to be edited
prompt	is	string	User prompt Generate a text description for the video.. Note 1: The character length cannot exceed 3000 characters
callback_url	Optional	String	Callback When creating a task, you need to actively set the callback_url with a POST request. When the video generation task changes its status, Vidu will send a callback request to this URL, containing the latest status of the task. The structure of the callback request content will be the same as the return body of the Get Generation API. The "status" in the callback response includes the following states： - processing: Task is being processed. - success: Task is completed (if sending fails, it will retry the callback three times). - failed: Task failed (if sending fails, it will retry the callback three times). Vidu uses a callback signature algorithm for verification, check out the details here: Callback Signature

Field	Type	Description
id	string	Task ID generated by the vidu for this task

{
  "id": "your_job_id_here"
}

POST https://api.vidu.com/ent/v2/one-click/general_one_click/{id}/compose

Field	Value	Description
Content-Type	application/json	Data Exchange Format
Authorization	Token \{your api key\}	Replace \{your api key\} with your token

Field	Required to pass	Type	Description
id	is	String	Task ID, placed in the path
job_ids	is	String	ID of the shot to be edited
callback_url	optional	String	Callback When creating a task, you need to actively set the callback_url with a POST request. When the video generation task changes its status, Vidu will send a callback request to this URL, containing the latest status of the task. The structure of the callback request content will be the same as the return body of the GET Generation API. The “status” in the callback response includes the following states: - processing: Task is being processed. - success: Task is completed (if sending fails, it will retry the callback three times). - failed: Task failed (if sending fails, it will retry the callback three times). Vidu uses a callback signature algorithm for verification, check out the details here: Callback Signature

Field	Type	Description
id	string	Task ID generated by the vidu for this task

{
  "id": "your_job_id_here"
}