Python

Upload files, manage folders, and call the full Autorender API from your Python server.

The autorender package is the official server-side client for Python. Use it to upload files, list and manage files and folders, run multipart uploads, and call the Autorender API from your backend.

Prerequisites

• An Autorender account with an API key — create one in the dashboard
• Python 3.8 or later

Guide

1. Install the package.

   pip

   pip install autorender
   

   poetry add autorender
   
2. Set your API key.

   Create an API key in the dashboard and set it as an environment variable:

   export AUTORENDER_API_KEY=your-api-key
   
3. Upload a file.

   Create a client and upload your first file. Read AUTORENDER_API_KEY from the environment — never hardcode the key.

   import os
   import autorender
   
   client = autorender.Autorender(
       api_key=os.environ.get("AUTORENDER_API_KEY"),
   )
   
   with open("products/chair.jpg", "rb") as f:
       upload = client.uploads.create(
           file=f,
           file_name="chair.jpg",
       )
   
   print(upload.file_no)  # e.g. "fi_abc123"
   print(upload.url)      # CDN URL
   

Examples

Upload from URL

upload = client.uploads.create_from_url(
    remote_url="https://acme-assets.s3.amazonaws.com/products/chair.jpg",
)

List files

result = client.files.list(limit=10)

for file in result.files:
    print(file.file_no, file.name, file.url)

Get file details

file = client.files.retrieve("fi_abc123")
print(file.data.url)

Rename a file

client.files.rename("fi_abc123", name="new-name")

Delete a file

client.files.delete("fi_abc123")

Folders

# List folders
result = client.folders.list()

# Create a folder
folder = client.folders.create(name="products")

# Rename a folder
client.folders.rename(folder.data.folder_no, name="product-images")

# Delete a folder
client.folders.delete(folder.data.folder_no)

Multipart upload

For files larger than 100 MB, use a multipart upload to split the file into parts:

import httpx

with open("large-video.mp4", "rb") as f:
    file_data = f.read()

# Start session
session = client.multipart_uploads.start(
    file_name="large-video.mp4",
    file_size=len(file_data),
)

# Upload parts
res = httpx.put(session.parts[0].url, content=file_data)
etag = res.headers["etag"]

# Complete
result = client.multipart_uploads.complete(
    upload_id=session.upload_id,
    parts=[{"part_number": 1, "etag": etag}],
)

Error handling

import autorender

try:
    file = client.files.retrieve("fi_notexist")
except autorender.APIStatusError as e:
    print(e.status_code)  # 404
    print(e.message)

Resources

• PyPI package
• GitHub
• API reference

Next steps

Direct upload API

The upload endpoint this SDK calls.

Create an API key

Generate the key the client reads from the environment.

Image transformations

Build delivery URLs from your uploaded files.

All SDKs

Server-side clients for every language.