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 osfrom 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 = "05aaa209-0fd5-4645-bd04-b26a9c2045f3"# Retrieve file metadatafile = 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 filefile_data = file.read_data()print(file_data.url)# Download the file using requestsimport requestsresponse = 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 metadataupdated = ouro.files.update( id=file_id, name="Updated file name", description="Updated description", visibility="private")# Update file data with a new fileupdated = 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)
Calculate energy above the convex hull
file.cif→file.html
10mo
2.5k uses
Predict the Curie temperature of a material
file.cif→JSON
1y
2.3k uses
Calculate the estimated raw material cost per kg
file.cif→JSON
9mo
1.6k uses
Relax a crystal structure
file.cif→file.cif
10mo
1.6k uses
Calculate magnetic saturation and related properties
file.cif→JSON
10mo
776 uses
Calculate phonon dispersion and band structure
file.cif→file.png
10mo
564 uses
Create a supercell from a material
file.cif→file.cif
1y
128 uses
Get basic structural information from a CIF file
file.cif→JSON
10mo
119 uses
Estimate ZT and key thermoelectric properties
file.cif→JSON
1mo
76 uses
Structure relaxation via NequIP-OAM-XL
file.cif→file.cif
1mo
31 uses
Relax a crystal structure with animation
file.cif→file.mp4
9mo
24 uses
Create an interstitially doped structure
file.cif→file.cif
9mo
21 uses
Predict total magnetic moment per cell
file.cif→JSON
29d
16 uses
Predict energy above the convex hull
file.cif→JSON
29d
15 uses
Relax a crystal structure and publish results
file.cif→post
8mo
14 uses
Get a detailed description of a crystal structure
file.cif→JSON
8mo
12 uses
Predict formation energy per atom (MP dataset)
file.cif→JSON
29d
11 uses
Predict Seebeck coefficient and band gap
file.cif→JSON
1mo
10 uses
Calculate magnetic anisotropy energy
file.cif→JSON
4mo
8 uses
Synthesis report from CIF file
file.cif→file.html
2mo
5 uses
Predict superconducting critical temperature
file.cif→JSON
29d
4 uses
Predict band gap using the TBmBJ functional
file.cif→JSON
29d
2 uses
Check phonon stability
file.cif→file.png
1mo
2 uses
Predict average electron effective mass
file.cif→JSON
29d
1 use
Predict static dielectric function (εx)
file.cif→JSON
29d
1 use
Simulate an X-ray diffraction pattern
file.cif→file.html
9d
1 use
Predict HOMO orbital energy (molecules)
file.cif→JSON
29d
Predict maximum CO₂ adsorption capacity (MOFs)
file.cif→JSON
29d
Predict COOH adsorption energy (AGRA)
file.cif→JSON
29d
Predict Voigt bulk modulus
file.cif→JSON
29d
Predict phonon density of states
file.cif→JSON
29d
Predict HOMO-LUMO gap (molecules)
file.cif→JSON
29d
Predict adsorption energy (OCP 2020 full)
file.cif→JSON
29d
Predict adsorption energy (OCP 2020, 10k subset)
file.cif→JSON
29d
Predict exfoliation energy for layered materials
file.cif→JSON
29d
Predict zero-point vibrational energy (molecules)
file.cif→JSON
29d
Predict largest cavity diameter (MOFs)
file.cif→JSON
29d
Predict CO₂ adsorption at 5 pressures (MOFs)
file.cif→JSON
29d
Predict electronic DOS at Fermi level
file.cif→JSON
29d
Predict maximum dielectric constant from DFPT
file.cif→JSON
29d
Predict nitrogen adsorption energy (TinNet)
file.cif→JSON
29d
Predict adsorption energy (OCP 2020, 100k subset)
file.cif→JSON
29d
Predict p-type Seebeck coefficient
file.cif→JSON
29d
Predict average hole effective mass
file.cif→JSON
29d
Predict n-type Seebeck coefficient
file.cif→JSON
29d
Predict CHO adsorption energy (AGRA)
file.cif→JSON
29d
Predict spectroscopic limited maximum efficiency
file.cif→JSON
29d
Predict maximum piezoelectric strain coefficient dij
file.cif→JSON
29d
Predict optimal k-point length for DFT convergence
A phonon dispersion plot for a relaxed structure using a 2x2x2 supercell. The red lines show multiple phonon branches across high-symmetry paths labeled Gamma, X, Y, ZR2, U2, and V2. Frequencies range up to about 9 THz, with several bands crossing and bending as they move along the path. A blue dotted line marks zero frequency, and the data indicate no imaginary modes, though the lowest branch dips slightly below zero by about 0.07 THz. This image summarizes how vibrational modes vary with wavevector for the relaxed structure.