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.
Range: 1 to 4
How many generation attempts to try
Range: 0.1 to 12
Upper Q bound kept from the PXRD pattern
Range: 0 to 10
Lower Q bound kept from the PXRD pattern
Space group prompt, for example Fm-3m
Chemical formula prompt, for example Ce1O2
Range: 0.1 to 2
Sampling randomness during generation
Range: 512 to 4096
Maximum length of the generated CIF
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 = "ff5d5921-5cc5-4a5f-8322-4f25cc3cd460"
route = ouro.routes.retrieve(route_id)
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "fupperlidt/predict-cif-from-pxrd"
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.
# Retrieve the route
route = ouro.routes.retrieve("fupperlidt/predict-cif-from-pxrd")
# Execute the route
action = route.execute(
body={
'n_trials': 1,
'q_max_crop': 10,
'q_min_crop': 0,
'temperature': 1,
'max_new_tokens': 3076
},
assets={
'file': 'your-file-id'
},
)
print(action.final_data)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("fupperlidt/predict-cif-from-pxrd")
# 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')}")Accepts an .xy/.xye file and runs deCIFer to predict a CIF file.
High-level guide for using deCIFer in Ouro, with embedded starter PXRD example files.