Skip to main content
POST
/
timeline_v2
/
download
Download compiled timeline
curl --request POST \
  --url https://api.videodb.io/timeline_v2/download \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "timeline_id": "timeline-12345",
  "format": "mp4",
  "quality": "high"
}
'
{
  "success": true,
  "status": "processing",
  "data": {
    "id": "job-123",
    "output_url": "https://api.videodb.io/async-response/job-123"
  }
}
Download a generated timeline stream as a downloadable video file in MP4 format. After creating a timeline, use this endpoint to export it for sharing or offline use.
import videodb
from videodb.editor import Timeline, Track, Clip, VideoAsset

conn = videodb.connect(api_key="your_api_key")

# Create and generate a timeline (see Create Timeline v2)
timeline = Timeline(conn)
track = Track()
video_asset = VideoAsset(id="m-abc123def", start=0)
clip = Clip(asset=video_asset, duration=10)
track.add_clip(0, clip)
timeline.add_track(track)

# Generate the stream
stream_url = timeline.generate_stream()

# Download the timeline as a video file
download_result = timeline.download_stream(stream_url)

print(f"Download URL: {download_result.get('download_url')}")
print(f"Status: {download_result.get('status')}")
  • Download requires a valid stream URL from a generated timeline
  • Downloads are processed asynchronously and return a download URL
  • Video format is MP4 with standard codec support
  • Downloaded files can be shared, archived, or used in other applications
  • Check the status field to track download progress

Authorizations

x-access-token
string
header
required

API key for authentication (sk-xxx format)

Body

application/json
timeline_id
string
required
Example:

"timeline-12345"

format
enum<string>
Available options:
mp4,
webm,
avi
Example:

"mp4"

quality
enum<string>
Available options:
low,
medium,
high
Example:

"high"

Response

200 - application/json

Download initiated

success
boolean
Example:

true

status
enum<string>
Available options:
processing,
done,
failed
Example:

"processing"

data
object