@cartesia/cartesia-js 1.3.0 → 2.0.0

package/Client.d.ts

@@ -0,0 +1,40 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "./environments";
+import * as core from "./core";
+import { ApiStatus } from "./api/resources/apiStatus/client/Client";
+import { Tts } from "./api/resources/tts/client/Client";
+import { VoiceChanger } from "./api/resources/voiceChanger/client/Client";
+import { Voices } from "./api/resources/voices/client/Client";
+export declare namespace CartesiaClient {
+    interface Options {
+        environment?: core.Supplier<environments.CartesiaEnvironment | string>;
+        apiKey?: core.Supplier<string | undefined>;
+        /** Override the Cartesia-Version header */
+        cartesiaVersion?: "2024-06-10";
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Override the Cartesia-Version header */
+        cartesiaVersion?: "2024-06-10";
+    }
+}
+export declare class CartesiaClient {
+    protected readonly _options: CartesiaClient.Options;
+    constructor(_options?: CartesiaClient.Options);
+    protected _apiStatus: ApiStatus | undefined;
+    get apiStatus(): ApiStatus;
+    protected _tts: Tts | undefined;
+    get tts(): Tts;
+    protected _voiceChanger: VoiceChanger | undefined;
+    get voiceChanger(): VoiceChanger;
+    protected _voices: Voices | undefined;
+    get voices(): Voices;
+}

package/Client.js

@@ -0,0 +1,32 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CartesiaClient = void 0;
+const Client_1 = require("./api/resources/apiStatus/client/Client");
+const Client_2 = require("./api/resources/tts/client/Client");
+const Client_3 = require("./api/resources/voiceChanger/client/Client");
+const Client_4 = require("./api/resources/voices/client/Client");
+class CartesiaClient {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    get apiStatus() {
+        var _a;
+        return ((_a = this._apiStatus) !== null && _a !== void 0 ? _a : (this._apiStatus = new Client_1.ApiStatus(this._options)));
+    }
+    get tts() {
+        var _a;
+        return ((_a = this._tts) !== null && _a !== void 0 ? _a : (this._tts = new Client_2.Tts(this._options)));
+    }
+    get voiceChanger() {
+        var _a;
+        return ((_a = this._voiceChanger) !== null && _a !== void 0 ? _a : (this._voiceChanger = new Client_3.VoiceChanger(this._options)));
+    }
+    get voices() {
+        var _a;
+        return ((_a = this._voices) !== null && _a !== void 0 ? _a : (this._voices = new Client_4.Voices(this._options)));
+    }
+}
+exports.CartesiaClient = CartesiaClient;

package/README.md

@@ -1,131 +1,93 @@
-# Cartesia JavaScript Client
+# Cartesia TypeScript Library
 
