audixa 1.0.0 → 2.0.0

package/README.md

@@ -47,7 +47,7 @@ const audixa = new Audixa('your-api-key');
 // Generate TTS and wait for completion
 const audioUrl = await audixa.generateTTS({
   text: 'Hello! This is a test of the Audixa text-to-speech API.',
-  voice: 'en-US-female-1',
+  voice_id: 'emma',
   model: 'base'
 });
 
@@ -61,10 +61,9 @@ const { Audixa } = require('audixa');
 
 const audixa = new Audixa('your-api-key');
 
-// Generate TTS and wait for completion
 audixa.generateTTS({
   text: 'Hello! This is a test of the Audixa text-to-speech API.',
-  voice: 'en-US-female-1',
+  voice_id: 'emma',
   model: 'base'
 }).then(audioUrl => {
   console.log('Audio URL:', audioUrl);
@@ -80,7 +79,7 @@ const audixa = new Audixa('your-api-key');
 
 const audioUrl = await audixa.generateTTS({
   text: 'Hello! This is a test of the Audixa text-to-speech API.',
-  voice: 'en-US-female-1'
+  voice_id: 'emma'
 });
 
 console.log('Audio URL:', audioUrl);
@@ -92,8 +91,9 @@ console.log('Audio URL:', audioUrl);
 import Audixa from 'audixa';
 
 const audixa = new Audixa('your-api-key', {
-  baseUrl: 'https://api.audixa.ai/v2', // Custom API base URL (optional)
-  timeout: 30000                         // Request timeout in ms (default: 30000)
+  baseUrl: 'https://api.audixa.ai/v3', // Custom API base URL (optional)
+  timeout: 30000,                      // Request timeout in ms (default: 30000)
+  customEndpointSlug: 'client1'        // Optional default custom endpoint
 });
 ```
 
@@ -101,26 +101,26 @@ const audixa = new Audixa('your-api-key', {
 
 ### Start TTS Generation
 
-Creates a new text-to-speech task and returns a generation ID.
+Creates a new text-to-speech task and returns the generation details.
 
 ```typescript
-const { generation_id } = await audixa.startTTS({
+const result = await audixa.startTTS({
   // Required parameters
   text: 'Your text here (minimum 30 characters)',
-  voice: 'en-US-female-1',
+  voice_id: 'emma',
 
   // Optional parameters
-  model: 'base',        // 'base' or 'advance'
+  model: 'base',        // 'base' or 'advanced'
   speed: 1.0,           // 0.5 to 2.0
+  audio_format: 'mp3',  // 'wav' or 'mp3'
 
-  // Advance model only
-  emotion: 'happy',     // 'neutral', 'happy', 'sad', 'angry', 'surprised'
-  temperature: 0.8,     // 0.7 to 0.9
-  top_p: 0.9,           // 0.7 to 0.98
-  do_sample: true
+  // Advanced model only
+  cfg_weight: 2.5,      // 1.0 to 5.0
+  exaggeration: 0.5     // 0.0 to 1.0
 });
 
-console.log('Generation ID:', generation_id);
+console.log('Generation ID:', result.generation_id);
+console.log('Status:', result.status);
 ```
 
 ### Poll TTS Status
@@ -130,27 +130,27 @@ Check the status of a TTS generation job.
 ```typescript
 const status = await audixa.getStatus(generation_id);
 
-console.log('Status:', status.status);      // 'Generating', 'Completed', or 'Failed'
-console.log('Audio URL:', status.audio_url); // Available when status is 'Completed'
+console.log('Status:', status.status);      // 'IN_QUEUE', 'GENERATING', 'COMPLETED', 'FAILED'
+console.log('Audio URL:', status.audio_url); // Available when status is 'COMPLETED'
 ```
 
 ### Complete Polling Example
 
 ```typescript
-async function generateAndWait(text: string, voice: string): Promise<string> {
+async function generateAndWait(text: string, voiceId: string): Promise<string> {
   // Start generation
-  const { generation_id } = await audixa.startTTS({ text, voice });
+  const { generation_id } = await audixa.startTTS({ text, voice_id: voiceId });
 
   // Poll until complete
   while (true) {
     const status = await audixa.getStatus(generation_id);
 
-    if (status.status === 'Completed') {
+    if (status.status === 'COMPLETED') {
       return status.audio_url!;
     }
 
-    if (status.status === 'Failed') {
-      throw new Error('TTS generation failed');
+    if (status.status === 'FAILED') {
+      throw new Error(status.error_message || 'TTS generation failed');
     }
 
     // Wait 1 second before polling again
@@ -163,27 +163,71 @@ Or use the convenience method:
 
 ```typescript
 const audioUrl = await audixa.generateTTS(
-  { text: 'Your text here', voice: 'en-US-female-1' },
+  { text: 'Your text here', voice_id: 'emma' },
   { pollInterval: 1000, maxWaitTime: 60000 }
 );
 ```
 
 ### Get Available Voices
 
-Retrieve the list of available voices for a specific model.
+Retrieve the list of available voices.
 
 ```typescript
-const { voices } = await audixa.getVoices('base');
+const { voices, limit, offset, length } = await audixa.getVoices({
+  model: 'base',
+  limit: 100,
+  offset: 0
+});
 
 for (const voice of voices) {
   console.log(`${voice.name} (${voice.voice_id})`);
+  console.log(`  Model: ${voice.model}`);
   console.log(`  Gender: ${voice.gender}`);
   console.log(`  Accent: ${voice.accent}`);
   console.log(`  Free: ${voice.free}`);
-  console.log(`  Description: ${voice.description}`);
+  console.log(`  Custom: ${voice.is_custom}`);
 }
 ```
 
+### Get Generation History
+
+Retrieve your recent generation history.
+
+```typescript
+const history = await audixa.getHistory({
+  limit: 20,
+  offset: 0,
+  status: 'COMPLETED'
+});
+
+console.log('History length:', history.length);
+```
+
+### Custom Endpoints
+
+Use a dedicated endpoint slug for enterprise routing. You can set a default slug on the client or provide it per request.
+
+```typescript
+const audixa = new Audixa('your-api-key', {
+  customEndpointSlug: 'client1'
+});
+
+// Uses /v3/custom/client1/tts
+const result = await audixa.startTTS({
+  text: 'Hello from a custom endpoint',
+  voice_id: 'emma'
+});
+```
+
+Per-request override:
+
+```typescript
+const result = await audixa.startTTS(
+  { text: 'Hello', voice_id: 'emma' },
+  { customEndpointSlug: 'client2' }
+);
+```
+
 ## Error Handling
 
 The SDK provides a custom `AudixaError` class for comprehensive error handling:
@@ -196,7 +240,7 @@ const audixa = new Audixa('your-api-key');
 try {
   const result = await audixa.startTTS({
     text: 'Hello world',
-    voice: 'en-US-female-1'
+    voice_id: 'emma'
   });
 } catch (error) {
   if (error instanceof AudixaError) {
@@ -215,7 +259,10 @@ try {
         console.log('Please check your request parameters');
         break;
       case 'FORBIDDEN':
-        console.log('You do not have access to this voice');
+        console.log('You do not have access to this resource');
+        break;
+      case 'RATE_LIMITED':
+        console.log('Too many requests');
         break;
       case 'TIMEOUT':
         console.log('The request timed out');
@@ -237,6 +284,7 @@ try {
 | `INSUFFICIENT_CREDITS` | 402 | Not enough credits in account |
 | `FORBIDDEN` | 403 | Access denied to resource |
 | `NOT_FOUND` | 404 | Resource not found |
+| `RATE_LIMITED` | 429 | Rate limit exceeded |
 | `TIMEOUT` | - | Request timed out |
 | `NETWORK_ERROR` | - | Network connectivity issue |
 
@@ -252,7 +300,7 @@ setTimeout(() => controller.abort(), 5000);
 
 try {
   const result = await audixa.startTTS(
-    { text: 'Hello world', voice: 'en-US-female-1' },
+    { text: 'Hello world', voice_id: 'emma' },
     { signal: controller.signal }
   );
 } catch (error) {
@@ -276,14 +324,21 @@ import Audixa, {
   StartTTSRequest,
   StartTTSResponse,
   TTSStatusResponse,
+  TTSResponse,
   TTSModel,
-  TTSEmotion,
   TTSStatus,
+  TTSHistoryStatus,
+  TTSAudioFormat,
 
   // Voice types
   GetVoicesResponse,
+  VoicesResponse,
   Voice,
 
+  // History types
+  HistoryResponse,
+  HistoryItem,
+
   // Error types
   AudixaError,
   AudixaErrorCode
@@ -295,33 +350,32 @@ import Audixa, {
 ```typescript
 // TTS Request
 interface StartTTSRequest {
-  text: string;            // Required, min 30 chars
-  voice: string;           // Required
-  model?: 'base' | 'advance';
-  speed?: number;          // 0.5 - 2.0
-
-  // Advance model only
-  emotion?: 'neutral' | 'happy' | 'sad' | 'angry' | 'surprised';
-  temperature?: number;    // 0.7 - 0.9
-  top_p?: number;          // 0.7 - 0.98
-  do_sample?: boolean;
+  text: string;
+  voice_id: string;
+  model?: 'base' | 'advanced';
+  speed?: number;
+  cfg_weight?: number;
+  exaggeration?: number;
+  audio_format?: 'wav' | 'mp3';
 }
 
-// TTS Status Response
-interface TTSStatusResponse {
-  status: 'Generating' | 'Completed' | 'Failed';
-  audio_url: string | null;
-  generation_id?: string;
+// TTS Response
+interface TTSResponse {
+  generation_id: string;
+  status: 'IN_QUEUE' | 'GENERATING' | 'COMPLETED' | 'FAILED';
+  audio_url?: string | null;
+  error_message?: string | null;
 }
 
 // Voice
 interface Voice {
   voice_id: string;
   name: string;
-  gender: string;
-  accent: string;
+  model: 'base' | 'advanced';
+  gender?: string;
+  accent?: string;
   free: boolean;
-  description: string;
+  is_custom: boolean;
 }
 ```
 
@@ -340,3 +394,4 @@ MIT © [anurag-pro](https://github.com/anurag-pro)
 - [API Documentation](https://docs.audixa.ai)
 - [GitHub Repository](https://github.com/AudixaAI/audixa-npm-sdk)
 - [npm Package](https://www.npmjs.com/package/audixa)
+# audixa-npm-package