{"_id":"fish-audio","_rev":"9-3870aa022482fd2fed585ad9dbea1aaf","name":"fish-audio","dist-tags":{"latest":"0.1.0"},"versions":{"0.0.1":{"name":"fish-audio","version":"0.0.1","keywords":["tts"],"author":"","license":"MIT","_id":"fish-audio@0.0.1","maintainers":[{"name":"kcui5","email":"kylecui@berkeley.edu"}],"homepage":"https://github.com/kcui5/fish-audio-typescript#readme","bugs":{"url":"https://github.com/kcui5/fish-audio-typescript/issues"},"dist":{"shasum":"fd6ac00c55cbaa380ea2703ae9e6ca84fd75aec4","tarball":"https://registry.npmjs.org/fish-audio/-/fish-audio-0.0.1.tgz","fileCount":440,"integrity":"sha512-BtdJnNJMOVGEISE6FOS2Xzu3tEHshm+yqcGeDQef6u6An+rjhplDZdLV9vKMJNbQG1MJePTl6eesubK0rBXSIQ==","signatures":[{"sig":"MEUCID5AzeqpzhT+wufBRdAe7/rvZPvdlHD+b3m6L4f5wYjuAiEAhiiYOicwElBz8unWmCjGGc7chexSdwVd9AYCMXYg1Kk=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":474638},"main":"./dist/cjs/index.js","type":"module","types":"./dist/esm/index.d.ts","module":"./dist/esm/index.js","exports":{".":{"import":"./dist/esm/index.js","require":"./dist/cjs/index.js"}},"gitHead":"c4d42a90834f3424cb59ff4976924fb07cb47a33","scripts":{"test":"echo \"No tests yet\" && exit 0","build":"npm run clean && npm run build:cjs && npm run build:esm","clean":"rm -rf dist","build:cjs":"tsc --project tsconfig.json --module CommonJS --outDir dist/cjs --moduleResolution node","build:esm":"tsc --project tsconfig.json --outDir dist/esm --moduleResolution bundler"},"_npmUser":{"name":"kcui5","email":"kylecui@berkeley.edu"},"repository":{"url":"git+https://github.com/kcui5/fish-audio-typescript.git","type":"git"},"_npmVersion":"10.9.0","description":"To provide convenient Node.js program integration for https://docs.fish.audio","directories":{},"_nodeVersion":"22.11.0","dependencies":{"ws":"^8.18.3","node-fetch":"^3.3.2","command-exists":"^1.2.9","@msgpack/msgpack":"^3.1.2"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.0","@types/ws":"^8.18.1","typescript":"^5.9.3","@types/node":"^24.9.1","@types/command-exists":"^1.2.3"},"_npmOperationalInternal":{"tmp":"tmp/fish-audio_0.0.1_1762313835762_0.5803914546361788","host":"s3://npm-registry-packages-npm-production"}},"0.0.2":{"name":"fish-audio","version":"0.0.2","keywords":["tts"],"author":"","license":"MIT","_id":"fish-audio@0.0.2","maintainers":[{"name":"kcui5","email":"kylecui@berkeley.edu"}],"homepage":"https://github.com/fishaudio/fish-audio-typescript#readme","bugs":{"url":"https://github.com/fishaudio/fish-audio-typescript/issues"},"dist":{"shasum":"631534cb862c2f4528acb0bd2635df2331703552","tarball":"https://registry.npmjs.org/fish-audio/-/fish-audio-0.0.2.tgz","fileCount":440,"integrity":"sha512-gYr+qf7msmZeQdVfxWoubuklOcAu6FAtSs/pKJFXOpTTYc38Vqg9kh7ng8Yz3+KYJ0HAVzIkgPKvF1tU/gUIhA==","signatures":[{"sig":"MEQCIGFWc5zqdadflS+vVemXW96EhMe5KNT9NtE+TXeYlHiMAiB6mseBeLpT1XAAlIArySlx0VhHs6YtKY6VOChAKV5cFQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":474663},"main":"./dist/cjs/index.js","type":"module","types":"./dist/esm/index.d.ts","module":"./dist/esm/index.js","exports":{".":{"import":"./dist/esm/index.js","require":"./dist/cjs/index.js"}},"gitHead":"4ac7cdb10975ec7cdc49604a572a14e5594c3342","scripts":{"test":"echo \"No tests yet\" && exit 0","build":"npm run clean && npm run build:cjs && npm run build:esm","clean":"rm -rf dist","build:cjs":"tsc --project tsconfig.json --module CommonJS --outDir dist/cjs --moduleResolution node","build:esm":"tsc --project tsconfig.json --outDir dist/esm --moduleResolution bundler"},"_npmUser":{"name":"kcui5","email":"kylecui@berkeley.edu"},"repository":{"url":"git+https://github.com/fishaudio/fish-audio-typescript.git","type":"git"},"_npmVersion":"10.9.0","description":"To provide convenient Node.js program integration for https://docs.fish.audio","directories":{},"_nodeVersion":"22.11.0","dependencies":{"ws":"^8.18.3","node-fetch":"^3.3.2","command-exists":"^1.2.9","@msgpack/msgpack":"^3.1.2"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.0","@types/ws":"^8.18.1","typescript":"^5.9.3","@types/node":"^24.9.1","@types/command-exists":"^1.2.3"},"_npmOperationalInternal":{"tmp":"tmp/fish-audio_0.0.2_1762314240711_0.948781623021584","host":"s3://npm-registry-packages-npm-production"}},"0.0.3":{"name":"fish-audio","version":"0.0.3","keywords":["tts"],"author":"","license":"MIT","_id":"fish-audio@0.0.3","maintainers":[{"name":"kcui5","email":"kylecui@berkeley.edu"}],"homepage":"https://github.com/fishaudio/fish-audio-typescript#readme","bugs":{"url":"https://github.com/fishaudio/fish-audio-typescript/issues"},"dist":{"shasum":"c734ec0e38362ef02b2a932ec1d4ed0662e31e5c","tarball":"https://registry.npmjs.org/fish-audio/-/fish-audio-0.0.3.tgz","fileCount":440,"integrity":"sha512-AdK99+Nk4GvC63gzNo4zQ696+A9wHuJijdOq8afeChG5mE+lRtFqp08c99DauQMDWSQwhzDxB1IhCZoM84Lk2w==","signatures":[{"sig":"MEQCIBVd4GEKAS3uwNc92KAHueo+tt2wRxDUAFi0jyKJxaMyAiAmOTKqU/QIkFbPIGWQjxCTILThwSAtuTuT6ct6IJtoxA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":474934},"main":"./dist/cjs/index.js","type":"module","types":"./dist/esm/index.d.ts","module":"./dist/esm/index.js","exports":{".":{"import":"./dist/esm/index.js","require":"./dist/cjs/index.js"}},"gitHead":"82c797f3ed0f74883b3ef98803e38b9734635580","scripts":{"test":"echo \"No tests yet\" && exit 0","build":"npm run clean && npm run build:cjs && npm run build:esm","clean":"rm -rf dist","build:cjs":"tsc --project tsconfig.json --module CommonJS --outDir dist/cjs --moduleResolution node","build:esm":"tsc --project tsconfig.json --outDir dist/esm --moduleResolution bundler"},"_npmUser":{"name":"kcui5","email":"kylecui@berkeley.edu"},"repository":{"url":"git+https://github.com/fishaudio/fish-audio-typescript.git","type":"git"},"_npmVersion":"10.9.0","description":"To provide convenient Node.js program integration for https://docs.fish.audio","directories":{},"_nodeVersion":"22.11.0","dependencies":{"ws":"^8.18.3","node-fetch":"^3.3.2","command-exists":"^1.2.9","@msgpack/msgpack":"^3.1.2"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.0","@types/ws":"^8.18.1","typescript":"^5.9.3","@types/node":"^24.9.1","@types/command-exists":"^1.2.3"},"_npmOperationalInternal":{"tmp":"tmp/fish-audio_0.0.3_1762380112297_0.3105954607060015","host":"s3://npm-registry-packages-npm-production"}},"0.0.4":{"name":"fish-audio","version":"0.0.4","keywords":["tts"],"author":"","license":"MIT","_id":"fish-audio@0.0.4","maintainers":[{"name":"kcui5","email":"kylecui@berkeley.edu"},{"name":"twango","email":"npm@twango.dev"}],"homepage":"https://github.com/fishaudio/fish-audio-typescript#readme","bugs":{"url":"https://github.com/fishaudio/fish-audio-typescript/issues"},"dist":{"shasum":"ba6bf662036ef6fd3e05a4f576c66fc94b9435c0","tarball":"https://registry.npmjs.org/fish-audio/-/fish-audio-0.0.4.tgz","fileCount":440,"integrity":"sha512-KPaUuGfm3Wra294jvZobQ8XNPY+7ynivrAAb/d2wvTK+3HdAdcuYXIpzH9LjP/yI/IKq70A0S4tCXbYcRo4Y9g==","signatures":[{"sig":"MEYCIQCYDHgzzJTWCfPF+0m9z2npjn+NeXKMVtGzHotI637gpwIhAPI7MsG8k6sO/HgIlnwksrzfXx0Pz6zG/6xCFuH/RTHX","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":474942},"main":"./dist/cjs/index.js","type":"module","types":"./dist/esm/index.d.ts","module":"./dist/esm/index.js","exports":{".":{"import":"./dist/esm/index.js","require":"./dist/cjs/index.js"}},"gitHead":"89866c74cd11c19731d807b0d81558d13d1b12cc","scripts":{"test":"echo \"No tests yet\" && exit 0","build":"npm run clean && npm run build:cjs && npm run build:esm","clean":"rm -rf dist","build:cjs":"tsc --project tsconfig.json --module CommonJS --outDir dist/cjs --moduleResolution node","build:esm":"tsc --project tsconfig.json --outDir dist/esm --moduleResolution bundler"},"_npmUser":{"name":"kcui5","email":"kylecui@berkeley.edu"},"repository":{"url":"git+https://github.com/fishaudio/fish-audio-typescript.git","type":"git"},"_npmVersion":"11.8.0","description":"To provide convenient Node.js program integration for https://docs.fish.audio","directories":{},"_nodeVersion":"24.13.1","dependencies":{"ws":"^8.18.3","node-fetch":"^3.3.2","command-exists":"^1.2.9","@msgpack/msgpack":"^3.1.2"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.0","@types/ws":"^8.18.1","typescript":"^5.9.3","@types/node":"^24.9.1","@types/command-exists":"^1.2.3"},"_npmOperationalInternal":{"tmp":"tmp/fish-audio_0.0.4_1773005108923_0.9323663460149951","host":"s3://npm-registry-packages-npm-production"}},"0.1.0":{"name":"fish-audio","version":"0.1.0","keywords":["tts"],"author":"","license":"MIT","_id":"fish-audio@0.1.0","maintainers":[{"name":"kcui5","email":"kylecui@berkeley.edu"},{"name":"twango","email":"npm@twango.dev"}],"homepage":"https://github.com/fishaudio/fish-audio-typescript#readme","bugs":{"url":"https://github.com/fishaudio/fish-audio-typescript/issues"},"dist":{"shasum":"60cc124226832e3dbfa9e9e461fe1b9a45bb76d6","tarball":"https://registry.npmjs.org/fish-audio/-/fish-audio-0.1.0.tgz","fileCount":440,"integrity":"sha512-4UtnHbkSP99fciiDeEjfoTrqVjDvvNVjSKRlDwWbI/EayLMpFYAU5wGbPRL47Ei8BNVoxuCyGzza27TqDyThrQ==","signatures":[{"sig":"MEQCIEDr/odn/hJ1JMdo3WSFzNVr1VIRFgkcpVlaWBePbmIhAiBo8TnulT1fpQ27YXh8NHwmMR87N7lX7I4yWllCGJofdA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":474950},"main":"./dist/cjs/index.js","type":"module","types":"./dist/esm/index.d.ts","module":"./dist/esm/index.js","exports":{".":{"import":"./dist/esm/index.js","require":"./dist/cjs/index.js"}},"gitHead":"f9c4e6a6cacfe72442ac7ea711649bae609d7974","scripts":{"test":"echo \"No tests yet\" && exit 0","build":"npm run clean && npm run build:cjs && npm run build:esm","clean":"rm -rf dist","build:cjs":"tsc --project tsconfig.json --module CommonJS --outDir dist/cjs --moduleResolution node","build:esm":"tsc --project tsconfig.json --outDir dist/esm --moduleResolution bundler"},"_npmUser":{"name":"kcui5","email":"kylecui@berkeley.edu"},"repository":{"url":"git+https://github.com/fishaudio/fish-audio-typescript.git","type":"git"},"_npmVersion":"11.8.0","description":"To provide convenient Node.js program integration for https://docs.fish.audio","directories":{},"_nodeVersion":"24.13.1","dependencies":{"ws":"^8.18.3","node-fetch":"^3.3.2","command-exists":"^1.2.9","@msgpack/msgpack":"^3.1.2"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.0","@types/ws":"^8.18.1","typescript":"^5.9.3","@types/node":"^24.9.1","@types/command-exists":"^1.2.3"},"_npmOperationalInternal":{"tmp":"tmp/fish-audio_0.1.0_1773126732035_0.09754529564338532","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2025-11-05T03:37:15.761Z","modified":"2026-07-16T09:32:37.753Z","0.0.1":"2025-11-05T03:37:15.948Z","0.0.2":"2025-11-05T03:44:00.897Z","0.0.3":"2025-11-05T22:01:52.524Z","0.0.4":"2026-03-08T21:25:09.082Z","0.1.0":"2026-03-10T07:12:12.185Z"},"bugs":{"url":"https://github.com/fishaudio/fish-audio-typescript/issues"},"license":"MIT","homepage":"https://github.com/fishaudio/fish-audio-typescript#readme","keywords":["tts"],"repository":{"url":"git+https://github.com/fishaudio/fish-audio-typescript.git","type":"git"},"description":"To provide convenient Node.js program integration for https://docs.fish.audio","maintainers":[{"email":"lengyue@lengyue.me","name":"leng-yue"}],"readme":"# Fish Audio Typescript SDK\n\nTo provide convenient Typescript program integration for [https://docs.fish.audio](https://docs.fish.audio)\n\n## Install\n\n```bash\nnpm install fish-audio\n```\n\n## Usage\n\nInitialize a `FishAudioClient` to use APIs. Authenticate by setting `FISH_API_KEY=\"your_api_key\"`\nin your environment or pass it in.\n\n```typescript\nimport { FishAudioClient } from \"fish-audio\";\n\nconst fishAudio = new FishAudioClient();\n```\n\nSometimes, you may need to change our endpoint to another address. You can use\n\n```typescript\nimport { FishAudioClient } from \"fish-audio\";\n\nconst fishAudio = new FishAudioClient({apiKey: \"your_api_key\", baseUrl: \"https://your-proxy-domain\"});\n```\n\n### Text to Speech\n\n```typescript\nimport { FishAudioClient, play } from \"fish-audio\";\n\nconst fishAudio = new FishAudioClient({ apiKey: \"your_api_key\" });\n\nconst request = { text: \"Hello, world!\" };\nconst audio = await fishAudio.textToSpeech.convert(request); //defaults to backend: \"s2-pro\"\n\nawait play(audio);\n```\n\n#### Reference Audio\n\n```typescript\nimport type { TTSRequest } from \"fish-audio\";\n\nconst request: TTSRequest = {\n    text: \"Hello, world!\",\n    reference_id: \"your_model_id\",\n};\n```\n\nOr just use `ReferenceAudio` in `TTSRequest`:\n\n```typescript\nconst audioBuffer = await readFile(new URL(\"/path/to/your/audio/file\",));\nconst referenceFile = new File([audioBuffer], \"audio_file_name\");\n\nconst referenceAudio: ReferenceAudio = {\n    audio: referenceFile,\n    text: \"reference audio text\"\n};\n\nconst request: TTSRequest = {\n    text: \"Hello, world!\",\n    references: [referenceAudio]\n};\n```\n\n#### WebSocket\n\nThe TTS websocket provides real-time streaming.\n\n```typescript\nimport { FishAudioClient, RealtimeEvents } from \"fish-audio\";\nimport { writeFile } from \"fs/promises\";\nimport path from \"path\";\n\n// Simple async generator that yields text chunks to speak\nasync function* makeTextStream() {\n    const chunks = [\n        \"Hello from Fish Audio! \",\n        \"This is a realtime text-to-speech test. \",\n        \"We are streaming multiple chunks over WebSocket.\",\n    ];\n    for (const chunk of chunks) {\n        yield chunk;\n        await new Promise((r) => setTimeout(r, 200));\n    }\n}\n\nconst client = new FishAudioClient();\n\n// For realtime, set text to \"\" and stream the content via textStream instead\nconst request = {\n    text: \"\",\n    reference_id: \"your_model_id\"\n};\n\n// Defaults to backend: \"s2-pro\"\nconst connection = await client.textToSpeech.convertRealtime(request, makeTextStream());\n\n// Collect audio and write to a file when the stream ends\nconst chunks: Buffer[] = [];\nconnection.on(RealtimeEvents.OPEN, () => console.log(\"WebSocket opened\"));\nconnection.on(RealtimeEvents.AUDIO_CHUNK, (audio: unknown): void => {\n    if (audio instanceof Uint8Array || Buffer.isBuffer(audio)) {\n        chunks.push(Buffer.from(audio));\n    }\n});\nconnection.on(RealtimeEvents.ERROR, (err) => console.error(\"WebSocket error:\", err));\nconnection.on(RealtimeEvents.CLOSE, async () => {\n    const outPath = path.resolve(process.cwd(), \"out.mp3\");\n    await writeFile(outPath, Buffer.concat(chunks));\n    console.log(\"Saved to\", outPath);\n});\n```\n\n### Speech to Text (ASR)\n\n```typescript\nimport { FishAudioClient } from \"fish-audio\";\nimport { createReadStream } from \"fs\";\n\nconst fishAudio = new FishAudioClient();\n\nconst audioFile = createReadStream(new URL(\"/path/to/your/audio/file\"));\n\ntry {\n    const result = await fishAudio.speechToText.convert({\n        audio: audioFile,\n    });\n\n    console.log(\"Transcription:\", result.text);\n    console.log(\"Duration (s):\", result.duration);\n    console.log(\"Segments:\", result.segments);\n} catch (err) {\n    console.error(\"STT request failed:\", err);\n}\n```\n\n### Voices\n\n#### Clone a Voice\n```typescript\nimport { FishAudioClient } from \"fish-audio\";\nimport { createReadStream } from \"fs\";\n\nconst fishAudio = new FishAudioClient();\n\nconst title = \"cloned-voice-name\";\nconst audioFile = createReadStream(new URL(\"/path/to/your/audio/file\"));\nconst coverImageFile = createReadStream(new URL(\"/path/to/your/cover/image/file\"));\n\ntry {\n    const response = await fishAudio.voices.ivc.create({\n        title: title,\n        voices: [audioFile],\n        cover_image: coverImageFile,\n    });\n\n    console.log(\"Voice created:\", {\n        id: response._id,\n        title: response.title,\n        state: response.state,\n    });\n} catch (err) {\n    console.error(\"Create voice request failed:\", err);\n}\n```\n\n#### List models\n\n```typescript\nfishAudio.voices.search()\n```\n\n#### Get a model info by id\n\n```typescript\nfishAudio.voices.get(\"your_model_id\")\n```\n\n#### Update a model\n\n```typescript\nfishAudio.voices.update(\"your_model_id\", { title: \"new_title\" })\n```\n\n#### Delete a model\n\n```typescript\nfishAudio.voices.delete(\"your_model_id\")\n```\n\n### User\n\n#### Get User API Credits\n\n```typescript\nfishAudio.user.get_api_credit()\n```\n\n#### Get User Package\n```typescript\nfishAudio.voices.get_package()\n```\n","readmeFilename":"README.md"}