Skip to content

"List prebuilt voices" endpoint failing in NodeJS library v0.21.0 - Breaking API response changes #66

@sourav-bhar

Description

@sourav-bhar

🐛 Bug Report: "List prebuilt voices" endpoint failing in NodeJS library v0.21.0

🔍 Problem Description

The "List prebuilt voices" endpoint is currently erroring out in the NodeJS library (v0.21.0). Upon inspection, the response interface appears to have been updated in a breaking way, which is likely contributing to this issue.

📚 Documentation Reference

🎯 Expected Behavior

The endpoint should return a response that matches the VoiceInfo[] type definition:

export type VoiceInfo = {
    id: string;
    name: string;
    voiceEngine: VoiceEngine;
    sampleUrl?: string;
    language?: string;
    languageCode?: string;
    gender?: VoiceGender;
    accent?: string;
    ageGroup?: VoiceAgeGroup;
    styles?: Array<string>;
    isCloned: boolean;
};

❌ Actual Behavior

The API returns a different structure with breaking changes in property naming:

{
    "id": "s3://voice-cloning-zero-shot/d82d246c-148b-457f-9668-37b789520891/adolfosaad/manifest.json",
    "name": "Adolfo",
    "sample": "https://parrot-samples.s3.amazonaws.com/kettle/adolfo.wav",
    "accent": "american",
    "age": "adult",
    "gender": "male",
    "language": "English (US)",
    "language_code": "en-US",      // 🚨 BREAKING: Expected "languageCode"
    "loudness": "neutral",
    "style": "narrative",
    "tempo": "fast",
    "texture": "thick",
    "is_cloned": false,            // 🚨 BREAKING: Expected "isCloned"
    "voice_engine": "PlayHT2.0"   // 🚨 BREAKING: Expected "voiceEngine"
}

🚨 Breaking Changes Identified

  1. language_code → Expected: languageCode
  2. is_cloned → Expected: isCloned
  3. voice_engine → Expected: voiceEngine

🔧 Steps to Reproduce

  1. Install NodeJS library v0.21.0
  2. Call the "List prebuilt voices" endpoint
  3. Observe the error due to interface mismatch

💥 Impact

  • Severity: High
  • Impact: Production application is currently broken
  • Urgency: Immediate fix required

🙏 Request

Please prioritize this issue as it's currently breaking our production application. The fix would likely involve either:

  1. Updating the NodeJS library types to match the actual API response, or
  2. Updating the API response to match the documented interface

Environment:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions