API Reference Overview
How to think about Oriyn API access during beta.
The public API is available to approved beta users for product, persona, pattern, and research workflows. MCP is the recommended integration path for most agents.
API Scope
The Oriyn API backs the web app and CLI. During beta, direct API access is intended for approved integrations and internal automation where the CLI is not the right transport.
| Area | Typical use |
|---|---|
| Products | Resolve organizations, products, and product context. |
| Personas | List personas and inspect source-backed profile details. |
| Patterns | Read mined hypotheses and bottlenecks. |
| Research | Create, poll, and fetch research runs. |
Authentication
Use the web app to manage account access and tokens. For agent clients, connect Oriyn through remote MCP. For terminal automation, pass a token through ORIYN_ACCESS_TOKEN and let the CLI handle request shape, retries, redaction, polling, and output mode.
Choose MCP First
Recommended path
If you are building an agent workflow, start with Oriyn MCP. Use the CLI for terminal and CI workflows. Reach for direct API access only when you need a product-specific integration MCP or the CLI cannot express.