{"id":46509012,"url":"https://github.com/fishaudio/fish-audio-typescript","last_synced_at":"2026-03-08T23:10:18.062Z","repository":{"id":322552139,"uuid":"1089408800","full_name":"fishaudio/fish-audio-typescript","owner":"fishaudio","description":null,"archived":false,"fork":false,"pushed_at":"2025-11-27T01:50:56.000Z","size":12289,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-06T17:43:52.640Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fishaudio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-04T09:56:21.000Z","updated_at":"2026-02-10T09:49:56.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/fishaudio/fish-audio-typescript","commit_stats":null,"previous_names":["fishaudio/fish-audio-typescript"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/fishaudio/fish-audio-typescript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishaudio%2Ffish-audio-typescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishaudio%2Ffish-audio-typescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishaudio%2Ffish-audio-typescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishaudio%2Ffish-audio-typescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fishaudio","download_url":"https://codeload.github.com/fishaudio/fish-audio-typescript/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fishaudio%2Ffish-audio-typescript/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30274112,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-08T20:45:49.896Z","status":"ssl_error","status_checked_at":"2026-03-08T20:45:49.525Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-03-06T15:32:18.438Z","updated_at":"2026-03-08T23:10:18.056Z","avatar_url":"https://github.com/fishaudio.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"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: \"s1\"\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) =\u003e 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: \"s1\"\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, () =\u003e console.log(\"WebSocket opened\"));\nconnection.on(RealtimeEvents.AUDIO_CHUNK, (audio: unknown): void =\u003e {\n    if (audio instanceof Uint8Array || Buffer.isBuffer(audio)) {\n        chunks.push(Buffer.from(audio));\n    }\n});\nconnection.on(RealtimeEvents.ERROR, (err) =\u003e console.error(\"WebSocket error:\", err));\nconnection.on(RealtimeEvents.CLOSE, async () =\u003e {\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffishaudio%2Ffish-audio-typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffishaudio%2Ffish-audio-typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffishaudio%2Ffish-audio-typescript/lists"}