Frame.io Python SDK — Upload Guide

1
import os
2
from frameio import Frameio
3
from frameio.files import FileCreateLocalUploadParamsData
4
from frameio.upload import FrameioUploader
5
6
client = Frameio(token="YOUR_TOKEN")
7
8
file_path = "/path/to/video.mp4"
9
file_size = os.path.getsize(file_path)
10
11
# 1. Create the file resource and get pre-signed upload URLs
12
response = client.files.create_local_upload(
13
    account_id="YOUR_ACCOUNT_ID",
14
    folder_id="YOUR_FOLDER_ID",
15
    data=FileCreateLocalUploadParamsData(
16
        name="video.mp4",
17
        file_size=file_size,
18
    ),
19
)
20
21
# 2. Upload the file to S3
22
with open(file_path, "rb") as f:
23
    FrameioUploader(response.data, f).upload()

1
def on_progress(bytes_uploaded: int, total_bytes: int) -> None:
2
    pct = bytes_uploaded / total_bytes * 100
3
    print(f"\r{pct:.1f}% ({bytes_uploaded:,} / {total_bytes:,} bytes)", end="", flush=True)
4
5
with open(file_path, "rb") as f:
6
    FrameioUploader(response.data, f, on_progress=on_progress).upload()
7
8
print("\nUpload complete!")

1
from rich.progress import Progress, BarColumn, DownloadColumn, TransferSpeedColumn, TimeRemainingColumn
2
3
with Progress(
4
    "[progress.description]{task.description}",
5
    BarColumn(),
6
    DownloadColumn(),
7
    TransferSpeedColumn(),
8
    TimeRemainingColumn(),
9
) as progress:
10
    task = progress.add_task("Uploading...", total=file_size)
11
12
    with open(file_path, "rb") as f:
13
        FrameioUploader(
14
            response.data, f,
15
            on_progress=lambda done, total: progress.update(task, completed=done),
16
        ).upload()

1
with open(file_path, "rb") as f:
2
    FrameioUploader(
3
        response.data,
4
        f,
5
        max_workers=10,       # more parallelism for high-bandwidth connections
6
        max_retries=5,        # more resilient on flaky networks
7
        on_progress=on_progress,
8
    ).upload()

1
import os
2
from frameio import Frameio
3
from frameio.auth import ServerToServerAuth
4
from frameio.files import FileCreateLocalUploadParamsData
5
from frameio.upload import FrameioUploader
6
7
# Authenticate
8
auth = ServerToServerAuth(
9
    client_id="YOUR_CLIENT_ID",
10
    client_secret="YOUR_CLIENT_SECRET",
11
)
12
client = Frameio(token=auth.get_token)
13
14
# Prepare the file
15
file_path = "/path/to/video.mp4"
16
file_name = os.path.basename(file_path)
17
file_size = os.path.getsize(file_path)
18
19
# Create the file resource
20
response = client.files.create_local_upload(
21
    account_id="YOUR_ACCOUNT_ID",
22
    folder_id="YOUR_FOLDER_ID",
23
    data=FileCreateLocalUploadParamsData(
24
        name=file_name,
25
        file_size=file_size,
26
    ),
27
)
28
29
print(f"Uploading {file_name} ({file_size:,} bytes) in {len(response.data.upload_urls)} chunks...")
30
31
# Upload with progress
32
def on_progress(uploaded: int, total: int) -> None:
33
    print(f"\r{uploaded / total:.0%}", end="", flush=True)
34
35
with open(file_path, "rb") as f:
36
    FrameioUploader(response.data, f, on_progress=on_progress).upload()
37
38
print(f"\nDone! View at: {response.data.view_url}")

1
from frameio.files import FileCreateRemoteUploadParamsData
2
3
response = client.files.create_remote_upload(
4
    account_id="YOUR_ACCOUNT_ID",
5
    folder_id="YOUR_FOLDER_ID",
6
    data=FileCreateRemoteUploadParamsData(
7
        name="video.mp4",
8
        source_url="https://example.com/video.mp4",
9
    ),
10
)
11
print(f"File created: {response.data.id}")

1
status = client.files.show_file_upload_status(
2
    account_id="YOUR_ACCOUNT_ID",
3
    file_id=response.data.id,
4
)
5
print(f"Upload complete: {status.data.upload_complete}")