API v1

The video task object

Detailed task view.

View Markdown
  • With an unavailable result, the task stays processing and settlement remains under review.
  • Succeeded tasks have result files and available delivery.
  • Failed or cancelled tasks can have pending or settled billing; once settled, their final charge and amount due are zero.

Attributes

#idstringRequired

Task ID assigned by the platform.

Length4–128CharactersA–Z a–z 0–9 _ -
#objectstringRequired

Identifies the kind of object returned.

Alwaysvideo.task
#request_idstringRequired

Request ID used to correlate this task.

Length4–128CharactersA–Z a–z 0–9 _ -
#billing_correlation_idstringRequired

Billing correlation ID for this task.

Length4–128CharactersA–Z a–z 0–9 _ -
#modelstringRequired

ID of the model used for this request.

dreamina-seedance-2-0-260128Seedance 2.0
dreamina-seedance-2-0-fast-260128Seedance 2.0 Fast
dreamina-seedance-2-0-mini-260615Seedance 2.0 Mini
#statusstringRequired

Current state; see the value notes for its meaning.

queuedQueued
processingProcessing
succeededSucceeded
failedFailed
cancelledCancelled
#phasestringRequiredNullable

Current execution phase, or null when no phase applies.

preparing_assetsPreparing inputs
waiting_routeWaiting
submittingStarting
provider_processingGenerating
reconcilingConfirming the result
finalizingFinishing
settlement_pendingAwaiting settlement
nullNull value
#delivery_statusstringRequired

Progress of result file delivery.

pendingNot yet delivered
materializingPreparing the download
availableReady to download
output_unavailableResult unavailable
#settlement_statusstringRequired

Current progress of billing settlement.

reservedReserved
pendingPending
reconciliation_requiredUnder review
settledSettled
settled_with_receivableSettled - amount due
#created_atintegerRequired

Creation time as whole seconds since the Unix epoch.

Range≥ 0
#started_atintegerRequiredNullable

Time the task started, or null before it starts.

Range≥ 0
#completed_atintegerRequiredNullable

Time the task finished, or null while unfinished.

Range≥ 0
#usageobjectRequiredNullable

Recorded usage, or null when it is not available.

7 child fields
#meter_typestringRequired

The meter used to record usage.

Alwaysseedance_video_generation
#video_tokensintegerRequiredNullable

Number of video tokens. The field type determines whether an actual usage value may be null.

Range≥ 0
#output_duration_secondsintegerRequired

Duration of the output video in seconds.

Range≥ 0
#input_video_duration_secondsintegerRequired

Combined duration of reference video input in seconds.

Range≥ 0
#resolutionstringRequired

Output resolution. The fast and mini models accept only 480p or 720p.

One of480p720p1080p
#fpsintegerRequired

Frames per second in the video.

Range1–120
#has_reference_videobooleanRequired

Whether reference video was used as input.

#billingobjectRequired

Billing summary for the task, or null.

8 child fields
#currencystringRequired

Currency of the amounts: USD.

AlwaysUSD
#final_actual_coststringRequiredNullable

Final charge, or null while the amount is not final yet.

Format6 decimal places
#collected_liability_amountstringRequired

Amount collected toward the charge.

Format6 decimal places
#funding_debit_amountstringRequired

Amount debited from balance.

Format6 decimal places
#refunded_liability_amountstringRequired

Amount of the charge refunded.

Format6 decimal places
#funding_refund_amountstringRequired

Amount refunded to balance.

Format6 decimal places
#outstanding_receivablestringRequired

Amount due that has not been collected.

Format6 decimal places
#billing_urlstringRequired

Relative path to this task's billing details.

Format/v1/video/tasks/{task_id}/billing
#outputobjectRequiredNullable

Generated result information, or null.

1 child fields
#assetsarrayRequired

Files belonging to the generated result.

Items1–16
9 child fields
#asset_idstringRequired

ID assigned to the asset by the platform.

Length4–128CharactersA–Z a–z 0–9 _ -
#media_typestringRequired

The kind of media in this file.

One ofvideoimageaudio
#rolestringRequired

How the asset is used in the input or result.

resultResult file
last_frameLast frame
audioAudio media
#urlstringRequiredNullable

HTTPS download link when ready, or null when expired or unavailable.

Length12–4096Formathttps://
#materialized_atintegerRequiredNullable

Time the result became ready, in whole Unix seconds.

Range≥ 0
#expires_atintegerRequiredNullable

Expiry time of the result: the time it becomes ready plus the retention period in force at that time (7 days by default), measured separately from task completion.

Range≥ 0
#delivery_sourcestringRequired

Where the result is made available for delivery.

platformStorage: Platform
#materialization_statusstringRequired

Progress of preparing the result.

completedSaved
retryingSaving
failedFailed
#download_statusstringRequired

Whether the result is ready to download, expired or unavailable.

availableAvailable
expiredExpired
unavailableUnavailable
#cancellationobjectRequiredNullable

Cancellation information already attached to the task, or null.

3 child fields
#cancel_operation_idstringRequired

Stable ID of the cancellation operation.

Length4–128CharactersA–Z a–z 0–9 _ -
#statusstringRequired

Current state; see the value notes for its meaning.

requestedRequested
effectiveCancelled
not_effectiveNot cancelled
failedFailed
#reason_codestringRequiredNullable

Reason cancellation did not take effect or failed. Null when requested or effective.

Length1–96Charactersa–z 0–9 _
#errorobjectRequiredNullable

An object describing the error.

3 child fields
#codestringRequired

A code your application can use to handle the error.

no_common_asset_routeAssets temporarily unavailable
asset_not_readyA referenced asset is still processing
asset_review_timeoutAsset review timed out
route_misconfiguredService configuration error
route_temporarily_unavailableTemporarily unavailable
generation_expiredGeneration expired
generation_failedGeneration failed
input_fetch_failedAn input could not be downloaded from its URL
input_url_not_allowedAn input URL is not allowed
input_too_largeAn input exceeds its size limit
input_unsupportedAn input format, dimensions or duration is unsupported
input_rejectedAn input did not pass content review
input_preparation_failedThe inputs could not be prepared in time
input_duration_exceededThe combined input duration exceeds the model limit
#messagestringRequired

A readable explanation of the error.

Length1–1024
#detailsobject

Optional fields with more information about the error.

1 child fields
#content_indexinteger

Zero-based position of the failed input in the original content array, including text items.

Range0–50

Read this object with Read a video task.