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.
Named radiation supported by pymatgen (e.g. CuKa, MoKa).
Range: 0 to 50
Maximum number of strongest peaks to annotate in the preview plot.
Range: 0 to 100
Minimum relative peak intensity (0-100) to keep in the summary.
Lower and upper bounds of the simulated 2-theta window in degrees.
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 = "fcd0f1fe-d001-43a5-adf4-35d6d4563ae3"
route = ouro.routes.retrieve(route_id)
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "mmoderwell/simulate-an-x-ray-diffraction-pattern"
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/simulate-an-x-ray-diffraction-pattern")
# Use the route with a request body
response = route.use(
body={
'wavelength': 'CuKa',
'annotate_peaks': 12,
'peak_threshold': 1,
'two_theta_range': []
}
)
print(response)input_assetPass asset IDs separately from the request body and Ouro will resolve them into the body sent to the service.
# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/simulate-an-x-ray-diffraction-pattern")
# Use route with asset IDs - Ouro resolves them into the request body
response = route.use(
body={
'wavelength': 'CuKa',
'annotate_peaks': 12,
'peak_threshold': 1,
'two_theta_range': []
},
input_asset={
"assetId": "your-file-id",
"assetType": "file"
},
)
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/simulate-an-x-ray-diffraction-pattern")
# 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 simulated powder XRD pattern and return a previewable plot with peak metadata.