> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oyester.metaphy.live/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Welcome to the Blue Oyster Personal Companion API documentation

# Blue Oyster Personal Companion

The Blue Oyster Personal Companion is an AI-powered spiritual guidance and personal development platform that provides intelligent conversation, tool-based assistance, and personalized experiences through multiple personality modes.

## Overview

This comprehensive API provides access to a sophisticated companion agent that supports:

* **Intelligent Conversations**: Context-aware dialogue with conversation persistence
* **Tool Integration**: Weather information, spiritual destination discovery, and meditation audio
* **Multiple Personalities**: Four distinct personality modes (Guru, Wanderer, Friend, Philosopher)
* **Streaming & Non-Streaming**: Both real-time streaming and traditional request-response formats
* **Speech-to-Text**: Audio transcription capabilities
* **Memory Management**: Thread-based conversation persistence via MongoDB

## Key Features

### 🤖 Advanced AI Companion

* Powered by state-of-the-art language models
* Context-aware conversations with memory persistence
* Multiple personality modes for different interaction styles

### 🛠️ Integrated Tools

* **Weather Tool**: Real-time weather information for meditation planning
* **Destinations Tool**: Curated spiritual destinations database
* **Meditation Audio Tool**: Premium meditation and ambient audio tracks

### 🎭 Personality Modes

* **Guru**: Wisdom-focused, authoritative guidance
* **Wanderer**: Adventure-oriented, exploratory conversations
* **Friend**: Warm, supportive, accessible interactions
* **Philosopher**: Intellectual, analytical, questioning approach

### 🔄 Real-time Streaming

* Server-Sent Events (SSE) for real-time responses
* Tool execution with live updates
* Progressive text generation

## Base URL

```
https://oyester.metaphy.live/
```

## Quick Start

<CardGroup cols={2}>
  <Card title="Make Your First API Call" icon="bolt" href="/quick-start">
    Get started with a simple API request
  </Card>

  <Card title="Explore API Endpoints" icon="code" href="/api/generate">
    View detailed API reference
  </Card>
</CardGroup>

## Architecture

The API is built on [Mastra](https://mastra.ai), a modern AI framework that provides:

* Agent orchestration and management
* Tool execution and result handling
* Memory and conversation persistence
* Voice and speech processing capabilities
* Evaluation and scoring systems

## Authentication

<Note>
  The API currently operates without authentication by default. For production deployments, consider implementing authentication based on your security requirements.
</Note>

User identification is handled through the `resourceId` parameter for conversation persistence and personalization.