Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Pass Authorization: Bearer <token> in the request header.

Body

application/json
​
model
enum<string>
required

Audio generation model name.

  • audio1.0: Supports generating controllable sound effects based on timeline
Available options:
audio1.0
​
timing_prompts
object[]
required

Timeline-based sound event prompts list. Each item defines a sound event with from and to timestamps and a prompt description. Notes:

  • Max 1500 characters per event prompt
  • Events can overlap
  • from and to must be within [0, duration] range
Minimum array length: 1
​
duration
number<float>
default:10

Audio duration in seconds.

  • Default: 10 seconds
  • Range: 2-10 seconds
Required range: 2 <= x <= 10
​
seed
integer

Random seed.

  • If not provided or set to 0, a random value will be used
  • Fixed value ensures reproducibility
​
callback_url
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

Response

200 - application/json

Submission successful, returns an audio task object.

​
task_id
string

Vidu generated Task ID

​
state
enum<string>

Task state:

  • created: Task created successfully
  • queueing: Task in queue
  • processing: Task is being processed
  • success: Generation successful
  • failed: Task failed
Available options:
created,
queueing,
processing,
success,
failed
​
model
string

Model parameter used

​
duration
integer

Audio duration

​
timing_prompts
object[]

List of configured sound events

​
seed
integer

Random seed used

​
credits
integer

The credits used for this call

​
created_at
string

Task creation timestamp (ISO8601 format)