Learn how to interact with Thermoelectrics API 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.
Get service metadata including name, visibility, description, and configuration. You can retrieve by service ID or identifier.
Retrieve the OpenAPI specification for this service to understand available endpoints and their parameters.
Get all routes for this service and use them programmatically.
Click on an endpoint to view its detailed documentation.
/thermoelectrics/predictEstimate ZT and key thermoelectric properties
/thermoelectrics/relaxStructure relaxation via NequIP-OAM-XL
/thermoelectrics/seebeckPredict Seebeck coefficient and band gap
/thermoelectrics/kappaEstimate minimum lattice thermal conductivity
/thermoelectrics/phononsCheck phonon stability
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"))
# Option 1: Retrieve by service ID
service_id = "7ad9122e-8149-4802-a0f7-0b856f62d66a"
service = ouro.services.retrieve(service_id)
# Option 2: Retrieve by service identifier (username/service-name)
service_identifier = "mmoderwell/thermoelectrics-api"
service = ouro.services.retrieve(service_identifier)
print(service.name, service.visibility)
print(service.metadata)# Retrieve the service
service = ouro.services.retrieve("mmoderwell/thermoelectrics-api")
# Read the OpenAPI spec
spec = ouro.services.read_spec(service.id)
print(spec.get("openapi"))
print(spec.get("info"))# Retrieve the service
service = ouro.services.retrieve("mmoderwell/thermoelectrics-api")
# Get all routes for this service
routes = ouro.services.read_routes(service.id)
for route in routes:
print(f"{route.route.method} {route.route.path}")
print(f" Summary: {route.route.summary}")No compatible actions for services yet
Estimate ZT and the supporting thermoelectric properties for an inorganic crystal structure. The API can relax the structure, compute phonons and minimum thermal conductivity, predict Seebeck coefficients and band gap, and assemble a fast screening estimate using NequIP-OAM-XL, phonopy, WTE, and ALIGNN.
Fast screening of inorganic crystal structures for thermoelectric performance from a CIF file.
Total API views over time