Skip to main content
POST
/
download
Create download request
curl --request POST \
  --url https://api.videodb.io/download \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "stream_link": "https://stream.videodb.io/v/12345",
  "name": "my_download.mp4"
}
'
{
  "success": true,
  "status": "processing",
  "data": {
    "id": "job-123",
    "output_url": "https://api.videodb.io/async-response/job-123"
  }
}
Initiate a download job to convert a stream URL into a downloadable file. This is an asynchronous operation that returns a download ID for tracking progress. 
import videodb

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

# Create a download job
result = conn.download(
    stream_link="https://stream.videodb.io/v/abc123def",
    name="my_export.mp4"
)

print(f"Download ID: {result.get('download_id')}")
  • Download jobs are asynchronous—use the returned download_id to check status
  • Provide a stream URL from generateStream() or a timeline stream URL
  • The name parameter sets the output filename (include file extension)
  • Download URLs expire after 24 hours from completion

Streams and Exports Guide

Learn how to generate streams before downloading

Get Download Status

Check download progress and retrieve the final URL

Authorizations

​
x-access-token
string
header
required

API key for authentication (sk-xxx format)

Body

application/json
​
stream_link
string
required
Example:

"https://stream.videodb.io/v/12345"

​
name
string
Example:

"my_download.mp4"

Response

200 - application/json

Download initiated

​
success
boolean
Example:

true

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

"processing"

​
data
object