elevenlabs_client 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ac0295ca5dadf36f14152af7d6c2f4fa39dd7a2c8b59837551fc3bd8839d419
-  data.tar.gz: dabd65a40bb17aa262f2251f125d8edadaccde957b4fe9084b91384f59b54ee5
+  metadata.gz: 165b9737c40e5e121765cd1b279343d95a5bdf263aaf94c0d44f8205d1ba6f6d
+  data.tar.gz: e87f64475a509af9f4c5a8fc0080cc589e88a284cf5101ffe101694a188dc5f4
 SHA512:
-  metadata.gz: ceb86051b205481e427aec671deeb55fbeaff5f68bf99fe7257e34ce926cd83b7ec7644d5daf4854dc67ff6ece921c23ba99e6301063beb1116084f6820de4be
-  data.tar.gz: e6ab2b8907aa8b02e4ba222a407d5aa3c67e0e86b303421b073f0ed7744a9a9712510d88f75247cd534ddc1c67ccfb8ed5c0d411cee9cd3632288cf35d544036
+  metadata.gz: 15e3fc076b5421b37c8c137c154ce3d31e9ed1e07c366ffa47ed4b50337307da942b17ea75fe63a73805679cd07b76eeb2c56011b1ebc4ba5acbc0e477401b05
+  data.tar.gz: a8abacc7184134652c94e24a37a8f111b5a99dfb284b380f07b1a03ce945b62da5253e661f54101877a6aba2fbfd9c49dc6450cfe43fb3b728a8d07935f2f5b5

data/CHANGELOG.md

