Resolve a material query · Routes on Ouro

Route documentation

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.

Request body

limit

integerDefaults to 10

Range: 1 to 50

Maximum number of candidates to return.

query

stringRequired

A material identifier, formula, or chemical system such as mp-149, 149, SiO2, or Li-Fe-O.

prefer_stable

booleanDefaults to true

If true, rank stable or lower-energy-above-hull candidates first.

Retrieve route

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 = "15b2a26b-7d93-4aef-9ccb-310f89d811df"
route = ouro.routes.retrieve(route_id)
 
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "mmoderwell/resolve-a-material-query"
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, or path parameters.

# Retrieve the route
route = ouro.routes.retrieve("mmoderwell/resolve-a-material-query")
 
# Use the route with a request body
response = route.use(
    body={
        'limit': 10,
        'query': 'example_string',
        'prefer_stable': True
    }
)
print(response)

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 route
route = ouro.routes.retrieve("mmoderwell/resolve-a-material-query")
 
# 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')}")

services