@cartesia/cartesia-js 2.2.4 → 2.2.7

package/api/resources/voiceChanger/client/requests/VoiceChangerBytesRequest.d.ts

@@ -30,15 +30,10 @@ import * as Cartesia from "../../../../index";
 export interface VoiceChangerBytesRequest {
     voiceId: string;
     outputFormatContainer: Cartesia.OutputFormatContainer;
+    /** The sample rate of the output audio in Hz. Supported sample rates are 8000, 16000, 22050, 24000, 44100, 48000. */
     outputFormatSampleRate: number;
-    /**
-     * Required for `raw` and `wav` containers.
-     *
-     */
+    /** Required for `raw` and `wav` containers. */
     outputFormatEncoding?: Cartesia.RawEncoding;
-    /**
-     * Required for `mp3` containers.
-     *
-     */
+    /** Required for `mp3` containers. */
     outputFormatBitRate?: number;
 }

package/api/resources/voiceChanger/client/requests/VoiceChangerSseRequest.d.ts

@@ -30,15 +30,10 @@ import * as Cartesia from "../../../../index";
 export interface VoiceChangerSseRequest {
     voiceId: string;
     outputFormatContainer: Cartesia.OutputFormatContainer;
+    /** The sample rate of the audio in Hz. Supported sample rates are 8000, 16000, 22050, 24000, 44100, 48000. */
     outputFormatSampleRate: number;
-    /**
-     * Required for `raw` and `wav` containers.
-     *
-     */
+    /** Required for `raw` and `wav` containers. */
     outputFormatEncoding?: Cartesia.RawEncoding;
-    /**
-     * Required for `mp3` containers.
-     *
-     */
+    /** Required for `mp3` containers. */
     outputFormatBitRate?: number;
 }

package/api/resources/voices/client/Client.js

@@ -70,7 +70,7 @@ class Voices {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CartesiaEnvironment.Production, "/voices/"),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.4", "User-Agent": "@cartesia/cartesia-js/2.2.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.7", "User-Agent": "@cartesia/cartesia-js/2.2.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -155,7 +155,7 @@ class Voices {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CartesiaEnvironment.Production, "/voices/clone"),
                 method: "POST",
