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
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 = "0135694c-823f-4ec6-8623-29c76ac4d7b9"route = ouro.routes.retrieve(route_id)# Option 2: Retrieve by route identifier (username/route-name)route_identifier = "mmoderwell/synthesis-report-from-cif-file"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/synthesis-report-from-cif-file")# Execute the routeaction = route.execute( assets={ 'file': 'your-file-id' },)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/synthesis-report-from-cif-file")# 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')}")