@@ -7,6 +7,226 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.8.0] - 2024-09-17
+
+### Added
+- **🏢 Admin: Workspace Management** - Complete workspace administration suite
+  - **Workspace Members** (`client.workspace_members.*`)
+    - Update member: `client.workspace_members.update_member(email:, is_locked: nil, workspace_role: nil)`
+  - **Workspace Resources** (`client.workspace_resources.*`)
+    - Get resource metadata: `client.workspace_resources.get_resource(resource_id:, resource_type:)`
+    - Share resource: `client.workspace_resources.share(resource_id:, role:, resource_type:, user_email: nil, group_id: nil, workspace_api_key_id: nil)`
+    - Unshare resource: `client.workspace_resources.unshare(resource_id:, resource_type:, user_email: nil, group_id: nil, workspace_api_key_id: nil)`
+  - **Workspace Groups** (`client.workspace_groups.*`)
+    - Search groups: `client.workspace_groups.search(name:)`
+    - Add member: `client.workspace_groups.add_member(group_id:, email:)`
+    - Remove member: `client.workspace_groups.remove_member(group_id:, email:)`
+  - **Workspace Invites** (`client.workspace_invites.*`)
+    - Invite user: `client.workspace_invites.invite(email:, group_ids: nil, workspace_permission: nil)`
+    - Invite multiple users: `client.workspace_invites.invite_bulk(emails:, group_ids: nil)`
+    - Delete invite: `client.workspace_invites.delete_invite(email:)`
+  - **Workspace Webhooks** (`client.workspace_webhooks.*`)
+    - List workspace webhooks: `client.workspace_webhooks.list(include_usages: nil)`
+
+- **📚 Admin: Enhanced User & Content Management**
+  - **User Subscription** (`client.user.*`)
+    - Get extended user subscription: `client.user.get_subscription` (alias: `subscription`)
+  - **Pronunciation Dictionaries** (`client.pronunciation_dictionaries.*`)
+    - Create dictionary from file: `client.pronunciation_dictionaries.add_from_file(name:, file_io: nil, filename: nil, description: nil, workspace_access: nil)`
+    - Create dictionary from rules: `client.pronunciation_dictionaries.add_from_rules(name:, rules:, description: nil, workspace_access: nil)`
+    - Get dictionary metadata: `client.pronunciation_dictionaries.get(pronunciation_dictionary_id)`
+    - Update dictionary: `client.pronunciation_dictionaries.update(pronunciation_dictionary_id, **attributes)`
+    - Download dictionary version (PLS): `client.pronunciation_dictionaries.download_pronunciation_dictionary_version(dictionary_id:, version_id:)`
+    - List dictionaries: `client.pronunciation_dictionaries.list_pronunciation_dictionaries(cursor:, page_size:, sort:, sort_direction:)`
+
+- **🤖 Agents Platform** - Complete conversational AI agent management system
+  - **Agent Management** (`client.agents.*`)
+    - Create agent: `client.agents.create(conversation_config:, platform_settings: nil, name: nil, tags: nil)`
+    - Get agent: `client.agents.get(agent_id)`
+    - List agents: `client.agents.list(page_size: nil, search: nil, sort_direction: nil, sort_by: nil, cursor: nil)`
+    - Update agent: `client.agents.update(agent_id, **options)`
+    - Delete agent: `client.agents.delete(agent_id)`
+    - Duplicate agent: `client.agents.duplicate(agent_id, **options)`
+  - **Conversation Management** (`client.conversations.*`)
+    - Create conversation: `client.conversations.create(agent_id:, **options)`
+    - Get conversation: `client.conversations.get(conversation_id)`
+    - List conversations: `client.conversations.list(**options)`
+    - Delete conversation: `client.conversations.delete(conversation_id)`
+    - Get conversation signatures: `client.conversations.get_conversation_signatures(conversation_id)`
+  - **Tools & Integrations** (`client.tools.*`)
+    - List tools: `client.tools.list`
+    - Get tool: `client.tools.get(tool_id)`
+    - Create tool: `client.tools.create(tool_config)`
+    - Update tool: `client.tools.update(tool_id, **options)`
+    - Delete tool: `client.tools.delete(tool_id)`
+  - **Knowledge Base** (`client.knowledge_base.*`)
+    - Create knowledge base: `client.knowledge_base.create(name:, **options)`
+    - Get knowledge base: `client.knowledge_base.get(knowledge_base_id)`
+    - List knowledge bases: `client.knowledge_base.list(**options)`
+    - Delete knowledge base: `client.knowledge_base.delete(knowledge_base_id)`
+  - **Testing & Quality Assurance** (`client.tests.*`, `client.test_invocations.*`)
+    - Create test: `client.tests.create(agent_id:, name:, test_questions:, **options)`
+    - Get test: `client.tests.get(test_id)`
+    - List tests: `client.tests.list(**options)`
+    - Delete test: `client.tests.delete(test_id)`
+    - Run test: `client.test_invocations.run(test_id:, **options)`
+    - Get test results: `client.test_invocations.get(test_invocation_id)`
+    - List test invocations: `client.test_invocations.list(**options)`
+  - **Phone & Communication** (`client.phone_numbers.*`, `client.outbound_calling.*`, `client.batch_calling.*`)
+    - List phone numbers: `client.phone_numbers.list(**options)`
+    - Get phone number: `client.phone_numbers.get(phone_number_id)`
+    - Create outbound call: `client.outbound_calling.create(agent_id:, customer_phone_number:, **options)`
+    - Submit batch calls: `client.batch_calling.submit(call_name:, agent_id:, agent_phone_number_id:, scheduled_time_unix:, recipients:)`
+    - List batch calls: `client.batch_calling.list(**options)`
+    - Get batch call: `client.batch_calling.get(batch_call_id)`
+  - **Widgets & Integration** (`client.widgets.*`)
+    - Create widget: `client.widgets.create(agent_id:, name:, **options)`
+    - Get widget: `client.widgets.get(widget_id)`
+    - List widgets: `client.widgets.list(**options)`
+    - Delete widget: `client.widgets.delete(widget_id)`
+  - **Workspace & Analytics** (`client.workspace.*`, `client.llm_usage.*`)
+    - Get workspace settings: `client.workspace.get`
+    - Update workspace: `client.workspace.update(**options)`
+    - Get LLM usage: `client.llm_usage.get(**options)`
+  - **MCP Servers** (`client.mcp_servers.*`)
+    - Create MCP server: `client.mcp_servers.create(config:)`
+    - List MCP servers: `client.mcp_servers.list`
+    - Get MCP server: `client.mcp_servers.get(mcp_server_id)`
+    - Update MCP server: `client.mcp_servers.update(mcp_server_id, **options)`
+    - Delete MCP server: `client.mcp_servers.delete(mcp_server_id)`
+
+### Enhanced
+- **🔧 HTTP Client Architecture** - Enhanced HTTP client with new methods
+  - Added `delete_with_body` method for DELETE requests with request bodies
+  - Improved error handling across all HTTP methods
+  - Enhanced configuration system with `Configuration` class
+  - Added `HttpClient` class for better separation of concerns
+
+### Docs
+- **📚 Admin Documentation**
+  - Added `docs/admin/PRONUNCIATION_DICTIONARIES.md`
+  - Added `docs/admin/WORKSPACE_GROUPS.md`
+  - Added `docs/admin/WORKSPACE_INVITES.md`
+  - Added `docs/admin/WORKSPACE_MEMBERS.md`
+  - Added `docs/admin/WORKSPACE_RESOURCES.md`
+  - Added `docs/admin/WORKSPACE_WEBHOOKS.md`
+- **🤖 Agents Platform Documentation**
+  - Added complete `docs/agents_platform/` directory with comprehensive guides:
+    - `AGENTS.md` - Agent creation and management
+    - `CONVERSATIONS.md` - Conversation handling
+    - `TOOLS.md` - Tool integration and management
+    - `KNOWLEDGE_BASE.md` - Knowledge base management
+    - `TESTS.md` - Testing and quality assurance
+    - `TEST_INVOCATIONS.md` - Test execution and results
+    - `PHONE_NUMBERS.md` - Phone number management
+    - `OUTBOUND_CALLING.md` - Outbound call handling
+    - `BATCH_CALLING.md` - Batch calling operations
+    - `WIDGETS.md` - Widget creation and embedding
+    - `WORKSPACE.md` - Workspace configuration
+    - `LLM_USAGE.md` - LLM usage analytics
+    - `MCP_SERVERS.md` - MCP server integration
+- **📖 Architecture Documentation**
+  - Added `docs/ARCHITECTURE.md` - Complete system architecture overview
+- Updated `docs/admin/README.md` and main `README.md` with all new endpoints and examples
+
+### Examples
+- **🎯 Admin Controllers** - Production-ready Rails integration examples
+  - Added `examples/admin/workspace_groups_controller.rb`
+  - Added `examples/admin/workspace_invites_controller.rb`
+  - Added `examples/admin/workspace_members_controller.rb`
+  - Added `examples/admin/workspace_resources_controller.rb`
+  - Added `examples/admin/workspace_webhooks_controller.rb`
+- **🤖 Agents Platform Controllers** - Complete conversational AI examples
+  - Added `examples/agents_platform/agents_controller.rb`
+  - Added `examples/agents_platform/conversations_controller.rb`
+  - Added `examples/agents_platform/tools_controller.rb`
+  - Added `examples/agents_platform/knowledge_base_controller.rb`
+  - Added `examples/agents_platform/tests_controller.rb`
+  - Added `examples/agents_platform/test_invocations_controller.rb`
+  - Added `examples/agents_platform/phone_numbers_controller.rb`
+  - Added `examples/agents_platform/outbound_calling_controller.rb`
+  - Added `examples/agents_platform/batch_calling_controller.rb`
+  - Added `examples/agents_platform/widgets_controller.rb`
+  - Added `examples/agents_platform/workspace_controller.rb`
+  - Added `examples/agents_platform/llm_usage_controller.rb`
+  - Added `examples/agents_platform/mcp_servers_controller.rb`
+
+## [0.7.0] - 2024-09-15
+
+### Added
+- **🗑️ Admin Samples Management** - Voice sample deletion and content moderation
+  - **Sample Deletion** (`client.samples.*`) - Delete voice samples by ID for content moderation and cleanup
+  - Comprehensive error handling for voice and sample validation
+  - Security-focused operations with proper authentication and authorization
+  - Method aliases: `delete_voice_sample`, `remove_sample`
+
+- **🏢 Admin Service Accounts** - Complete service account monitoring and management
+  - **Account Monitoring** (`client.service_accounts.*`) - List all service accounts in workspace
+  - **API Key Analytics** - Monitor API key status, permissions, and usage across all accounts
+  - **Usage Tracking** - Character usage monitoring with limits and projections
+  - **Security Auditing** - Comprehensive security analysis and compliance reporting
+  - Method aliases: `list`, `all`, `service_accounts`
+
+- **🔗 Admin Webhooks Management** - Workspace webhook monitoring and health analysis
+  - **Webhook Monitoring** (`client.webhooks.*`) - List all workspace webhooks with detailed status
+  - **Health Analysis** - Monitor webhook failures, auto-disabled status, and recent error codes
+  - **Security Auditing** - Authentication method analysis and HTTPS compliance checking
+  - **Usage Analytics** - Track webhook usage across different services and features
+  - Method aliases: `get_webhooks`, `all`, `webhooks`
+
+### Enhanced
+- **📚 Documentation Expansion** - Comprehensive documentation for new admin endpoints
+  - Added `docs/admin/SAMPLES.md` - Voice sample management and content moderation guide (883 lines)
+  - Added `docs/admin/SERVICE_ACCOUNTS.md` - Service account monitoring and security analysis guide (1,264 lines)
+  - Added `docs/admin/WEBHOOKS.md` - Webhook management and health monitoring guide (1,264 lines)
+  - Updated `docs/admin/README.md` - Enhanced admin overview with all endpoints (548 lines)
+  - Updated main README.md with new admin endpoint documentation
+  - Total: 3,959 lines of additional admin documentation
+
+- **🎯 Example Controllers** - Production-ready Rails integration examples for new endpoints
+  - Added `examples/admin/samples_controller.rb` - Sample deletion with content moderation workflows (767 lines)
+  - Added `examples/admin/service_accounts_controller.rb` - Account monitoring with analytics dashboard (500+ lines)
+  - Added `examples/admin/webhooks_controller.rb` - Webhook health monitoring with export capabilities (761 lines)
+  - All controllers include comprehensive error handling, filtering, and export functionality
+
+### Improved
+- **🧪 Test Coverage** - Comprehensive testing for all new admin endpoints
+  - Added 35 new endpoint tests covering samples, service accounts, and webhooks
+  - Added 31 new integration tests with proper WebMock stubbing and response validation
+  - Enhanced error handling tests for all new admin scenarios
+  - Total: 66 new tests, bringing total to 874 examples with 100% pass rate
+
+- **🔧 Client Integration** - Seamless integration of new admin endpoints
+  - Updated `Client` class to expose new admin endpoints (`samples`, `service_accounts`, `webhooks`)
+  - Enhanced error handling for admin-specific scenarios across all endpoints
+  - Consistent API patterns and response structures
+  - Proper namespacing under `ElevenlabsClient::Admin` module
+
+### Technical Improvements
+- **🔒 Security Management** - Advanced security monitoring and compliance
+  - Voice sample content moderation with audit trails
+  - Service account permission analysis and excessive privilege detection
+  - Webhook security auditing with HTTPS and authentication validation
+  - Comprehensive security reporting and recommendation systems
+
+- **📊 Health Monitoring** - Sophisticated health analysis across admin resources
+  - Webhook failure tracking with error code analysis and auto-disable detection
+  - Service account usage monitoring with character limit projections
+  - Sample deletion tracking for content moderation compliance
+  - Real-time health status reporting with actionable insights
+
+- **🛡️ Content Moderation** - Professional content management capabilities
+  - Secure sample deletion with proper authentication and logging
+  - Batch sample operations for efficient content cleanup
+  - Audit trail support for compliance and tracking
+  - Integration with content moderation workflows and policies
+
+- **📈 Analytics & Reporting** - Advanced analytics across all admin functions
+  - Service account usage analytics with trend analysis
+  - Webhook performance monitoring with failure rate calculations
+  - Sample deletion analytics for content moderation reporting
+  - Exportable reports in CSV, JSON, and Excel formats
+
 ## [0.6.0] - 2024-09-15
 
 ### Added

