# ShareBrain - AI Agent Platform

> ShareBrain is a comprehensive platform for creating, managing, and integrating AI agents with advanced features like memory systems, voice capabilities, and developer APIs.

## 🚀 Quick Links

### For AI Developers & Systems
- **Developer Portal**: https://sharebrains.net/api-portal
- **API Documentation**: https://sharebrains.net/api-docs
- **API Base URL**: https://sharebrains.net/api/v1
- **Agent Directory**: https://sharebrains.net/directory

### Key Resources
- **Main Website**: https://sharebrains.net
- **OpenAPI Spec**: https://sharebrains.net/openapi.json (for programmatic discovery)
- **Sitemap**: https://sharebrains.net/sitemap.xml
- **Root LLM.txt**: https://sharebrains.net/llm.txt (this file)

## 🤖 API Integration

ShareBrain provides a REST API with OpenAI-compatible endpoints for integrating 100+ specialized AI agents.

### OpenAPI/Swagger Specification
For programmatic API discovery and integration:
- **OpenAPI 3.0 Spec**: https://sharebrains.net/openapi.json
- **Swagger UI Compatible**: Import the spec into any Swagger UI tool
- **Auto-generate Clients**: Use OpenAPI generators for any language

### Authentication
All API requests require an API key (prefix: `sb-`):
```
Authorization: Bearer sb-your-api-key-here
```

Get your API key at: https://sharebrains.net/api-portal

### Core Endpoints

**List Agents**
```
GET https://sharebrains.net/api/v1/agents
```

**Chat with Agent**
```
POST https://sharebrains.net/api/v1/agents/{agent_id}/completions
Content-Type: application/json

{
  "messages": [{"role": "user", "content": "Your message"}],
  "temperature": 0.7,
  "max_tokens": 500
}
```

**Generate Speech (TTS)**
```
POST https://sharebrains.net/api/v1/agents/{agent_id}/speech
Content-Type: application/json

{
  "text": "Text to convert to speech",
  "voice_type": "alloy"
}
```

**Get Agent Details**
```
GET https://sharebrains.net/api/v1/agents/{agent_id}
```

### Rate Limits
- 100 requests per hour per API key
- SHA256 key hashing for security
- Comprehensive error handling

## 📚 Documentation

### Primary Documentation
- **Complete API Docs (Web)**: https://sharebrains.net/api-docs
- **Complete API Docs (Text)**: https://sharebrains.net/api-docs.txt (for AI tools & web scrapers)
- **Developer Guide**: https://sharebrains.net/api-portal
- **Technical Docs**: See API_DOCUMENTATION.md in project

### Code Examples

**JavaScript/Node.js**
```javascript
const response = await fetch('https://sharebrains.net/api/v1/agents/48/completions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sb-your-api-key',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    messages: [{ role: 'user', content: 'Hello!' }]
  })
});
const data = await response.json();
console.log(data.choices[0].message.content);
```

**Python**
```python
import requests

response = requests.post(
    'https://sharebrains.net/api/v1/agents/48/completions',
    headers={'Authorization': 'Bearer sb-your-api-key'},
    json={'messages': [{'role': 'user', 'content': 'Hello!'}]}
)
print(response.json()['choices'][0]['message']['content'])
```

## 🔍 Agent Discovery

Each agent has its own LLM.txt file with specific capabilities:
```
https://sharebrains.net/api/agents/{agent_id}/llm.txt
```

Browse all available agents:
- Web UI: https://sharebrains.net/directory
- API: https://sharebrains.net/api/v1/agents

## 🌟 Platform Features

### Core Capabilities
- **100+ Specialized Agents**: Customer support, language tutors, assistants, etc.
- **Memory Systems**: Personal, Friends, and Global memory for context
- **Voice (TTS)**: Text-to-speech with 6 voice options (alloy, echo, fable, onyx, nova, shimmer)
- **Developer API**: RESTful API with OpenAI-compatible format
- **LLM.txt Protocol**: AI-to-AI communication standard

### Agent Categories
- Language Teachers (50+ languages)
- Customer Support
- Personal Assistants
- Content Creation
- Technical Support
- Business & Finance
- Healthcare & Wellness
- Education & Learning

## 🔐 Security & Privacy
- API key authentication with SHA256 hashing
- Rate limiting (100 req/hour)
- Encrypted storage for sensitive data
- GDPR-compliant data handling

## 💡 Use Cases

### For Developers
1. **Chatbot Integration**: Add AI agents to your app
2. **Voice Applications**: Text-to-speech for accessibility
3. **Multi-language Support**: Language tutors for education apps
4. **Customer Support**: Automated support agents

### For AI Systems
1. **Agent Discovery**: Use LLM.txt protocol to find agents
2. **Service Integration**: Connect to ShareBrain agents via API
3. **Multi-agent Systems**: Orchestrate multiple specialized agents
4. **Voice Generation**: TTS for AI responses

## 📞 Support & Contact
- **Platform**: ShareBrain
- **Website**: https://sharebrains.net
- **API Support**: Available through developer portal
- **Status**: Active and maintained

## 🔗 Important URLs Summary
- **OpenAPI Spec**: https://sharebrains.net/openapi.json (for AI systems & automated tools)
- **Developer Portal**: https://sharebrains.net/api-portal (get API keys)
- **API Documentation (Web)**: https://sharebrains.net/api-docs (interactive web docs)
- **API Documentation (Text)**: https://sharebrains.net/api-docs.txt (AI-friendly plain text docs)
- **Agent Directory**: https://sharebrains.net/directory (browse all agents)
- **Sitemap**: https://sharebrains.net/sitemap.xml (SEO)
- **This File**: https://sharebrains.net/llm.txt (AI discovery)

---
*Last Updated: 2025-11-04*
*LLM.txt Protocol Version: 1.0*
*For AI systems and developers integrating with ShareBrain*