Generate a crystal structure with MatterGen · Routes on Ouro
6mo
Route documentation
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.
Request format
Parameters and request body schema for this route.
Parameters
ouro-route-id
in header
ouro-route-org-id
in header
ouro-route-team-id
in header
ouro-action-id
in header
Request body
chemical_system
stringRequired
Chemical system to generate (e.g., 'Li-O' or 'Fe-Co-Ni')
guidance_factor
numberDefaults to 2
Range: 0 to 10
Diffusion guidance factor. Higher values produce samples that better match the target property but may be less realistic.
Retrieve route
Get route metadata including name, visibility, description, and endpoint details. You can retrieve by route ID or identifier.
import osfrom 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 IDroute_id = "11ef966a-c862-454b-9095-2bef243d5239"route = ouro.routes.retrieve(route_id)# Option 2: Retrieve by route identifier (username/route-name)route_identifier = "mmoderwell/generate-a-crystal-structure-with-mattergen"route = ouro.routes.retrieve(route_identifier)print(route.name, route.visibility)print(route.metadata)
Use route
Execute the route endpoint with request body, query parameters, or path parameters.
# Retrieve the routeroute = ouro.routes.retrieve("mmoderwell/generate-a-crystal-structure-with-mattergen")# Use the route with a request bodyresponse = route.use( body={ 'chemical_system': 'example_string', 'guidance_factor': 2 })print(response)
Read actions
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 routeroute = ouro.routes.retrieve("mmoderwell/generate-a-crystal-structure-with-mattergen")# Read all actions (request/response history) for this routeactions = route.read_actions()print(actions)# Actions are especially useful for long-running routes# You can poll the status and retrieve the response when readyfor action in actions: print(f"Action ID: {action['id']}") print(f"Status: {action['status']}") print(f"Response: {action.get('response_data')}")