> This page is for Plataforma, version V4 (default).
> For other versions, use one of these documentation indexes:
> - V4 (default): https://next.developer.frame.io/platform/v4/llms.txt
> - V4 experimental: https://next.developer.frame.io/platform/v4-experimental/llms.txt
> - Heredado: https://next.developer.frame.io/platform/v2/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://next.developer.frame.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://next.developer.frame.io/_mcp/server.

# Guía de carga del SDK para Python de Frame.io

Esta guía explica cómo cargar archivos en Frame.io mediante el **SDK para Python de Frame.io** (`frameio`). El SDK gestiona cargas fragmentadas de varias partes en S3 mediante URL con firma previa, con trabajadores paralelos, reintentos automáticos y seguimiento opcional del progreso. Para consultar los conceptos generales de la API de carga, como URL de carga, encabezados y fragmentación, consulte [Funcionamiento de las cargas locales y remotas](./how-local-remote-uploads-work).

---

## Requisitos previos

#### Autenticación

Tiene un cliente de `Frameio` en funcionamiento. Consulte la [Guía de autenticación](/platform/docs/guides/authentication/python-sdk) para obtener información sobre la configuración.

#### Instalar el SDK

```bash
    pip install frameio
```

#### Carpeta de destino

Necesita el `account_id` y el `folder_id` donde se cargará el archivo. Utilice el SDK para encontrarlos:

```python
    # List your accounts
    accounts = client.accounts.index()
    account_id = accounts.data[0].id

    # List workspaces in the account
    workspaces = client.workspaces.index(account_id=account_id)
    workspace_id = workspaces.data[0].id

    # List projects in the workspace
    projects = client.projects.index(account_id=account_id, workspace_id=workspace_id)
    project = projects.data[0]

    # The project's root folder is the top-level upload target
    folder_id = project.root_folder_id

    # Or list subfolders to upload into a specific one
    folders = client.folders.list(account_id=account_id, folder_id=folder_id)
```

---

## Inicio rápido

```python
import os
from frameio import Frameio
from frameio.files import FileCreateLocalUploadParamsData
from frameio.upload import FrameioUploader

client = Frameio(token="YOUR_TOKEN")

file_path = "/path/to/video.mp4"
file_size = os.path.getsize(file_path)

# 1. Create the file resource and get pre-signed upload URLs
response = client.files.create_local_upload(
    account_id="YOUR_ACCOUNT_ID",
    folder_id="YOUR_FOLDER_ID",
    data=FileCreateLocalUploadParamsData(
        name="video.mp4",
        file_size=file_size,
    ),
)

# 2. Upload the file to S3
with open(file_path, "rb") as f:
    FrameioUploader(response.data, f).upload()
```

Eso es todo. El SDK divide el archivo en fragmentos según las URL de carga devueltas por la API, los carga en paralelo y gestiona automáticamente los reintentos.

---

## Funcionamiento

La carga local es un proceso de dos pasos:

#### Creación del recurso de archivo

Llame a `client.files.create_local_upload()` con el nombre y el tamaño del archivo. La API crea un archivo marcador de posición y devuelve URL PUT de S3 con firma previa, una por fragmento. El número de URL (y, por tanto, de fragmentos) depende del tamaño del archivo.

#### Carga en S3

`FrameioUploader` lee las URL de carga de la respuesta, divide el archivo en fragmentos correspondientes y carga cada fragmento en su URL con PUT en paralelo mediante un grupo de subprocesos. Cada solicitud incluye los encabezados obligatorios `x-amz-acl: private` y `Content-Type`.

> **Note**
>
> La carga va directamente de la aplicación a S3, no pasa por los servidores de API de Frame.io. Es el mismo patrón que usan servicios como YouTube, Vimeo y Dropbox para cargas de archivos grandes.

---

## Uso de `FrameioUploader`

`FrameioUploader` es la forma recomendada de cargar archivos. Envuelve el cargador fragmentado de nivel inferior y gestiona todos los detalles: extrae las URL de carga de la respuesta de la API, define los encabezados obligatorios, fragmenta el archivo y lo carga en paralelo.

### Seguimiento del progreso

Use la devolución de llamada `on_progress` para hacer un seguimiento del progreso de la carga:

```python
def on_progress(bytes_uploaded: int, total_bytes: int) -> None:
    pct = bytes_uploaded / total_bytes * 100
    print(f"\r{pct:.1f}% ({bytes_uploaded:,} / {total_bytes:,} bytes)", end="", flush=True)

with open(file_path, "rb") as f:
    FrameioUploader(response.data, f, on_progress=on_progress).upload()

print("\nUpload complete!")
```

