Skip to main content
GET
Get a video task

Polling and status

Replace <TASK_ID> with the returned id and poll every 10 to 15 seconds:
Generation can take several minutes. Check the task status even when polling returns HTTP 200.

Read a successful result

Key fields in a successful response are shown below. Use the URL returned by your request:
After success, download the video.

Failures and retries

After a disconnect, keep polling the original id. Task records remain for 7 days. If a task is missing, check the identifier and use a key belonging to the account that created it. Stop on failed, cancelled or expired. After a 429 or temporary service error, wait before retrying the read; do not create another task. If a task is missing, check the identifier and the account that owns the API key.

Authorizations

Authorization
string
header
required

API key (sk-xxx)

Path Parameters

task_id
string
required

The id returned when the task was created

Response

Task object

Video task object.

id
string

Task ID

Example:

"task_ADQ5XK6AKWg36WePoJ3sZRyDvWl1ogGZ"

model
string
Example:

"doubao-seedance-2-5-260628"

status
enum<string>

Task status

Available options:
queued,
running,
succeeded,
failed,
cancelled,
expired
error
object | null

Error when the task did not succeed, otherwise null.

content
object | null

Artifact URLs when status is succeeded. Download with the same API key.

usage
object
output_format
string
Example:

"mp4"

framespersecond
integer
Example:

24

resolution
string

The requested value while running; the delivered value after success.

ratio
string

The requested value while running; the delivered value after success.

duration
integer

The requested value while running; the delivered value after success.

generate_audio
boolean
priority
integer
service_tier
string
Example:

"default"

execution_expires_after
integer
Example:

172800

safety_identifier
string
created_at
integer

Creation time, Unix seconds

updated_at
integer

Last update time, Unix seconds