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
factor
integerDefaults to 1
Range: 1 to 20
Multiplication factor for the composition's stoichiometry
n_samples
integerDefaults to 4
Range: 1 to 100
How many structures to generate
target_composition
stringRequired
Target chemical composition (e.g., 'TiO2', 'LiMnO4')
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 = "26117dd1-cfcb-46f8-907e-1225588ccaee"route = ouro.routes.retrieve(route_id)# Option 2: Retrieve by route identifier (username/route-name)route_identifier = "mmoderwell/generate-crystal-structures-for-target-compositions"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, path parameters, or asset IDs.
# Retrieve the routeroute = ouro.routes.retrieve("mmoderwell/generate-crystal-structures-for-target-compositions")# Execute the routeaction = route.execute( body={ 'factor': 1, 'n_samples': 4, 'target_composition': 'example_string' },)print(action.final_data)
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-crystal-structures-for-target-compositions")# 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')}")
Overview
No compatible actions yet
Join to comment
Generate crystal structures for target compositions