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.
Raw CIF text. Required unless file_id is given; pass exactly one.
UUID of an Ouro file asset containing a single CIF (must be downloadable by this service).
Range: 0.0005 to 0.25
Max per-axis coordinate noise (Angstrom) in each noise trial. Default: ref_symprec/5 (kept below the tolerance being tested).
Range: 0.0001 to 0.5
Tolerance (Angstrom) used for the coordinate-noise trials.
Range: 1 to 32
Number of randomized noise trials (deterministic seed).
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 = "fcef0bab-79e4-49b1-b891-af5c9d11dd40"
route = ouro.routes.retrieve(route_id)
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "apollo/probe-cif-symmetry-stability"
route = ouro.routes.retrieve(route_identifier)
print(route.name, route.visibility)
print(route.metadata)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.
# Retrieve the route
route = ouro.routes.retrieve("apollo/probe-cif-symmetry-stability")
# Execute the route
action = route.execute(
body={
'cif': 'example_string',
'file_id': 'example_string',
'noise_amp': 0.01,
'ref_symprec': 0.01,
'noise_trials': 8
},
)
print(action.final_data)# Retrieve the route
route = ouro.routes.retrieve("apollo/probe-cif-symmetry-stability")
# 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')}")Scan how a CIF's detected space group responds to spglib tolerance and bounded coordinate noise, and return a plain stability verdict.
Execution
Usage
14 callsView history