-![NPM Version](https://img.shields.io/npm/v/%40cartesia%2Fcartesia-js?logo=npm)
-[![Discord](https://badgen.net/badge/black/Cartesia/icon?icon=discord&label)](https://discord.gg/cartesia)
-
-This client provides convenient access to [Cartesia's TTS models](https://cartesia.ai/). Sonic is the fastest text-to-speech model around—it can generate a second of audio in just 650ms, and it can stream out the first audio chunk in just 135ms. Alongside Sonic, we also offer an extensive prebuilt voice library for a variety of use cases.
-
-The JavaScript client is a thin wrapper around the Cartesia API. You can view docs for the API at [docs.cartesia.ai](https://docs.cartesia.ai/).
-
-- [Cartesia JavaScript Client](#cartesia-javascript-client)
-	- [Installation](#installation)
-	- [Usage](#usage)
-		- [CRUD on Voices](#crud-on-voices)
-		- [TTS over WebSocket](#tts-over-websocket)
-			- [Input Streaming with Contexts](#input-streaming-with-contexts)
-			- [Timestamps](#timestamps)
-			- [Speed and emotion controls \[Alpha\]](#speed-and-emotion-controls-alpha)
-		- [Multilingual TTS \[Alpha\]](#multilingual-tts-alpha)
-		- [Playing audio in the browser](#playing-audio-in-the-browser)
-	- [React](#react)
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fcartesia-ai%2Fcartesia-js)
+[![npm shield](https://img.shields.io/npm/v/@cartesia/cartesia-js)](https://www.npmjs.com/package/@cartesia/cartesia-js)
 
+The Cartesia TypeScript library provides convenient access to the Cartesia API from TypeScript.
 
 ## Installation
 
-```bash
-# NPM
-npm install @cartesia/cartesia-js
-# Yarn
-yarn add @cartesia/cartesia-js
-# PNPM
-pnpm add @cartesia/cartesia-js
-# Bun
-bun add @cartesia/cartesia-js
+```sh
+npm i -s @cartesia/cartesia-js
 ```
 
-## Usage
-
-### CRUD on Voices
-
-```js
-import Cartesia from "@cartesia/cartesia-js";
-
-const cartesia = new Cartesia({
-	apiKey: "your-api-key",
-});
-
-// List all voices.
-const voices = await cartesia.voices.list();
-console.log(voices);
+## Reference
 
-// Get a voice.
-const voice = await cartesia.voices.get("<voice-id>");
-console.log(voice);
+A full reference for this library is available [here](./reference.md).
 
-// Clone a voice from a file.
-const clonedVoiceEmbedding = await cartesia.voices.clone({
-	mode: "clip",
-	clip: myFile, // Pass a File object or a Blob.
-});
-
-// Mix voices together.
-const mixedVoiceEmbedding = await cartesia.voices.mix({
-	voices: [{ id: "<voice-id-1>", weight: 0.6 }, { id: "<voice-id-2>", weight: 0.4 }],
-});
-
-// Localize a voice.
-const localizedVoiceEmbedding = await cartesia.voices.localize({
-	embedding: Array(192).fill(1.0),
-	original_speaker_gender: "female",
-	language: "es",
-});
+## Usage
 
-// Create a voice.
-const newVoice = await cartesia.voices.create({
-	name: "Tim",
-	description: "A deep, resonant voice.",
-	embedding: Array(192).fill(1.0),
+### Instantiation
+
+Instantiate and use the client with the following:
+
+```typescript
+import { CartesiaClient } from "@cartesia/cartesia-js";
+
+const client = new CartesiaClient({ apiKey: "YOUR_API_KEY_HEADER" });
+await client.tts.bytes({
+    modelId: "sonic-english",
+    transcript: "Hello, world!",
+    voice: {
+        mode: "id",
+        id: "694f9389-aac1-45b6-b726-9d9369183238",
+    },
+    language: "en",
+    outputFormat: {
+        container: "raw",
+        sampleRate: 44100,
+        encoding: "pcm_f32le",
+    },
 });
-console.log(newVoice);
 ```
 
 ### TTS over WebSocket
 
 ```js
-import Cartesia from "@cartesia/cartesia-js";
+import { CartesiaClient } from "@cartesia/cartesia-js";
 
-const cartesia = new Cartesia({
-	apiKey: "your-api-key",
+const cartesia = new CartesiaClient({
+    apiKey: "your-api-key",
 });
 
 // Initialize the WebSocket. Make sure the output format you specify is supported.
 const websocket = cartesia.tts.websocket({
-	container: "raw",
-	encoding: "pcm_f32le",
-	sampleRate: 44100,
+    container: "raw",
+    encoding: "pcm_f32le",
+    sampleRate: 44100,
 });
 
 try {
-	await websocket.connect({
-		// If using Node.js, you can pass a custom WebSocket constructor, such as from `ws`.
-		// This is not needed for browser usage, so you can call connect() without any arguments.
-		WebSocket: WS,
-	});
+    await websocket.connect({
+        // If using Node.js, you can pass a custom WebSocket constructor, such as from `ws`.
+        // This is not needed for browser usage, so you can call connect() without any arguments.
+        WebSocket: WS,
+    });
 } catch (error) {
-	console.error(`Failed to connect to Cartesia: ${error}`);
+    console.error(`Failed to connect to Cartesia: ${error}`);
 }
 
 // Create a stream.
 const response = await websocket.send({
-	model_id: "sonic-english",
-	voice: {
-		mode: "id",
-		id: "a0e99841-438c-4a64-b679-ae501e7d6091",
-	},
-	transcript: "Hello, world!"
-	// The WebSocket sets output_format on your behalf.
+    modelId: "sonic-english",
+    voice: {
+        mode: "id",
+        id: "a0e99841-438c-4a64-b679-ae501e7d6091",
+    },
+    transcript: "Hello, world!",
+    // The WebSocket sets output_format on your behalf.
 });
 
 // Access the raw messages from the WebSocket.
 response.on("message", (message) => {
-	// Raw message.
-	console.log("Received message:", message);
+    // Raw message.
+    console.log("Received message:", message);
 });
 
 // You can also access messages using a for-await-of loop.
-for await (const message of response.events('message')) {
-	// Raw message.
-	console.log("Received message:", message);
+for await (const message of response.events("message")) {
+    // Raw message.
+    console.log("Received message:", message);
 }
 ```
 
@@ -133,147 +95,158 @@ for await (const message of response.events('message')) {
 
 ```js
 const contextOptions = {
-	context_id: "my-context",
-	model_id: "sonic-english",
-	voice: {
-		mode: "id",
-		id: "a0e99841-438c-4a64-b679-ae501e7d6091",
-	},
-}
+    contextId: "my-context",
+    modelId: "sonic-english",
+    voice: {
+        mode: "id",
+        id: "a0e99841-438c-4a64-b679-ae501e7d6091",
+    },
+};
 
 // Initial request on the context uses websocket.send().
 // This response object will aggregate the results of all the inputs sent on the context.
 const response = await websocket.send({
-	...contextOptions,
-	transcript: "Hello, world!",
+    ...contextOptions,
+    transcript: "Hello, world!",
 });
 
 // Subsequent requests on the same context use websocket.continue().
 await websocket.continue({
-	...contextOptions,
-	transcript: " How are you today?",
+    ...contextOptions,
+    transcript: " How are you today?",
 });
 ```
 
 See the [input streaming docs](https://docs.cartesia.ai/reference/web-socket/stream-speech/working-with-web-sockets#input-streaming-with-contexts) for more information.
 
-#### Timestamps
+### Playing audio in the browser
 
-To receive timestamps in responses, set the `add_timestamps` field in the request object to `true`.
+(The `WebPlayer` class only supports playing audio in the browser and the raw PCM format with fp32le encoding.)
 
 ```js
-const response = await websocket.send({
-	model_id: "sonic-english",
-	voice: {
-		mode: "id",
-		id: "a0e99841-438c-4a64-b679-ae501e7d6091",
-	},
-	transcript: "Hello, world!",
-	add_timestamps: true,
-});
+// If you're using the client in the browser, you can control audio playback using our WebPlayer:
+import { WebPlayer } from "@cartesia/cartesia-js";
+
+console.log("Playing stream...");
+
+// Create a Player object.
+const player = new WebPlayer();
+
+// Play the audio. (`response` includes a custom Source object that the Player can play.)
+// The call resolves when the audio finishes playing.
+await player.play(response.source);
+
+console.log("Done playing.");
 ```
 
-You can then listen for timestamps on the returned response object.
+## Request And Response Types
 
-```js
-response.on("timestamps", (timestamps) => {
-	console.log("Received timestamps for words:", timestamps.words);
-	console.log("Words start at:", timestamps.start);
-	console.log("Words end at:", timestamps.end);
-});
+The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
+following namespace:
+
+```typescript
+import { Cartesia } from "@cartesia/cartesia-js";
 
-// You can also access timestamps using a for-await-of loop.
-for (await const timestamps of response.events('timestamps')) {
-	console.log("Received timestamps for words:", timestamps.words);
-	console.log("Words start at:", timestamps.start);
-	console.log("Words end at:", timestamps.end);
+const request: Cartesia.VoiceChangerBytesRequest = {
+    ...
+};
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```typescript
+import { CartesiaError } from "@cartesia/cartesia-js";
+
+try {
+    await client.tts.bytes(...);
+} catch (err) {
+    if (err instanceof CartesiaError) {
+        console.log(err.statusCode);
+        console.log(err.message);
+        console.log(err.body);
+    }
 }
 ```
 
-#### Speed and emotion controls [Alpha]
+## Advanced
 
-The API has experimental support for speed and emotion controls that is not subject to semantic versioning and is subject to change without notice. You can control the speed and emotion of the synthesized speech by setting the `speed` and `emotion` fields under `voice.__experimental_controls` in the request object.
+### Retries
 
-```js
-const response = await websocket.send({
-	model_id: "sonic-english",
-	voice: {
-		mode: "id",
-		id: "a0e99841-438c-4a64-b679-ae501e7d6091",
-		__experimental_controls: {
-			speed: "fastest",
-			emotion: ["sadness", "surprise:high"],
-		},
-	},
-	transcript: "Hello, world!",
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+-   [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+-   [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+-   [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `maxRetries` request option to configure this behavior.
+
+```typescript
+const response = await client.tts.bytes(..., {
+    maxRetries: 0 // override maxRetries at the request level
 });
 ```
 
-### Multilingual TTS [Alpha]
+### Timeouts
 
-You can define the language of the text you want to synthesize by setting the `language` field in the request object. Make sure that you are using `model_id: "sonic-multilingual"` in the request object.
+The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to configure this behavior.
 
-Supported languages are listed at [docs.cartesia.ai](https://docs.cartesia.ai/getting-started/available-models).
+```typescript
+const response = await client.tts.bytes(..., {
+    timeoutInSeconds: 30 // override timeout to 30s
+});
+```
 
-### Playing audio in the browser
+### Aborting Requests
 
-(The `WebPlayer` class only supports playing audio in the browser and the raw PCM format with fp32le encoding.)
+The SDK allows users to abort requests at any point by passing in an abort signal.
 
-```js
-// If you're using the client in the browser, you can control audio playback using our WebPlayer:
-import { WebPlayer } from "@cartesia/cartesia-js";
+```typescript
+const controller = new AbortController();
+const response = await client.tts.bytes(..., {
+    abortSignal: controller.signal
+});
+controller.abort(); // aborts the request
+```
 
-console.log("Playing stream...");
+### Runtime Compatibility
 
-// Create a Player object.
-const player = new WebPlayer();
+The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK works in the following
+runtimes:
 
-// Play the audio. (`response` includes a custom Source object that the Player can play.)
-// The call resolves when the audio finishes playing.
-await player.play(response.source);
+-   Node.js 18+
+-   Vercel
+-   Cloudflare Workers
+-   Deno v1.25+
+-   Bun 1.0+
+-   React Native
 
-console.log("Done playing.");
-```
+### Customizing Fetch Client
 
-## React
-
-We export a React hook that simplifies the process of using the TTS API. The hook manages the WebSocket connection and provides a simple interface for buffering, playing, pausing and restarting audio.
-
-```jsx
-import { useTTS } from '@cartesia/cartesia-js/react';
-
-function TextToSpeech() {
-	const tts = useTTS({
-		apiKey: "your-api-key",
-		sampleRate: 44100,
-	})
-
-	const [text, setText] = useState("");
-
-	const handlePlay = async () => {
-		// Begin buffering the audio.
-		const response = await tts.buffer({
-			model_id: "sonic-english",
-			voice: {
-        		mode: "id",
-        		id: "a0e99841-438c-4a64-b679-ae501e7d6091",
-        	},
-			transcript: text,
-		});
-
-		// Immediately play the audio. (You can also buffer in advance and play later.)
-		await tts.play();
-	}
-
-	return (
-		<div>
-			<input type="text" value={text} onChange={(event) => setText(event.target.value)} />
-			<button onClick={handlePlay}>Play</button>
-
-			<div>
-				{tts.playbackStatus} | {tts.bufferStatus} | {tts.isWaiting}
-			</div>
-		</div>
-	);
-}
+The SDK provides a way for your to customize the underlying HTTP client / Fetch function. If you're running in an
+unsupported environment, this provides a way for you to break glass and ensure the SDK works.
+
+```typescript
+import { CartesiaClient } from "@cartesia/cartesia-js";
+
+const client = new CartesiaClient({
+    ...
+    fetcher: // provide your implementation here
+});
 ```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

package/api/index.d.ts

@@ -0,0 +1 @@
+export * from "./resources";

package/api/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./resources"), exports);

package/api/resources/apiStatus/client/Client.d.ts

@@ -0,0 +1,39 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Cartesia from "../../../index";
+export declare namespace ApiStatus {
+    interface Options {
+        environment?: core.Supplier<environments.CartesiaEnvironment | string>;
+        apiKey?: core.Supplier<string | undefined>;
+        /** Override the Cartesia-Version header */
+        cartesiaVersion?: "2024-06-10";
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Override the Cartesia-Version header */
+        cartesiaVersion?: "2024-06-10";
+    }
+}
+export declare class ApiStatus {
+    protected readonly _options: ApiStatus.Options;
+    constructor(_options?: ApiStatus.Options);
+    /**
+     * @param {ApiStatus.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.apiStatus.get()
+     */
+    get(requestOptions?: ApiStatus.RequestOptions): Promise<Cartesia.ApiInfo>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "X-API-Key": string | undefined;
+    }>;
+}