data/README.md

@@ -4,29 +4,57 @@
 
 A comprehensive Ruby client library for the ElevenLabs API, supporting voice synthesis, dubbing, dialogue generation, sound effects, AI music composition, voice transformation, speech transcription, audio isolation, and advanced audio processing features.
 
+See [Architecture Documentation](docs/ARCHITECTURE.md) for details.
+
 ## Features
 
-🎙️ **Text-to-Speech** - Convert text to natural-sounding speech  
-🎬 **Dubbing** - Create dubbed versions of audio/video content  
-💬 **Dialogue Generation** - Multi-speaker conversations  
-🔊 **Sound Generation** - AI-generated sound effects and ambient audio  
-🎵 **Music Generation** - AI-powered music composition and streaming  
-🎨 **Voice Design** - Create custom voices from text descriptions  
-🎭 **Voice Management** - Create, edit, and manage individual voices  
-🔄 **Speech-to-Speech** - Transform audio from one voice to another (Voice Changer)  
-📝 **Speech-to-Text** - Transcribe audio and video files with advanced features  
-🔇 **Audio Isolation** - Remove background noise from audio files  
-📱 **Audio Native** - Create embeddable audio players for websites  
-⏱️ **Forced Alignment** - Get precise timing information for audio transcripts  
-📊 **Admin APIs** - Complete administrative functionality:
-  - **History** - Manage and analyze your generated audio history
-  - **Usage** - Monitor character usage and analytics  
-  - **User** - Access account information and subscription details
-  - **Voice Library** - Browse and manage community shared voices
-  - **Models** - List available models and their capabilities  
-📡 **Streaming** - Real-time audio streaming  
-⚙️ **Configurable** - Flexible configuration options  
-🧪 **Well-tested** - Comprehensive test coverage  
+### 🎙️ **Core Audio Features**
+- **Text-to-Speech** - Convert text to natural-sounding speech with timestamps
+- **Speech-to-Speech** - Transform audio from one voice to another (Voice Changer)  
+- **Speech-to-Text** - Transcribe audio and video files with advanced features
+- **Text-to-Dialogue** - Multi-speaker conversations and dialogue generation
+- **Voice Design** - Create custom voices from text descriptions
+- **Voice Management** - Create, edit, and manage individual voices
+- **Audio Isolation** - Remove background noise from audio files
+- **Forced Alignment** - Get precise timing information for audio transcripts
+
+### 🎬 **Content Creation**
+- **Dubbing** - Create dubbed versions of audio/video content
+- **Sound Generation** - AI-generated sound effects and ambient audio
+- **Music Generation** - AI-powered music composition and streaming
+- **Audio Native** - Create embeddable audio players for websites
+
+### 🤖 **Agents Platform** (Conversational AI)
+- **Agents** - Create and manage AI conversational agents
+- **Conversations** - Handle real-time conversations and chat interactions
+- **Knowledge Base** - Upload and manage documents for agent knowledge
+- **Tools** - Define and manage tools that agents can use
+- **Tests** - Create and run tests for agent performance
+- **Outbound Calling** - Make automated phone calls with agents
+- **Batch Calling** - Execute large-scale calling campaigns
+- **Phone Numbers** - Manage phone numbers for voice agents
+- **Widgets** - Create embeddable chat widgets for websites
+- **LLM Usage** - Monitor and analyze language model usage
+- **MCP Servers** - Manage Model Context Protocol servers
+
+### 📊 **Admin & Management APIs**
+- **History** - Manage and analyze your generated audio history
+- **Usage** - Monitor character usage and analytics  
+- **User** - Access account information and subscription details
+- **Voice Library** - Browse and manage community shared voices
+- **Models** - List available models and their capabilities
+- **Samples** - Delete voice samples for content moderation
+- **Service Accounts** - Monitor service accounts and API keys
+- **Webhooks** - Monitor workspace webhooks and their health
+- **Workspace Management** - Manage workspace groups, invites, members, and resources
+- **Pronunciation Dictionaries** - Custom pronunciation rules
+
+### 🔧 **Technical Features**
+- **WebSocket Streaming** - Real-time audio streaming with low latency
+- **Multiple Output Formats** - Support for various audio formats
+- **Flexible Configuration** - Environment-based and programmatic configuration
+- **Comprehensive Error Handling** - Detailed error messages and status codes
+- **Well-tested** - Extensive test coverage with integration tests  
 
 ## Installation
 
