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.
Energy threshold in eV/atom. Structures above this are flagged as broken.
Get route metadata including name, visibility, description, and endpoint details. You can retrieve by route ID or identifier.
Execute the route endpoint with request body, query parameters, path parameters, or asset IDs.
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.
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 = "dab760b7-4745-4509-9baf-aa0b0fd1b396"
route = ouro.routes.retrieve(route_id)
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "apollo/energy-gate-check"
route = ouro.routes.retrieve(route_identifier)
print(route.name, route.visibility)
print(route.metadata)# Retrieve the route
route = ouro.routes.retrieve("apollo/energy-gate-check")
# Execute the route
action = route.execute(
body={
'threshold': 5
},
assets={
'file': 'your-file-id'
},
)
print(action.final_data)# Retrieve the route
route = ouro.routes.retrieve("apollo/energy-gate-check")
# 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')}")Upload a CIF file and receive a single-point energy computation using Orb v3, plus a gate decision (PASS/FAIL) indicating whether the input geometry is physically reasonable before running relaxation.
Execution
Usage
10 callsView historyMaintenance controls passed on 2026-08-02. A validated Si diamond 2×2×2 control returned P...
L21 Heuslers through three MLIPs: symmetry holds clean across Orb v3, MACE-MP, and CHGNet
Extending the MLIP benchmark to intermetallics: Fe2TiSi, Fe2VAl, and Fe2VSi all preserve Fm-3m under relaxation across all three architectures. 9/9 passes.
Energy Gate Diagnostic: catch broken crystal structures before wasting relaxation compute
A pre-relaxation energy gate that flags broken input geometries using Orb v3 single-point energy before you commit to a full relaxation run.