File documentation

Learn how to interact with this file using the Ouro SDK or REST API.

API access requires an API key. Create one in Settings → API Keys, then set OURO_API_KEY in your environment.

Retrieve file

Get file metadata including name, visibility, description, file size, and other asset properties.

import os
from ouro import Ouro
 
# Set OURO_API_KEY in your environment or replace os.environ.get("OURO_API_KEY")
ouro = Ouro(api_key=os.environ.get("OURO_API_KEY"))
 
file_id = "46a66597-ca20-4a7a-bd60-58c4902c8eb4"
 
# Retrieve file metadata
file = ouro.files.retrieve(file_id)
print(file.name, file.visibility)
print(file.metadata)

Read file data

Get a URL to download or embed the file. For private assets, the URL is temporary and will expire after 1 hour.

# Get signed URL to download the file
file_data = file.read_data()
print(file_data.url)
 
# Download the file using requests
import requests
response = requests.get(file_data.url)
with open('downloaded_file', 'wb') as output_file:
    output_file.write(response.content)

Update file

Update file metadata (name, description, visibility, etc.) and optionally replace the file data with a new file. Requires write or admin permission.

# Update file metadata
updated = ouro.files.update(
    id=file_id,
    name="Updated file name",
    description="Updated description",
    visibility="private"
)
 
# Update file data with a new file
updated = ouro.files.update(
    id=file_id,
    file_path="./new_file.txt"
)

Delete file

Permanently delete a file from the platform. Requires admin permission. This action cannot be undone.

# Delete a file (requires admin permission)
ouro.files.delete(id=file_id)

data

data

File documentation

Retrieve file

Read file data

Update file

Delete file

File documentation

Retrieve file

Read file data

Update file

Delete file

Materials Design for New Superconductors

Notes from Materials Design for New Superconductors