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 200
Maximum number of slab structures to emit.
Generate primitive slabs instead of conventional slabs.
Range: 1 to 4
Enumerate symmetrically distinct Miller indices up to this bound.
Return symmetrized slabs when pymatgen can identify equivalent terminations.
Center each slab within the cell.
Range: to 40
Minimum slab thickness in Å.
Optional explicit Miller indices to generate instead of max_miller enumeration.
Range: to 40
Minimum vacuum spacing in Å.
Skip CIF validity checks (parse failure, empty structure, overlapping atoms closer than 0.5 Å). Use only when you have already validated the structure.
Convert the input to a conventional standard structure before slab generation.
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.
Enumerate surface slabs from a bulk structure and return a zipped set of slab CIFs plus a manifest.
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 = "6a5e6e41-5b06-4e10-84b0-d9e05b8d7713"
route = ouro.routes.retrieve(route_id)
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "mmoderwell/generate-surface-slabs"
route = ouro.routes.retrieve(route_identifier)
print(route.name, route.visibility)
print(route.metadata)# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/generate-surface-slabs")
# Execute the route
action = route.execute(
body={
'max_slabs': 32,
'primitive': False,
'max_miller': 2,
'symmetrize': False,
'center_slab': True,
'min_slab_size': 10,
'min_vacuum_size': 15,
'bypass_cif_health_screen': False,
'conventional_standard_structure': True
},
assets={
'structure': 'your-file-id'
},
)
print(action.final_data)# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/generate-surface-slabs")
# 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')}")Execution
Usage
0 callsView history