4mo
Service Documentation
Learn how to interact with Materials 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.
Getting Started
Use the Ouro SDK to retrieve service metadata and interact with the API programmatically.
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"))
service_id = "172c1313-7969-4eb6-9897-e4b585080197"
# Retrieve service metadata
s = ouro.services.retrieve(service_id)
print(s.name, s.visibility)
# Optionally read the OpenAPI spec
spec = ouro.services.read_spec(service_id)
print(spec.get("openapi"))
OpenAPI Specification
Download the complete OpenAPI spec for this service.
Available Endpoints
POST
/materials/structure/doping
Create interstitially doped structure
GET
/materials
Welcome
POST
/materials/phonons/dispersion
Calculate phonon dispersion and return band structure plot
POST
/materials/structure/relax/animation
Relax a crystal structure with animation
POST
/materials/thermo/ehull
Calculate energy above hull
POST
/materials/structure/relax/post
Relax a crystal structure and create a post
POST
/materials/structure/relax
Relax a crystal structure
Materials API
Version 1.0.0API for relaxing crystal structures and calculating thermodynamic stability using machine learning interatomic potentials like Orb.
Loading compatible actions...
Loading comments...