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.
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 = "fc0b4cd4-baaf-480d-8846-447ff172063f"
route = ouro.routes.retrieve(route_id)
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "mmoderwell/estimate-the-curie-temperature-from-prophet-spin-exchange"
route = ouro.routes.retrieve(route_identifier)
print(route.name, route.visibility)
print(route.metadata)# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/estimate-the-curie-temperature-from-prophet-spin-exchange")
# Execute the route
action = route.execute(
input_assets={
'file': 'your-file-id'
},
)
print(action.final_data)# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/estimate-the-curie-temperature-from-prophet-spin-exchange")
# 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')}")Read the pairwise exchange couplings J_ij straight from Prophet-Spin's exchange layer in a supercell at least twice the exchange cutoff wide. The checkpoint is Heisenberg-form, so at fixed moment magnitudes E = E0 + Σ J_ij m_i·m_j is the model's exact energy, not a fit. Moments come from a magCIF's _atom_site_moment loop (for example the relax route's output) or are predicted from the lowest collinear ordering. Reports the mean-field ordering temperature, which overestimates, and the susceptibility peak of classical Heisenberg Monte Carlo, with the order-parameter curve and exchange shells (J_meV = -J_ij|m_i||m_j|; positive favors parallel moments). The Monte Carlo order parameter follows the ordering the couplings prefer (the leading mean-field modes). mean_field_ordering_overlap near 1 means that ordering is the input moments' pattern; near 0 means the couplings favor a different, possibly non-collinear, order. Classical spins with rigid magnitudes: no quantum statistics or longitudinal fluctuations.
Execution
Usage
19 callsView history