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

team_id

stringRequired

The ID of the team to create a recap for

end_date

The end date of the recap range

start_date

The start date of the recap range

lookback_days

The number of days to look back at for the recap

with_comments

booleanDefaults to false

Whether to include comments in the context

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 = "0e60b1a4-feae-4720-b5e8-6ca5ad714009"
route = ouro.routes.retrieve(route_id)
 
# Option 2: Retrieve by route identifier (username/route-name)
route_identifier = "hermes/post-recap"
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("hermes/post-recap")
 
# Use the route with a request body
response = route.use(
    body={
        'team_id': 'example_string',
        'with_comments': False
    }
)
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("hermes/post-recap")
 
# 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