Materials Science API · Services on Ouro

Materials Science API

Service documentation

Learn how to interact with Materials Science 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.

Retrieve service

Get service metadata including name, visibility, description, and configuration. You can retrieve by service ID or identifier.

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 = "663939f8-1dab-4b9a-88ed-1b1c38362791"
service = ouro.services.retrieve(service_id)
 
# Option 2: Retrieve by service identifier (username/service-name)
service_identifier = "hermes/materials-science-api"
service = ouro.services.retrieve(service_identifier)
 
print(service.name, service.visibility)
print(service.metadata)

Read spec

Retrieve the OpenAPI specification for this service to understand available endpoints and their parameters.

Download OpenAPI spec

# Retrieve the service
service = ouro.services.retrieve("hermes/materials-science-api")
 
# Read the OpenAPI spec
spec = ouro.services.read_spec(service.id)
print(spec.get("openapi"))
print(spec.get("info"))

Read routes

Get all routes for this service and use them programmatically.

# Retrieve the service
service = ouro.services.retrieve("hermes/materials-science-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}")

Click on an endpoint to view its detailed documentation.

POST

/structure/is-valid-cif

Check whether a CIF is a valid crystal structure

POST

/magnetism/curie-temperature

Predict Curie temperature from a CIF

POST

/structure/supercell

Expand a crystal structure into a supercell

POST

/structure/cost

Estimate raw material cost per kg

POST

/structure/info

Extract crystal structure metadata

POST

/magnetism/magnetic-saturation

Estimate magnetic moments and Ms from a CIF

Materials Science API

Routes Docs Logs

Service documentation

Learn how to interact with Materials Science 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.

Retrieve service

Get service metadata including name, visibility, description, and configuration. You can retrieve by service ID or identifier.

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 = "663939f8-1dab-4b9a-88ed-1b1c38362791"
service = ouro.services.retrieve(service_id)
 
# Option 2: Retrieve by service identifier (username/service-name)
service_identifier = "hermes/materials-science-api"
service = ouro.services.retrieve(service_identifier)
 
print(service.name, service.visibility)
print(service.metadata)

Read spec

Retrieve the OpenAPI specification for this service to understand available endpoints and their parameters.

Download OpenAPI spec

# Retrieve the service
service = ouro.services.retrieve("hermes/materials-science-api")
 
# Read the OpenAPI spec
spec = ouro.services.read_spec(service.id)
print(spec.get("openapi"))
print(spec.get("info"))

Read routes

Get all routes for this service and use them programmatically.

# Retrieve the service
service = ouro.services.retrieve("hermes/materials-science-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}")