-                headers: Object.assign(Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.4", "User-Agent": "@cartesia/cartesia-js/2.2.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.7", "User-Agent": "@cartesia/cartesia-js/2.2.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 requestType: "file",
                 duplex: _maybeEncodedRequest.duplex,
                 body: _maybeEncodedRequest.body,
@@ -206,7 +206,7 @@ class Voices {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CartesiaEnvironment.Production, `/voices/${encodeURIComponent(serializers.VoiceId.jsonOrThrow(id))}`),
                 method: "DELETE",
-                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.4", "User-Agent": "@cartesia/cartesia-js/2.2.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.7", "User-Agent": "@cartesia/cartesia-js/2.2.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -254,7 +254,7 @@ class Voices {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CartesiaEnvironment.Production, `/voices/${encodeURIComponent(serializers.VoiceId.jsonOrThrow(id))}`),
                 method: "PATCH",
-                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.4", "User-Agent": "@cartesia/cartesia-js/2.2.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.7", "User-Agent": "@cartesia/cartesia-js/2.2.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.UpdateVoiceRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -305,7 +305,7 @@ class Voices {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CartesiaEnvironment.Production, `/voices/${encodeURIComponent(serializers.VoiceId.jsonOrThrow(id))}`),
                 method: "GET",
-                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.4", "User-Agent": "@cartesia/cartesia-js/2.2.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.7", "User-Agent": "@cartesia/cartesia-js/2.2.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -364,7 +364,7 @@ class Voices {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CartesiaEnvironment.Production, "/voices/localize"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.4", "User-Agent": "@cartesia/cartesia-js/2.2.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.7", "User-Agent": "@cartesia/cartesia-js/2.2.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.LocalizeVoiceRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -423,7 +423,7 @@ class Voices {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CartesiaEnvironment.Production, "/voices/mix"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.4", "User-Agent": "@cartesia/cartesia-js/2.2.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.7", "User-Agent": "@cartesia/cartesia-js/2.2.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.MixVoicesRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
@@ -482,7 +482,7 @@ class Voices {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CartesiaEnvironment.Production, "/voices/"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.4", "User-Agent": "@cartesia/cartesia-js/2.2.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.7", "User-Agent": "@cartesia/cartesia-js/2.2.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.CreateVoiceRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),

package/api/resources/voices/client/requests/CloneVoiceRequest.d.ts

@@ -20,34 +20,16 @@ import * as Cartesia from "../../../../index";
  *     }
  */
 export interface CloneVoiceRequest {
-    /**
-     * The name of the voice.
-     *
-     */
+    /** The name of the voice. */
     name: string;
-    /**
-     * A description for the voice.
-     *
-     */
+    /** A description for the voice. */
     description?: string;
-    /**
-     * The language of the voice.
-     *
-     */
+    /** The language of the voice. */
     language: Cartesia.SupportedLanguage;
-    /**
-     * Tradeoff between similarity and stability. Similarity clones sound more like the source clip, but may reproduce background noise. Stability clones always sound like a studio recording, but may not sound as similar to the source clip.
-     *
-     */
+    /** Tradeoff between similarity and stability. Similarity clones sound more like the source clip, but may reproduce background noise. Stability clones always sound like a studio recording, but may not sound as similar to the source clip. */
     mode: Cartesia.CloneMode;
-    /**
-     * Whether to apply AI enhancements to the clip to reduce background noise. This leads to cleaner generated speech at the cost of reduced similarity to the source clip.
-     *
-     */
+    /** Whether to apply AI enhancements to the clip to reduce background noise. This leads to cleaner generated speech at the cost of reduced similarity to the source clip. */
     enhance?: boolean;
-    /**
-     * Optional base voice ID that the cloned voice is derived from.
-     *
-     */
+    /** Optional base voice ID that the cloned voice is derived from. */
     baseVoiceId?: Cartesia.VoiceId;
 }

package/api/resources/voices/types/LocalizeDialect.d.ts

@@ -7,18 +7,14 @@ import * as Cartesia from "../../../index";
  */
 export type LocalizeDialect = 
 /**
- * Only available when language is set to English (`en`). Options: Australian (`au`), Indian (`in`), Southern (`so`), British (`uk`), or American (`us`).
- *  */
+ * Only available when language is set to English (`en`). Options: Australian (`au`), Indian (`in`), Southern (`so`), British (`uk`), or American (`us`). */
 Cartesia.LocalizeEnglishDialect
 /**
- * Only available when language is set to Spanish (`es`). Options: Latin American (`mx`) and Peninsular (`pe`).
- *  */
+ * Only available when language is set to Spanish (`es`). Options: Latin American (`mx`) and Peninsular (`pe`). */
  | Cartesia.LocalizeSpanishDialect
 /**
- * Only available when language is set to Portuguese (`pt`). Options: Brazilian (`br`) and European Portuguese (`eu`).
- *  */
+ * Only available when language is set to Portuguese (`pt`). Options: Brazilian (`br`) and European Portuguese (`eu`). */
  | Cartesia.LocalizePortugueseDialect
 /**
- * Only available when language is set to French (`fr`). Options: Standard Parisian/Metropolitan (`eu`) and Canadian (`ca`).
- *  */
+ * Only available when language is set to French (`fr`). Options: Standard Parisian/Metropolitan (`eu`) and Canadian (`ca`). */
  | Cartesia.LocalizeFrenchDialect;

package/core/fetcher/Fetcher.d.ts

@@ -6,14 +6,14 @@ export declare namespace Fetcher {
         method: string;
         contentType?: string;
         headers?: Record<string, string | undefined>;
-        queryParameters?: Record<string, string | string[] | object | object[]>;
+        queryParameters?: Record<string, string | string[] | object | object[] | null>;
         body?: unknown;
         timeoutMs?: number;
         maxRetries?: number;
         withCredentials?: boolean;
         abortSignal?: AbortSignal;
         requestType?: "json" | "file" | "bytes";
-        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arraybuffer";
+        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer";
         duplex?: "half";
     }
     type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;

package/core/fetcher/Fetcher.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetcher = void 0;
 exports.fetcherImpl = fetcherImpl;
+const json_1 = require("../json");
 const createRequestUrl_1 = require("./createRequestUrl");
 const getFetchFn_1 = require("./getFetchFn");
 const getRequestBody_1 = require("./getRequestBody");
@@ -31,7 +32,7 @@ function fetcherImpl(args) {
             }
         }
         const url = (0, createRequestUrl_1.createRequestUrl)(args.url, args.queryParameters);
-        let requestBody = yield (0, getRequestBody_1.getRequestBody)({
+        const requestBody = yield (0, getRequestBody_1.getRequestBody)({
             body: args.body,
             type: args.requestType === "json" ? "json" : "other",
         });
@@ -40,7 +41,7 @@ function fetcherImpl(args) {
             const response = yield (0, requestWithRetries_1.requestWithRetries)(() => __awaiter(this, void 0, void 0, function* () {
                 return (0, makeRequest_1.makeRequest)(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex);
             }), args.maxRetries);
-            let responseBody = yield (0, getResponseBody_1.getResponseBody)(response, args.responseType);
+            const responseBody = yield (0, getResponseBody_1.getResponseBody)(response, args.responseType);
             if (response.status >= 200 && response.status < 400) {
                 return {
                     ok: true,
@@ -90,7 +91,7 @@ function fetcherImpl(args) {
                 ok: false,
                 error: {
                     reason: "unknown",
-                    errorMessage: JSON.stringify(error),
+                    errorMessage: (0, json_1.toJson)(error),
                 },
             };
         }

package/core/fetcher/getResponseBody.js

@@ -16,15 +16,15 @@ function getResponseBody(response, responseType) {
         if (response.body != null && responseType === "blob") {
             return yield response.blob();
         }
+        else if (response.body != null && responseType === "arrayBuffer") {
+            return yield response.arrayBuffer();
+        }
         else if (response.body != null && responseType === "sse") {
             return response.body;
         }
         else if (response.body != null && responseType === "streaming") {
             return (0, chooseStreamWrapper_1.chooseStreamWrapper)(response.body);
         }
-        else if (response.body != null && responseType === "arraybuffer") {
-            return yield response.arrayBuffer();
-        }
         else if (response.body != null && responseType === "text") {
             return yield response.text();
         }

package/dist/Client.d.ts

@@ -6,6 +6,7 @@ import * as core from "./core";
 import { ApiStatus } from "./api/resources/apiStatus/client/Client";
 import { Auth } from "./api/resources/auth/client/Client";
 import { Infill } from "./api/resources/infill/client/Client";
+import { Stt } from "./api/resources/stt/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";
@@ -37,6 +38,7 @@ export declare class CartesiaClient {
     protected _apiStatus: ApiStatus | undefined;
     protected _auth: Auth | undefined;
     protected _infill: Infill | undefined;
+    protected _stt: Stt | undefined;
     protected _tts: Tts | undefined;
     protected _voiceChanger: VoiceChanger | undefined;
     protected _voices: Voices | undefined;
@@ -44,6 +46,7 @@ export declare class CartesiaClient {
     get apiStatus(): ApiStatus;
     get auth(): Auth;
     get infill(): Infill;
+    get stt(): Stt;
     get tts(): Tts;
     get voiceChanger(): VoiceChanger;
     get voices(): Voices;

package/dist/Client.js

@@ -7,9 +7,10 @@ exports.CartesiaClient = void 0;
 const Client_1 = require("./api/resources/apiStatus/client/Client");
 const Client_2 = require("./api/resources/auth/client/Client");
 const Client_3 = require("./api/resources/infill/client/Client");
-const Client_4 = require("./api/resources/tts/client/Client");
-const Client_5 = require("./api/resources/voiceChanger/client/Client");
-const Client_6 = require("./api/resources/voices/client/Client");
+const Client_4 = require("./api/resources/stt/client/Client");
+const Client_5 = require("./api/resources/tts/client/Client");
+const Client_6 = require("./api/resources/voiceChanger/client/Client");
+const Client_7 = require("./api/resources/voices/client/Client");
 class CartesiaClient {
     constructor(_options = {}) {
         this._options = _options;
@@ -26,17 +27,21 @@ class CartesiaClient {
         var _a;
         return ((_a = this._infill) !== null && _a !== void 0 ? _a : (this._infill = new Client_3.Infill(this._options)));
     }
+    get stt() {
+        var _a;
+        return ((_a = this._stt) !== null && _a !== void 0 ? _a : (this._stt = new Client_4.Stt(this._options)));
+    }
     get tts() {
         var _a;
-        return ((_a = this._tts) !== null && _a !== void 0 ? _a : (this._tts = new Client_4.Tts(this._options)));
+        return ((_a = this._tts) !== null && _a !== void 0 ? _a : (this._tts = new Client_5.Tts(this._options)));
     }
     get voiceChanger() {
         var _a;
-        return ((_a = this._voiceChanger) !== null && _a !== void 0 ? _a : (this._voiceChanger = new Client_5.VoiceChanger(this._options)));
+        return ((_a = this._voiceChanger) !== null && _a !== void 0 ? _a : (this._voiceChanger = new Client_6.VoiceChanger(this._options)));
     }
     get voices() {
         var _a;
-        return ((_a = this._voices) !== null && _a !== void 0 ? _a : (this._voices = new Client_6.Voices(this._options)));
+        return ((_a = this._voices) !== null && _a !== void 0 ? _a : (this._voices = new Client_7.Voices(this._options)));
     }
 }
 exports.CartesiaClient = CartesiaClient;

package/dist/api/resources/apiStatus/client/Client.js

@@ -66,7 +66,7 @@ class ApiStatus {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CartesiaEnvironment.Production,
                 method: "GET",
-                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.4", "User-Agent": "@cartesia/cartesia-js/2.2.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.7", "User-Agent": "@cartesia/cartesia-js/2.2.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/dist/api/resources/auth/client/Client.d.ts

@@ -39,10 +39,27 @@ export declare class Auth {
      * @example
      *     await client.auth.accessToken({
      *         grants: {
+     *             tts: true,
+     *             stt: true
+     *         },
+     *         expiresIn: 60
+     *     })
+     *
+     * @example
+     *     await client.auth.accessToken({
+     *         grants: {
      *             tts: true
      *         },
      *         expiresIn: 60
      *     })
+     *
+     * @example
+     *     await client.auth.accessToken({
+     *         grants: {
+     *             stt: true
+     *         },
+     *         expiresIn: 60
+     *     })
      */
     accessToken(request: Cartesia.TokenRequest, requestOptions?: Auth.RequestOptions): Promise<Cartesia.TokenResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{

package/dist/api/resources/auth/client/Client.js

@@ -67,10 +67,27 @@ class Auth {
      * @example
      *     await client.auth.accessToken({
      *         grants: {
+     *             tts: true,
+     *             stt: true
+     *         },
+     *         expiresIn: 60
+     *     })
+     *
+     * @example
+     *     await client.auth.accessToken({
+     *         grants: {
      *             tts: true
      *         },
      *         expiresIn: 60
      *     })
+     *
+     * @example
+     *     await client.auth.accessToken({
+     *         grants: {
+     *             stt: true
+     *         },
+     *         expiresIn: 60
+     *     })
      */
     accessToken(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -78,7 +95,7 @@ class Auth {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CartesiaEnvironment.Production, "access-token"),
                 method: "POST",
-                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.4", "User-Agent": "@cartesia/cartesia-js/2.2.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.7", "User-Agent": "@cartesia/cartesia-js/2.2.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.TokenRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),

package/dist/api/resources/auth/types/TokenGrant.d.ts

@@ -3,5 +3,7 @@
  */
 export interface TokenGrant {
     /** The `tts` grant allows the token to be used to access any TTS endpoint. */
-    tts: boolean;
+    tts?: boolean;
+    /** The `stt` grant allows the token to be used to access any STT endpoint. */
+    stt?: boolean;
 }

package/dist/api/resources/auth/types/TokenRequest.d.ts

@@ -3,8 +3,8 @@
  */
 import * as Cartesia from "../../../index";
 export interface TokenRequest {
-    /** The permissions to be granted via the token. */
-    grants: Cartesia.TokenGrant;
+    /** The permissions to be granted via the token. Both TTS and STT grants are optional - specify only the capabilities you need. */
+    grants?: Cartesia.TokenGrant;
     /** The number of seconds the token will be valid for since the time of generation. The maximum is 1 hour (3600 seconds). */
     expiresIn?: number;
 }

package/dist/api/resources/index.d.ts

@@ -14,5 +14,6 @@ export * as voices from "./voices";
 export * from "./voices/types";
 export * as infill from "./infill";
 export * from "./infill/client/requests";
+export * from "./stt/client/requests";
 export * from "./voiceChanger/client/requests";
 export * from "./voices/client/requests";

package/dist/api/resources/index.js

@@ -53,5 +53,6 @@ exports.voices = __importStar(require("./voices"));
 __exportStar(require("./voices/types"), exports);
 exports.infill = __importStar(require("./infill"));
 __exportStar(require("./infill/client/requests"), exports);
+__exportStar(require("./stt/client/requests"), exports);
 __exportStar(require("./voiceChanger/client/requests"), exports);
 __exportStar(require("./voices/client/requests"), exports);

package/dist/api/resources/infill/client/Client.js

@@ -113,7 +113,7 @@ class Infill {
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
                 url: (0, url_join_1.default)((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CartesiaEnvironment.Production, "/infill/bytes"),
                 method: "POST",
-                headers: Object.assign(Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.4", "User-Agent": "@cartesia/cartesia-js/2.2.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                headers: Object.assign(Object.assign(Object.assign({ "Cartesia-Version": (_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.cartesiaVersion) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.cartesiaVersion) !== null && _f !== void 0 ? _f : "2024-06-10", "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "@cartesia/cartesia-js", "X-Fern-SDK-Version": "2.2.7", "User-Agent": "@cartesia/cartesia-js/2.2.7", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 requestType: "file",
                 duplex: _maybeEncodedRequest.duplex,
                 body: _maybeEncodedRequest.body,

package/dist/api/resources/infill/client/requests/InfillBytesRequest.d.ts

@@ -40,23 +40,16 @@ export interface InfillBytesRequest {
     voiceId: string;
     /** The format of the output audio */
     outputFormatContainer: Cartesia.OutputFormatContainer;
-    /** The sample rate of the output audio */
+    /** The sample rate of the output audio in Hz. Supported sample rates are 8000, 16000, 22050, 24000, 44100, 48000. */
     outputFormatSampleRate: number;
-    /**
-     * Required for `raw` and `wav` containers.
-     *
-     */
+    /** Required for `raw` and `wav` containers. */
     outputFormatEncoding?: Cartesia.RawEncoding;
-    /**
-     * Required for `mp3` containers.
-     *
-     */
+    /** Required for `mp3` containers. */
     outputFormatBitRate?: number;
     /**
      * Either a number between -1.0 and 1.0 or a natural language description of speed.
      *
      * If you specify a number, 0.0 is the default speed, -1.0 is the slowest speed, and 1.0 is the fastest speed.
-     *
      */
     voiceExperimentalControlsSpeed?: Cartesia.Speed;
     /**
@@ -65,7 +58,6 @@ export interface InfillBytesRequest {
      * Supported emotions are: anger, positivity, surprise, sadness, and curiosity.
      *
      * Supported levels are: lowest, low, (omit), high, highest.
-     *
      */
     voiceExperimentalControlsEmotion?: Cartesia.Emotion[];
 }

package/dist/api/resources/stt/client/Client.d.ts

@@ -1,8 +1,16 @@
+/**
+ * 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";
+import * as fs from "fs";
+import { Blob } from "buffer";
 export declare namespace Stt {
     interface Options {
         environment?: core.Supplier<environments.CartesiaEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
         apiKey?: core.Supplier<string | undefined>;
         /** Override the Cartesia-Version header */
         cartesiaVersion?: "2024-06-10";
@@ -17,11 +25,46 @@ export declare namespace Stt {
         abortSignal?: AbortSignal;
         /** Override the Cartesia-Version header */
         cartesiaVersion?: "2024-06-10";
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
     }
 }
 export declare class Stt {
     protected readonly _options: Stt.Options;
     constructor(_options?: Stt.Options);
+    /**
+     * Transcribes audio files into text using Cartesia's Speech-to-Text API.
+     *
+     * Upload an audio file and receive a complete transcription response. Supports arbitrarily long audio files with automatic intelligent chunking for longer audio.
+     *
+     * **Supported audio formats:** flac, m4a, mp3, mp4, mpeg, mpga, oga, ogg, wav, webm
+     *
+     * **Response format:** Returns JSON with transcribed text, duration, and language. Include `timestamp_granularities: ["word"]` to get word-level timestamps.
+     *
+     * **Pricing:** Batch transcription is priced at **1 credit per 2 seconds** of audio processed.
+     *
+     * <Note>
+     * For migrating from the OpenAI SDK, see our [OpenAI Whisper to Cartesia Ink Migration Guide](/api-reference/stt/migrate-from-open-ai).
+     * </Note>
+     *
+     * @param {File | fs.ReadStream | Blob} file
+     * @param {Cartesia.TranscriptionRequest} request
+     * @param {Stt.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.stt.transcribe(fs.createReadStream("/path/to/your/file"), {
+     *         model: "ink-whisper",
+     *         language: "en"
+     *     })
+     *
+     * @example
+     *     await client.stt.transcribe(fs.createReadStream("/path/to/your/file"), {
+     *         model: "ink-whisper",
+     *         language: "en",
+     *         timestampGranularities: ["word"]
+     *     })
+     */
+    transcribe(file: File | fs.ReadStream | Blob, request: Cartesia.TranscriptionRequest, requestOptions?: Stt.RequestOptions): Promise<Cartesia.TranscriptionResponse>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         "X-API-Key": string | undefined;
     }>;