La devolución de llamada se invoca una vez tras completarse cada fragmento, con los bytes acumulados cargados hasta el momento y el tamaño total del archivo.

#### Barra de progreso con Rich

Para disfrutar de una experiencia de terminal más cuidada, use [Rich](https://github.com/Textualize/rich):

```python
from rich.progress import Progress, BarColumn, DownloadColumn, TransferSpeedColumn, TimeRemainingColumn

with Progress(
    "[progress.description]{task.description}",
    BarColumn(),
    DownloadColumn(),
    TransferSpeedColumn(),
    TimeRemainingColumn(),
) as progress:
    task = progress.add_task("Uploading...", total=file_size)

    with open(file_path, "rb") as f:
        FrameioUploader(
            response.data, f,
            on_progress=lambda done, total: progress.update(task, completed=done),
        ).upload()
```

### Configuración

`FrameioUploader` acepta varios parámetros opcionales:

| Parámetro     | Predeterminado                                 | Descripción                                                                                                            |
| ------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `max_workers` | `5`                                            | Número de subprocesos de carga simultáneos                                                                             |
| `headers`     | `{"x-amz-acl": "private"}` | Encabezados enviados con cada solicitud PUT de S3. Los encabezados personalizados se combinan con los predeterminados. |
| `max_retries` | `3`                                            | Intentos de reintento por fragmento (con espera exponencial: 1 s, 2 s, 4 s, etc.)                                      |
| `on_progress` | `None`                                         | Devolución de llamada `(bytes_uploaded, total_bytes)` que se activa tras cada fragmento                                |

```python
with open(file_path, "rb") as f:
    FrameioUploader(
        response.data,
        f,
        max_workers=10,       # more parallelism for high-bandwidth connections
        max_retries=5,        # more resilient on flaky networks
        on_progress=on_progress,
    ).upload()
```

### Ejemplo completo

Ejemplo completo con autenticación, carga y seguimiento del progreso:

```python
import os
from frameio import Frameio
from frameio.auth import ServerToServerAuth
from frameio.files import FileCreateLocalUploadParamsData
from frameio.upload import FrameioUploader

# Authenticate
auth = ServerToServerAuth(
    client_id="YOUR_CLIENT_ID",
    client_secret="YOUR_CLIENT_SECRET",
)
client = Frameio(token=auth.get_token)

# Prepare the file
file_path = "/path/to/video.mp4"
file_name = os.path.basename(file_path)
file_size = os.path.getsize(file_path)

# Create the file resource
response = client.files.create_local_upload(
    account_id="YOUR_ACCOUNT_ID",
    folder_id="YOUR_FOLDER_ID",
    data=FileCreateLocalUploadParamsData(
        name=file_name,
        file_size=file_size,
    ),
)

print(f"Uploading {file_name} ({file_size:,} bytes) in {len(response.data.upload_urls)} chunks...")

# Upload with progress
def on_progress(uploaded: int, total: int) -> None:
    print(f"\r{uploaded / total:.0%}", end="", flush=True)

with open(file_path, "rb") as f:
    FrameioUploader(response.data, f, on_progress=on_progress).upload()

print(f"\nDone! View at: {response.data.view_url}")
```

---

> **Tip**
>
> Si necesita control total sobre el proceso de carga, por ejemplo, para gestionar la fragmentación manualmente, integrarlo con una canalización asíncrona o personalizar la lógica de reintento, consulte [Funcionamiento de las cargas locales y remotas](./how-local-remote-uploads-work) para ver el flujo de API sin procesar y un ejemplo de script independiente de Python.

---

## Carga remota

Si el archivo ya está disponible mediante una URL pública, use la carga remota. No se necesita fragmentación; Frame.io obtiene el archivo directamente:

```python
from frameio.files import FileCreateRemoteUploadParamsData

response = client.files.create_remote_upload(
    account_id="YOUR_ACCOUNT_ID",
    folder_id="YOUR_FOLDER_ID",
    data=FileCreateRemoteUploadParamsData(
        name="video.mp4",
        source_url="https://example.com/video.mp4",
    ),
)
print(f"File created: {response.data.id}")
```

> **Warning**
>
> Actualmente, la carga remota tiene un **límite de tamaño de archivo de 50 GB**. Para archivos de más de 50 GB, utilice la [carga local](#quick-start).

---

## Comprobación del estado de carga

Después de cargar, puede verificar que el archivo se haya recibido:

```python
status = client.files.show_file_upload_status(
    account_id="YOUR_ACCOUNT_ID",
    file_id=response.data.id,
)
print(f"Upload complete: {status.data.upload_complete}")
```