Learn how to interact with this route 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.
Parameters and request body schema for this route.
Chemical system to report
Include stability breakdown
Filter by space group number or symbol
Return stable and near-hull structures
Return structures on hull and dynamically stable
Range: 0 to 2
Energy above hull cutoff in eV/atom
Filter by crystal system
Get route metadata including name, visibility, description, and endpoint details. You can retrieve by route 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 route ID
route_id = "d10241ae-e66b-49a9-b8bf-ca1af66b8803"
route = ouro.routes.retrieve(route_id)
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "mmoderwell/generate-a-ggen-system-report"
route = ouro.routes.retrieve(route_identifier)
print(route.name, route.visibility)
print(route.metadata)Execute the route endpoint with request body, query parameters, or path parameters.
# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/generate-a-ggen-system-report")
# Use the route with a request body
response = route.use(
body={
'system': 'example_string',
'breakdown': False,
'stable_only': False,
'fully_stable': False,
'energy_cutoff': 0.15
}
)
print(response)Get the request and response history for this route. Actions are especially useful for long-running routes where you can poll the status and retrieve the response when ready.
# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/generate-a-ggen-system-report")
# Read all actions (request/response history) for this route
actions = route.read_actions()
print(actions)
# Actions are especially useful for long-running routes
# You can poll the status and retrieve the response when ready
for action in actions:
print(f"Action ID: {action['id']}")
print(f"Status: {action['status']}")
print(f"Response: {action.get('response_data')}")No compatible actions for routes yet
Report on explored structures, stability, hull status, and filters.