@@ -75,19 +103,31 @@ export ELEVENLABS_BASE_URL="https://api.elevenlabs.io"  # Optional, defaults to
 #### Direct Configuration
 
 ```ruby
-# Module-level configuration
+# Global configuration (recommended)
 ElevenlabsClient.configure do |config|
-  config.properties = {
-    elevenlabs_base_uri: "https://api.elevenlabs.io",
-    elevenlabs_api_key: "your_api_key_here"
-  }
+  config.api_key = "your_api_key_here"
+  config.base_url = "https://api.elevenlabs.io"
+  config.timeout = 30
+  config.retry_count = 3
 end
 
-# Or pass directly to client
+# Use globally configured client
+client = ElevenlabsClient.client
+
+# Or pass directly to client instance
 client = ElevenlabsClient.new(
   api_key: "your_api_key_here",
-  base_url: "https://api.elevenlabs.io"
+  base_url: "https://api.elevenlabs.io",
+  timeout: 60
 )
+
+# Legacy Settings support (still works)
+ElevenlabsClient.configure do |config|
+  config.properties = {
+    elevenlabs_base_uri: "https://api.elevenlabs.io",
+    elevenlabs_api_key: "your_api_key_here"
+  }
+end
 ```
 
 ### Basic Usage
@@ -170,6 +210,18 @@ puts "Recent history: #{history['history'].length} items"
 voices = client.voice_library.get_shared_voices(category: "professional", page_size: 5)
 puts "Professional voices available: #{voices['voices'].length}"
 
