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 formula string, e.g. 'SiO2' or 'Fe2O3'
International space-group number (1–230). If not provided, will randomly select from compatible space groups with preference for higher symmetry.
Range: 1 to 100
Number of trial crystals to generate and evaluate
Whether to perform geometry optimization on the best crystal (includes variable cell optimization using isotropic mode at 0 GPa)
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 = "41a7d248-1a7f-43c5-b41d-34096c2e1c9c"
route = ouro.routes.retrieve(route_id)
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "mmoderwell/post-crystal-gen-generate"
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/post-crystal-gen-generate")
# Use the route with a request body
response = route.use(
body={
'formula': 'example_string',
'num_crystals': 10,
'optimize_geometry': False
}
)
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/post-crystal-gen-generate")
# 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')}")Generate a crystal structure using GGen
Route views over time