4mo

Service Documentation

Learn how to interact with Research API 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.

Getting Started

Use the Ouro SDK to retrieve service metadata and interact with the API programmatically.

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"))
 
service_id = "23b06dbf-ed33-42f6-a557-848f23072a0a"
 
# Retrieve service metadata
s = ouro.services.retrieve(service_id)
print(s.name, s.visibility)
 
# Optionally read the OpenAPI spec
spec = ouro.services.read_spec(service_id)
print(spec.get("openapi"))

OpenAPI Specification

Download the complete OpenAPI spec for this service.

Download Spec

Available Endpoints

POST

/recap

Create a recap post from the posts in a team

POST

/analyze-post

Analyze a post for validity, mistakes, and logic issues