⌘K

Vidu One-click Ad Film

vidu-cn-ad-one-click

Create, query, edit, and compose an e-commerce ad film workflow.

Authentication

authorization string required

All APIs require authentication via Bearer Token.

Get API Key:

Visit API Key Management Page to get your API Key.

Usage:

Add to request header:

Authorization: Bearer YOUR_API_KEY

Parameters

model string required

Customer-facing model ID used for the request.

Value: vidu-cn-ad-one-click


workflow operation model string required

Primary customer-facing model or operation ID for this workflow.


prompt string

Workflow text instruction.


images array[string]

Input images or materials used by the workflow.


callback_url string

Callback URL for asynchronous task notifications.


Workflow Operations

vidu-cn-ad-one-click

Create an ad film task.

vidu-cn-ad-one-click/{id}

Query the ad film task and subtask list.

vidu-cn-ad-one-click/{id}/creations

Query generated creations for a film or storyboard task.

vidu-cn-ad-one-click/edit

Edit storyboard, narration, or background music.

vidu-cn-ad-one-click/compose

Compose the final ad film.

Polling

Since result generation takes time, you need to poll the task status after creating the task.

The initial response only returns information such as the task ID and initial status. The final result must be obtained by polling the task status endpoint using the task ID.

See the examples on the right for polling requests and responses.

Response Format

error object

Error information, only present when status is failed.

code string

Error code

message string

Detailed error message


output array

Generation results, present when the request succeeds.

content array

List of generated resource content

type string

Resource type.

Value: video

url string

Generated resource URL. Text utility endpoints may return a text field instead of a URL.

jobId string

Upstream task ID.


usage object

Usage statistics, present when the request succeeds.

cost string

Total cost in USD.

discount number

Discount amount.


metadata object

Metadata information.