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 = "86b9d867-19f5-4ad4-9491-dd78b4bf315a"# 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)
gen_1.cif
Get basic structural information from a CIF file
file.cif→JSON
9mo
Calculate phonon dispersion and return band structure plot
file.cif→file.png
9mo
Calculate the estimated raw material cost per kg
file.cif→JSON
8mo
Relax a crystal structure with animation
file.cif→file.mp4
8mo
Predict static dielectric function (εx)
file.cif→JSON
2d
Relax a crystal structure and create a post
file.cif→post
7mo
Get a detailed description of a crystal structure
file.cif→JSON
7mo
Relax a crystal structure
file.cif→file.cif
9mo
Calculate magnetic anisotropy energy
file.cif→JSON
3mo
Predict electronic dielectric function (ε∞x)
file.cif→JSON
2d
Predict maximum dielectric constant from DFPT
file.cif→JSON
2d
Predict maximum piezoelectric strain coefficient dij
file.cif→JSON
2d
Predict Voigt bulk modulus
file.cif→JSON
2d
Predict Voigt shear modulus
file.cif→JSON
2d
Predict exfoliation energy for layered materials
file.cif→JSON
2d
Predict n-type Seebeck coefficient
file.cif→JSON
2d
Predict p-type Seebeck coefficient
file.cif→JSON
2d
Predict n-type thermoelectric power factor
file.cif→JSON
2d
Predict total magnetic moment per cell
file.cif→JSON
2d
Predict maximum electric field gradient
file.cif→JSON
2d
Predict superconducting critical temperature
file.cif→JSON
2d
Predict electronic DOS at Fermi level
file.cif→JSON
2d
Predict Debye temperature for superconductor analysis
file.cif→JSON
2d
Predict Eliashberg spectral function α²F(ω)
file.cif→JSON
2d
Predict phonon density of states
file.cif→JSON
2d
Predict optimal k-point length for DFT convergence
file.cif→JSON
2d
Predict oxygen adsorption energy (TinNet)
file.cif→JSON
2d
Predict nitrogen adsorption energy (TinNet)
file.cif→JSON
2d
Predict OH adsorption energy (TinNet)
file.cif→JSON
2d
Predict oxygen adsorption energy (AGRA)
file.cif→JSON
2d
Predict OH adsorption energy (AGRA)
file.cif→JSON
2d
Predict CHO adsorption energy (AGRA)
file.cif→JSON
2d
Predict CO adsorption energy (AGRA)
file.cif→JSON
2d
Predict COOH adsorption energy (AGRA)
file.cif→JSON
2d
Predict adsorption energy (OCP 2020 full)
file.cif→JSON
2d
Predict adsorption energy (OCP 2020, 100k subset)
file.cif→JSON
2d
Predict adsorption energy (OCP 2020, 10k subset)
file.cif→JSON
2d
Predict internal energy at 0 K (molecules)
file.cif→JSON
2d
Predict internal energy at 298.15 K (molecules)
file.cif→JSON
2d
Predict isotropic polarizability (molecules)
file.cif→JSON
2d
Predict HOMO-LUMO gap (molecules)
file.cif→JSON
2d
Predict free energy at 298.15 K (molecules)
file.cif→JSON
2d
Predict HOMO orbital energy (molecules)
file.cif→JSON
2d
Predict LUMO orbital energy (molecules)
file.cif→JSON
2d
Predict zero-point vibrational energy (molecules)
file.cif→JSON
2d
Predict CO₂ adsorption at 5 pressures (MOFs)
file.cif→JSON
2d
Predict maximum CO₂ adsorption capacity (MOFs)
file.cif→JSON
2d
Predict gravimetric surface area (MOFs)
file.cif→JSON
2d
Predict volumetric surface area (MOFs)
file.cif→JSON
2d
Predict pore limiting diameter (MOFs)
file.cif→JSON
2d
Predict largest cavity diameter (MOFs)
file.cif→JSON
2d
Predict void fraction (MOFs)
file.cif→JSON
2d
Synthesis report from CIF file
file.cif→file.html
2mo
Create interstitially doped structure
file.cif→file.cif
8mo
Predict the Curie temperature of a material
file.cif→JSON
11mo
Calculate magnetic saturation and related properties