+# Admin Samples Management
+client.samples.delete_sample(voice_id: "voice_id", sample_id: "sample_id")
+puts "Sample deleted successfully"
+
+# Service Accounts Monitoring
+accounts = client.service_accounts.get_service_accounts
+puts "Service accounts: #{accounts['service-accounts'].length}"
+
+# Webhooks Management
+webhooks = client.webhooks.list_webhooks(include_usages: true)
+puts "Active webhooks: #{webhooks['webhooks'].length}"
+
 # Music Generation
 music_data = client.music.compose(
   prompt: "Upbeat electronic dance track with synthesizers",
@@ -248,25 +300,61 @@ end
 
 ### Core APIs
 
-- **[Dubbing API](docs/DUBBING.md)** - Create dubbed versions of audio/video content
+### 🎙️ **Core Audio APIs**
 - **[Text-to-Speech API](docs/TEXT_TO_SPEECH.md)** - Convert text to natural speech
-- **[Text-to-Speech Streaming API](docs/TEXT_TO_SPEECH_STREAMING.md)** - Real-time audio streaming
-- **[Text-to-Dialogue API](docs/TEXT_TO_DIALOGUE.md)** - Multi-speaker conversations
-- **[Sound Generation API](docs/SOUND_GENERATION.md)** - AI-generated sound effects
-- **[Music Generation API](docs/MUSIC.md)** - AI-powered music composition and streaming
-- **[Text-to-Voice API](docs/TEXT_TO_VOICE.md)** - Design and create custom voices
-- **[Voice Management API](docs/VOICES.md)** - Manage individual voices (CRUD operations)
+- **[Text-to-Speech Streaming API](docs/TEXT_TO_SPEECH_STREAMING.md)** - Real-time audio streaming  
+- **[Text-to-Speech with Timestamps](docs/TEXT_TO_SPEECH_WITH_TIMESTAMPS.md)** - Speech synthesis with precise timing
 - **[Speech-to-Speech API](docs/SPEECH_TO_SPEECH.md)** - Transform audio from one voice to another
 - **[Speech-to-Text API](docs/SPEECH_TO_TEXT.md)** - Transcribe audio and video files
+- **[Text-to-Dialogue API](docs/TEXT_TO_DIALOGUE.md)** - Multi-speaker conversations
+- **[Text-to-Dialogue Streaming](docs/TEXT_TO_DIALOGUE_STREAMING.md)** - Real-time dialogue generation
+- **[Voice Design API](docs/TEXT_TO_VOICE.md)** - Design and create custom voices from text descriptions
+- **[Voice Management API](docs/VOICES.md)** - Manage individual voices (CRUD operations)
 - **[Audio Isolation API](docs/AUDIO_ISOLATION.md)** - Remove background noise from audio
-- **[Audio Native API](docs/AUDIO_NATIVE.md)** - Create embeddable audio players
-- **[Forced Alignment API](docs/FORCED_ALIGNMENT.md)** - Get precise timing information
-- **[Admin APIs](docs/admin/README.md)** - Complete administrative functionality:
-  - **[User Management](docs/admin/USER.md)** - Account information and subscription details
-  - **[Usage Analytics](docs/admin/USAGE.md)** - Character usage monitoring and analytics
-  - **[History Management](docs/admin/HISTORY.md)** - Generated audio history management
-  - **[Voice Library](docs/admin/VOICE_LIBRARY.md)** - Community voice browsing and management
-  - **[Models API](docs/admin/MODELS.md)** - List available models and capabilities
+- **[Forced Alignment API](docs/FORCED_ALIGNMENT.md)** - Get precise timing information for transcripts
+
+### 🎬 **Content Creation APIs**
+- **[Dubbing API](docs/DUBBING.md)** - Create dubbed versions of audio/video content
+- **[Sound Generation API](docs/SOUND_GENERATION.md)** - AI-generated sound effects and ambient audio
+- **[Music Generation API](docs/MUSIC.md)** - AI-powered music composition and streaming
+- **[Audio Native API](docs/AUDIO_NATIVE.md)** - Create embeddable audio players for websites
+
+### 🤖 **Agents Platform APIs** (Conversational AI)
+- **[Agents Platform Overview](docs/agents_platform/README.md)** - Complete conversational AI platform
+- **[Agents API](docs/agents_platform/AGENTS.md)** - Create and manage AI conversational agents
+- **[Conversations API](docs/agents_platform/CONVERSATIONS.md)** - Handle real-time conversations and chat interactions
+- **[Knowledge Base API](docs/agents_platform/KNOWLEDGE_BASE.md)** - Upload and manage documents for agent knowledge
+- **[Tools API](docs/agents_platform/TOOLS.md)** - Define and manage tools that agents can use
+- **[Tests API](docs/agents_platform/TESTS.md)** - Create and run tests for agent performance
+- **[Test Invocations API](docs/agents_platform/TEST_INVOCATIONS.md)** - Execute and monitor test runs
+- **[Outbound Calling API](docs/agents_platform/OUTBOUND_CALLING.md)** - Make automated phone calls with agents
+- **[Batch Calling API](docs/agents_platform/BATCH_CALLING.md)** - Execute large-scale calling campaigns
+- **[Phone Numbers API](docs/agents_platform/PHONE_NUMBERS.md)** - Manage phone numbers for voice agents
+- **[Widgets API](docs/agents_platform/WIDGETS.md)** - Create embeddable chat widgets for websites
+- **[LLM Usage API](docs/agents_platform/LLM_USAGE.md)** - Monitor and analyze language model usage
+- **[MCP Servers API](docs/agents_platform/MCP_SERVERS.md)** - Manage Model Context Protocol servers
+- **[Workspace API](docs/agents_platform/WORKSPACE.md)** - Manage agent platform workspace settings
+
+### 📊 **Admin & Management APIs**
+- **[Admin APIs Overview](docs/admin/README.md)** - Complete administrative functionality
+- **[User Management](docs/admin/USER.md)** - Account information and subscription details
+- **[Usage Analytics](docs/admin/USAGE.md)** - Character usage monitoring and analytics
+- **[History Management](docs/admin/HISTORY.md)** - Generated audio history management
+- **[Voice Library](docs/admin/VOICE_LIBRARY.md)** - Community voice browsing and management
+- **[Models API](docs/admin/MODELS.md)** - List available models and capabilities
+- **[Samples Management](docs/admin/SAMPLES.md)** - Delete voice samples for content moderation
+- **[Service Accounts](docs/admin/SERVICE_ACCOUNTS.md)** - Monitor and manage service accounts
+- **[Service Account API Keys](docs/admin/SERVICE_ACCOUNT_API_KEYS.md)** - Manage API keys for service accounts
+- **[Webhooks Management](docs/admin/WEBHOOKS.md)** - Monitor workspace webhooks and their health
+- **[Workspace Webhooks](docs/admin/WORKSPACE_WEBHOOKS.md)** - Configure and manage workspace-level webhooks
+- **[Workspace Groups](docs/admin/WORKSPACE_GROUPS.md)** - Manage user groups and members
+- **[Workspace Invites](docs/admin/WORKSPACE_INVITES.md)** - Invite users and revoke invitations
+- **[Workspace Members](docs/admin/WORKSPACE_MEMBERS.md)** - Update member attributes and roles
+- **[Workspace Resources](docs/admin/WORKSPACE_RESOURCES.md)** - Share/unshare resources across the workspace
+- **[Pronunciation Dictionaries](docs/admin/PRONUNCIATION_DICTIONARIES.md)** - Create, manage and download pronunciation dictionaries
+
+### 🔧 **Advanced Features**
+- **[WebSocket Streaming](docs/WEBSOCKET_STREAMING.md)** - Real-time audio streaming with WebSockets
 
 ### Available Endpoints
 
@@ -290,6 +378,14 @@ end
 | `client.history.*` | Generated audio history management | [HISTORY.md](docs/admin/HISTORY.md) |
 | `client.voice_library.*` | Community voice browsing and management | [VOICE_LIBRARY.md](docs/admin/VOICE_LIBRARY.md) |
 | `client.models.*` | Model information and capabilities | [MODELS.md](docs/admin/MODELS.md) |
+| `client.workspace_groups.*` | Workspace user groups management | [WORKSPACE_GROUPS.md](docs/admin/WORKSPACE_GROUPS.md) |
+| `client.workspace_invites.*` | Workspace invites management | [WORKSPACE_INVITES.md](docs/admin/WORKSPACE_INVITES.md) |
+| `client.workspace_members.*` | Workspace member management | [WORKSPACE_MEMBERS.md](docs/admin/WORKSPACE_MEMBERS.md) |
+| `client.workspace_resources.*` | Workspace resource sharing | [WORKSPACE_RESOURCES.md](docs/admin/WORKSPACE_RESOURCES.md) |
+| `client.pronunciation_dictionaries.*` | Manage pronunciation dictionaries | [PRONUNCIATION_DICTIONARIES.md](docs/admin/PRONUNCIATION_DICTIONARIES.md) |
+| `client.samples.*` | Voice sample deletion and content moderation | [SAMPLES.md](docs/admin/SAMPLES.md) |
+| `client.service_accounts.*` | Service account monitoring and management | [SERVICE_ACCOUNTS.md](docs/admin/SERVICE_ACCOUNTS.md) |
+| `client.webhooks.*` | Workspace webhook monitoring and health analysis | [WEBHOOKS.md](docs/admin/WEBHOOKS.md) |
 
 ## Configuration Options
 
@@ -343,27 +439,54 @@ end
 
 ## Rails Integration
 
-The gem is designed to work seamlessly with Rails applications. See the [examples](examples/) directory for complete controller implementations:
-
-- [DubsController](examples/dubs_controller.rb) - Complete dubbing workflow
-- [TextToSpeechController](examples/text_to_speech_controller.rb) - TTS with error handling
-- [StreamingAudioController](examples/streaming_audio_controller.rb) - Real-time streaming
-- [TextToDialogueController](examples/text_to_dialogue_controller.rb) - Dialogue generation
-- [SoundGenerationController](examples/sound_generation_controller.rb) - Sound effects
-- [MusicController](examples/music_controller.rb) - AI music composition and streaming
-- [TextToVoiceController](examples/text_to_voice_controller.rb) - Voice design and creation
-- [VoicesController](examples/voices_controller.rb) - Voice management (CRUD operations)
-- [SpeechToSpeechController](examples/speech_to_speech_controller.rb) - Voice changer and audio transformation
-- [SpeechToTextController](examples/speech_to_text_controller.rb) - Audio/video transcription with advanced features
-- [AudioIsolationController](examples/audio_isolation_controller.rb) - Background noise removal and audio cleanup
-- [AudioNativeController](examples/audio_native_controller.rb) - Embeddable audio players for websites
-- [ForcedAlignmentController](examples/forced_alignment_controller.rb) - Audio-text timing alignment and subtitle generation
+The gem is designed to work seamlessly with Rails applications. See the [examples](examples/) directory for complete controller implementations and the [Rails initializer example](examples/rails_initializer.rb) for configuration setup:
+
+- **Core Controllers**
+  - [DubsController](examples/dubs_controller.rb) - Complete dubbing workflow
+  - [TextToSpeechController](examples/text_to_speech_controller.rb) - TTS with error handling
+  - [StreamingAudioController](examples/streaming_audio_controller.rb) - Real-time streaming
+  - [TextToDialogueController](examples/text_to_dialogue_controller.rb) - Dialogue generation
+  - [SoundGenerationController](examples/sound_generation_controller.rb) - Sound effects
+  - [MusicController](examples/music_controller.rb) - AI music composition and streaming
+  - [TextToVoiceController](examples/text_to_voice_controller.rb) - Voice design and creation
+  - [VoicesController](examples/voices_controller.rb) - Voice management (CRUD operations)
+  - [SpeechToSpeechController](examples/speech_to_speech_controller.rb) - Voice changer and audio transformation
+  - [SpeechToTextController](examples/speech_to_text_controller.rb) - Audio/video transcription with advanced features
+  - [AudioIsolationController](examples/audio_isolation_controller.rb) - Background noise removal and audio cleanup
+  - [AudioNativeController](examples/audio_native_controller.rb) - Embeddable audio players for websites
+  - [ForcedAlignmentController](examples/forced_alignment_controller.rb) - Audio-text timing alignment and subtitle generation
+
 - **Admin Controllers** - Complete administrative functionality:
   - [Admin::HistoryController](examples/admin/history_controller.rb) - Generated audio history management and analytics
   - [Admin::UsageController](examples/admin/usage_controller.rb) - Character usage monitoring and analytics
   - [Admin::UserController](examples/admin/user_controller.rb) - User account and subscription management
   - [Admin::VoiceLibraryController](examples/admin/voice_library_controller.rb) - Community voice browsing and management
   - [Admin::ModelsController](examples/admin/models_controller.rb) - Model information and selection guidance
+  - [Admin::SamplesController](examples/admin/samples_controller.rb) - Voice sample deletion and content moderation
+  - [Admin::ServiceAccountsController](examples/admin/service_accounts_controller.rb) - Service account monitoring and analytics
+  - [Admin::ServiceAccountApiKeysController](examples/admin/service_account_api_keys_controller.rb) - API key management for service accounts
+  - [Admin::WebhooksController](examples/admin/webhooks_controller.rb) - Workspace webhook monitoring and health analysis
+  - [Admin::WorkspaceWebhooksController](examples/admin/workspace_webhooks_controller.rb) - Workspace-level webhook configuration
+  - [Admin::WorkspaceGroupsController](examples/admin/workspace_groups_controller.rb) - User group management and permissions
+  - [Admin::WorkspaceInvitesController](examples/admin/workspace_invites_controller.rb) - Workspace invitation management
+  - [Admin::WorkspaceMembersController](examples/admin/workspace_members_controller.rb) - Workspace member management and roles
+  - [Admin::WorkspaceResourcesController](examples/admin/workspace_resources_controller.rb) - Resource sharing and permissions
+  - [Admin::PronunciationDictionariesController](examples/admin/pronunciation_dictionaries_controller.rb) - Custom pronunciation management
+
+- **Agents Platform Controllers** - Conversational AI functionality:
+  - [AgentsPlatform::AgentsController](examples/agents_platform/agents_controller.rb) - AI agent creation and management
+  - [AgentsPlatform::ConversationsController](examples/agents_platform/conversations_controller.rb) - Real-time conversation handling
+  - [AgentsPlatform::KnowledgeBaseController](examples/agents_platform/knowledge_base_controller.rb) - Document and knowledge management
+  - [AgentsPlatform::ToolsController](examples/agents_platform/tools_controller.rb) - Agent tool management and configuration
+  - [AgentsPlatform::TestsController](examples/agents_platform/tests_controller.rb) - Agent testing and validation
+  - [AgentsPlatform::TestInvocationsController](examples/agents_platform/test_invocations_controller.rb) - Test execution and monitoring
+  - [AgentsPlatform::OutboundCallingController](examples/agents_platform/outbound_calling_controller.rb) - Automated phone call management
+  - [AgentsPlatform::BatchCallingController](examples/agents_platform/batch_calling_controller.rb) - Large-scale calling campaigns
+  - [AgentsPlatform::PhoneNumbersController](examples/agents_platform/phone_numbers_controller.rb) - Phone number management for agents
+  - [AgentsPlatform::WidgetsController](examples/agents_platform/widgets_controller.rb) - Embeddable chat widget management
+  - [AgentsPlatform::LlmUsageController](examples/agents_platform/llm_usage_controller.rb) - Language model usage analytics
+  - [AgentsPlatform::McpServersController](examples/agents_platform/mcp_servers_controller.rb) - Model Context Protocol server management
+  - [AgentsPlatform::WorkspaceController](examples/agents_platform/workspace_controller.rb) - Agent platform workspace settings
 
 ## Development