@elevenlabs/elevenlabs-js 2.42.0 → 2.44.0

package/api/resources/conversationalAi/resources/twilio/client/Client.js

@@ -148,6 +148,7 @@ class TwilioClient {
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 requestType: "json",
                 body: serializers.conversationalAi.BodyRegisterATwilioCallAndReturnTwiMlV1ConvaiTwilioRegisterCallPost.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                responseType: "text",
                 timeoutMs: ((_j = (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.timeoutInSeconds) !== null && _j !== void 0 ? _j : 240) * 1000,
                 maxRetries: (_k = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _k !== void 0 ? _k : (_l = this._options) === null || _l === void 0 ? void 0 : _l.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -155,7 +156,7 @@ class TwilioClient {
                 logging: this._options.logging,
             });
             if (_response.ok) {
-                return { data: undefined, rawResponse: _response.rawResponse };
+                return { data: _response.body, rawResponse: _response.rawResponse };
             }
             if (_response.error.reason === "status-code") {
                 switch (_response.error.statusCode) {

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

@@ -39,7 +39,7 @@ export declare class MusicClient {
     stream(request?: ElevenLabs.BodyStreamComposedMusicV1MusicStreamPost, requestOptions?: MusicClient.RequestOptions): core.HttpResponsePromise<ReadableStream<Uint8Array>>;
     private __stream;
     /**
-     * Upload a music file to be later used for inpainting. Only available to enterprise clients with access to the inpainting feature.
+     * Upload a music file to be later used for inpainting. Only available to enterprise clients with access to the inpainting feature. Price for uploading is the same as the one for song generation. All uploaded content gets inspected for copyright infringement. If copyrighted content is detected, half of the request cost is still charged.
      *
      * @param {ElevenLabs.BodyUploadMusicV1MusicUploadPost} request
      * @param {MusicClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -299,7 +299,7 @@ class MusicClient {
         });
     }
     /**
-     * Upload a music file to be later used for inpainting. Only available to enterprise clients with access to the inpainting feature.
+     * Upload a music file to be later used for inpainting. Only available to enterprise clients with access to the inpainting feature. Price for uploading is the same as the one for song generation. All uploaded content gets inspected for copyright infringement. If copyrighted content is detected, half of the request cost is still charged.
      *
      * @param {ElevenLabs.BodyUploadMusicV1MusicUploadPost} request
      * @param {MusicClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -158,6 +158,9 @@ class SpeechToTextClient {
             if (request.noVerbatim != null) {
                 _request.append("no_verbatim", request.noVerbatim.toString());
             }
+            if (request.detectSpeakerRoles != null) {
+                _request.append("detect_speaker_roles", request.detectSpeakerRoles.toString());
+            }
             if (request.entityRedaction != null) {
                 if (Array.isArray(request.entityRedaction))
                     for (const _item of request.entityRedaction) {

package/api/resources/speechToText/client/requests/BodySpeechToTextV1SpeechToTextPost.d.ts

@@ -48,18 +48,20 @@ export interface BodySpeechToTextV1SpeechToTextPost {
     temperature?: number;
     /** If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed. Must be an integer between 0 and 2147483647. */
     seed?: number;
-    /** Whether the audio file contains multiple channels where each channel contains a single speaker. When enabled, each channel will be transcribed independently and the results will be combined. Each word in the response will include a 'channel_index' field indicating which channel it was spoken on. A maximum of 5 channels is supported. */
+    /** Whether the audio file contains multiple channels where each channel contains a single speaker. When enabled, each channel will be transcribed independently and the results will be combined. Each word in the response will include a 'channel_index' field indicating which channel it was spoken on. A maximum of 5 channels is supported. Each channel is billed independently at the full audio duration, so cost scales linearly with the number of channels. */
     useMultiChannel?: boolean;
     /** Optional metadata to be included in the webhook response. This should be a JSON string representing an object with a maximum depth of 2 levels and maximum size of 16KB. Useful for tracking internal IDs, job references, or other contextual information. */
     webhookMetadata?: ElevenLabs.SpeechToTextConvertRequestWebhookMetadata;
-    /** Detect entities in the transcript. Can be 'all' to detect all entities, a single entity type or category string, or a list of entity types/categories. Categories include 'pii', 'phi', 'pci', 'other', 'offensive_language'. When enabled, detected entities will be returned in the 'entities' field with their text, type, and character positions. Usage of this parameter will incur additional costs. */
+    /** Detect entities in the transcript. Can be 'all' to detect all entities, a single entity type or category string, or a list of entity types/categories. Categories include 'pii', 'phi', 'pci', 'other', 'offensive_language'. When enabled, detected entities will be returned in the 'entities' field with their text, type, and character positions. Usage of this parameter will incur an additional 30% surcharge on the base transcription cost. */
     entityDetection?: ElevenLabs.SpeechToTextConvertRequestEntityDetection;
     /** If true, the transcription will not have any filler words, false starts and non-speech sounds. Only supported with scribe_v2 model. */
     noVerbatim?: boolean;
-    /** Redact entities from the transcript text. Accepts the same format as entity_detection: 'all', a category ('pii', 'phi'), or specific entity types. Must be a subset of entity_detection. When redaction is enabled, the entities field will not be returned. */
+    /** Whether to detect speaker roles (agent vs customer). Requires diarize=true. Cannot be used with use_multi_channel=true. When enabled, speaker_id values will be 'agent' and 'customer' instead of 'speaker_0', 'speaker_1', etc. Usage incurs an additional 10% surcharge on base transcription cost. */
+    detectSpeakerRoles?: boolean;
+    /** Redact entities from the transcript text. Accepts the same format as entity_detection: 'all', a category ('pii', 'phi'), or specific entity types. Must be a subset of entity_detection. When redaction is enabled, the entities field will not be returned. Usage of this parameter will incur an additional 30% surcharge on the base transcription cost. */
     entityRedaction?: ElevenLabs.SpeechToTextConvertRequestEntityRedaction;
     /** How to format redacted entities. 'redacted' replaces with {REDACTED}, 'entity_type' replaces with {ENTITY_TYPE}, 'enumerated_entity_type' replaces with {ENTITY_TYPE_N} where N enumerates each occurrence. Only used when entity_redaction is set. */
     entityRedactionMode?: string;
-    /** A list of keyterms to bias the transcription towards.           The keyterms are words or phrases you want the model to recognise more accurately.           The number of keyterms cannot exceed 1000.           The length of each keyterm must be less than 50 characters.           Keyterms can contain at most 5 words (after normalisation).           For example ["hello", "world", "technical term"].           Usage of this parameter will incur additional costs.           When more than 100 keyterms are provided, a minimum billable duration of 20 seconds applies per request. */
+    /** A list of keyterms to bias the transcription towards.           The keyterms are words or phrases you want the model to recognise more accurately.           The number of keyterms cannot exceed 1000.           The length of each keyterm must be less than 50 characters.           Keyterms can contain at most 5 words (after normalisation).           For example ["hello", "world", "technical term"].           Usage of this parameter will incur an additional 20% surcharge on the base transcription cost.           When more than 100 keyterms are provided, a minimum billable duration of 20 seconds applies per request. */
     keyterms?: string[];
 }

package/api/resources/speechToText/types/SpeechToTextConvertRequestEntityDetection.d.ts

@@ -1,4 +1,4 @@
 /**
- * Detect entities in the transcript. Can be 'all' to detect all entities, a single entity type or category string, or a list of entity types/categories. Categories include 'pii', 'phi', 'pci', 'other', 'offensive_language'. When enabled, detected entities will be returned in the 'entities' field with their text, type, and character positions. Usage of this parameter will incur additional costs.
+ * Detect entities in the transcript. Can be 'all' to detect all entities, a single entity type or category string, or a list of entity types/categories. Categories include 'pii', 'phi', 'pci', 'other', 'offensive_language'. When enabled, detected entities will be returned in the 'entities' field with their text, type, and character positions. Usage of this parameter will incur an additional 30% surcharge on the base transcription cost.
  */
 export type SpeechToTextConvertRequestEntityDetection = string | string[];

package/api/resources/speechToText/types/SpeechToTextConvertRequestEntityRedaction.d.ts

@@ -1,4 +1,4 @@
 /**
- * Redact entities from the transcript text. Accepts the same format as entity_detection: 'all', a category ('pii', 'phi'), or specific entity types. Must be a subset of entity_detection. When redaction is enabled, the entities field will not be returned.
+ * Redact entities from the transcript text. Accepts the same format as entity_detection: 'all', a category ('pii', 'phi'), or specific entity types. Must be a subset of entity_detection. When redaction is enabled, the entities field will not be returned. Usage of this parameter will incur an additional 30% surcharge on the base transcription cost.
  */
 export type SpeechToTextConvertRequestEntityRedaction = string | string[];

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

@@ -23,7 +23,6 @@ export declare class StudioClient {
      *
      * @example
      *     await client.studio.createPodcast({
-     *         safetyIdentifier: "safety-identifier",
      *         modelId: "eleven_multilingual_v2",
      *         mode: {
      *             type: "conversation",

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

@@ -82,7 +82,6 @@ class StudioClient {
      *
      * @example
      *     await client.studio.createPodcast({
-     *         safetyIdentifier: "safety-identifier",
      *         modelId: "eleven_multilingual_v2",
      *         mode: {
      *             type: "conversation",

package/api/resources/studio/client/requests/BodyCreatePodcastV1StudioPodcastsPost.d.ts

@@ -2,7 +2,6 @@ import type * as ElevenLabs from "../../../../index";
 /**
  * @example
  *     {
- *         safetyIdentifier: "safety-identifier",
  *         modelId: "eleven_multilingual_v2",
  *         mode: {
  *             type: "conversation",
@@ -33,7 +32,7 @@ export interface BodyCreatePodcastV1StudioPodcastsPost {
      * 'ultra' - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side.
      * 'ultra_lossless' - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format.
      */
-    qualityPreset?: ElevenLabs.BodyCreatePodcastV1StudioPodcastsPostQualityPreset;
+    qualityPreset?: ElevenLabs.QualityPresetType;
     /**
      * Duration of the generated podcast. Must be one of:
      * short - produces podcasts shorter than 3 minutes.

package/api/resources/studio/resources/projects/client/Client.js

@@ -171,9 +171,7 @@ class ProjectsClient {
                 _request.append("from_content_json", request.fromContentJson);
             }
             if (request.qualityPreset != null) {
-                _request.append("quality_preset", serializers.studio.ProjectsCreateRequestQualityPreset.jsonOrThrow(request.qualityPreset, {
-                    unrecognizedObjectKeys: "strip",
-                }));
+                _request.append("quality_preset", serializers.QualityPresetType.jsonOrThrow(request.qualityPreset, { unrecognizedObjectKeys: "strip" }));
             }
             if (request.title != null) {
                 _request.append("title", request.title);

package/api/resources/studio/resources/projects/client/requests/BodyCreateStudioProjectV1StudioProjectsPost.d.ts

@@ -34,7 +34,7 @@ export interface BodyCreateStudioProjectV1StudioProjectsPost {
      * 'ultra' - ultra quality output format, 192kbps with 44.1kHz sample rate and highest improvements on our side.
      * 'ultra_lossless' - ultra quality output format, 705.6kbps with 44.1kHz sample rate and highest improvements on our side in a fully lossless format.
      */
-    qualityPreset?: ElevenLabs.studio.ProjectsCreateRequestQualityPreset;
+    qualityPreset?: ElevenLabs.QualityPresetType;
     /** An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download. */
     title?: string;
     /** An optional name of the author of the Studio project, this will be added as metadata to the mp3 file on Studio project or chapter download. */

package/api/resources/studio/resources/projects/types/index.d.ts

@@ -1,5 +1,4 @@
 export * from "./ProjectsCreateRequestApplyTextNormalization";
 export * from "./ProjectsCreateRequestFiction";
-export * from "./ProjectsCreateRequestQualityPreset";
 export * from "./ProjectsCreateRequestSourceType";
 export * from "./ProjectsCreateRequestTargetAudience";

package/api/resources/studio/resources/projects/types/index.js

@@ -16,6 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ProjectsCreateRequestApplyTextNormalization"), exports);
 __exportStar(require("./ProjectsCreateRequestFiction"), exports);
-__exportStar(require("./ProjectsCreateRequestQualityPreset"), exports);
 __exportStar(require("./ProjectsCreateRequestSourceType"), exports);
 __exportStar(require("./ProjectsCreateRequestTargetAudience"), exports);

package/api/resources/studio/types/index.d.ts

@@ -1,6 +1,5 @@
 export * from "./BodyCreatePodcastV1StudioPodcastsPostApplyTextNormalization";
 export * from "./BodyCreatePodcastV1StudioPodcastsPostDurationScale";
 export * from "./BodyCreatePodcastV1StudioPodcastsPostMode";
-export * from "./BodyCreatePodcastV1StudioPodcastsPostQualityPreset";
 export * from "./BodyCreatePodcastV1StudioPodcastsPostSource";
 export * from "./BodyCreatePodcastV1StudioPodcastsPostSourceTwoItem";

package/api/resources/studio/types/index.js

@@ -17,6 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./BodyCreatePodcastV1StudioPodcastsPostApplyTextNormalization"), exports);
 __exportStar(require("./BodyCreatePodcastV1StudioPodcastsPostDurationScale"), exports);
 __exportStar(require("./BodyCreatePodcastV1StudioPodcastsPostMode"), exports);
-__exportStar(require("./BodyCreatePodcastV1StudioPodcastsPostQualityPreset"), exports);
 __exportStar(require("./BodyCreatePodcastV1StudioPodcastsPostSource"), exports);
 __exportStar(require("./BodyCreatePodcastV1StudioPodcastsPostSourceTwoItem"), exports);

package/api/resources/textToDialogue/client/requests/BodyTextToDialogueFullWithTimestamps.d.ts

@@ -15,7 +15,7 @@ import type * as ElevenLabs from "../../../../index";
 export interface BodyTextToDialogueFullWithTimestamps {
     /** Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM and WAV formats with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs. */
     outputFormat?: ElevenLabs.TextToDialogueConvertWithTimestampsRequestOutputFormat;
-    /** A list of dialogue inputs, each containing text and a voice ID which will be converted into speech. The maximum number of unique voice IDs is 10. */
+    /** A list of dialogue inputs, each containing text and a voice ID which will be converted into speech. The maximum number of unique voice IDs is 10. For reliable generation, keep the total character count across all `inputs[].text` values at or below 2,000 characters per request. Longer requests can terminate early in streaming responses or return a validation error. */
     inputs: ElevenLabs.DialogueInput[];
     /** Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property. */
     modelId?: string;

package/api/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceStreamingV1TextToDialogueStreamPost.d.ts

@@ -14,7 +14,7 @@ import type * as ElevenLabs from "../../../../index";
 export interface BodyTextToDialogueMultiVoiceStreamingV1TextToDialogueStreamPost {
     /** Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs. */
     outputFormat?: ElevenLabs.AllowedOutputFormats;
-    /** A list of dialogue inputs, each containing text and a voice ID which will be converted into speech. The maximum number of unique voice IDs is 10. */
+    /** A list of dialogue inputs, each containing text and a voice ID which will be converted into speech. The maximum number of unique voice IDs is 10. For reliable generation, keep the total character count across all `inputs[].text` values at or below 2,000 characters per request. Longer requests can terminate early in streaming responses or return a validation error. */
     inputs: ElevenLabs.DialogueInput[];
     /** Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property. */
     modelId?: string;
@@ -28,6 +28,4 @@ export interface BodyTextToDialogueMultiVoiceStreamingV1TextToDialogueStreamPost
     seed?: number;
     /** This parameter controls text normalization with three modes: 'auto', 'on', and 'off'. When set to 'auto', the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With 'on', text normalization will always be applied, while with 'off', it will be skipped. */
     applyTextNormalization?: ElevenLabs.BodyTextToDialogueMultiVoiceStreamingV1TextToDialogueStreamPostApplyTextNormalization;
-    /** Avatar context when this generation is made from the Avatars video editor. */
-    avatarContext?: ElevenLabs.AvatarContextRequestModel;
 }

package/api/resources/textToDialogue/client/requests/BodyTextToDialogueMultiVoiceV1TextToDialoguePost.d.ts

@@ -14,7 +14,7 @@ import type * as ElevenLabs from "../../../../index";
 export interface BodyTextToDialogueMultiVoiceV1TextToDialoguePost {
     /** Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM and WAV formats with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs. */
     outputFormat?: ElevenLabs.TextToDialogueConvertRequestOutputFormat;
-    /** A list of dialogue inputs, each containing text and a voice ID which will be converted into speech. The maximum number of unique voice IDs is 10. */
+    /** A list of dialogue inputs, each containing text and a voice ID which will be converted into speech. The maximum number of unique voice IDs is 10. For reliable generation, keep the total character count across all `inputs[].text` values at or below 2,000 characters per request. Longer requests can terminate early in streaming responses or return a validation error. */
     inputs: ElevenLabs.DialogueInput[];
     /** Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property. */
     modelId?: string;
@@ -28,6 +28,4 @@ export interface BodyTextToDialogueMultiVoiceV1TextToDialoguePost {
     seed?: number;
     /** This parameter controls text normalization with three modes: 'auto', 'on', and 'off'. When set to 'auto', the system will automatically decide whether to apply text normalization (e.g., spelling out numbers). With 'on', text normalization will always be applied, while with 'off', it will be skipped. */
     applyTextNormalization?: ElevenLabs.BodyTextToDialogueMultiVoiceV1TextToDialoguePostApplyTextNormalization;
-    /** Avatar context when this generation is made from the Avatars video editor. */
-    avatarContext?: ElevenLabs.AvatarContextRequestModel;
 }

package/api/resources/textToDialogue/client/requests/BodyTextToDialogueStreamWithTimestamps.d.ts

@@ -15,7 +15,7 @@ import type * as ElevenLabs from "../../../../index";
 export interface BodyTextToDialogueStreamWithTimestamps {
     /** Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs. */
     outputFormat?: ElevenLabs.AllowedOutputFormats;
-    /** A list of dialogue inputs, each containing text and a voice ID which will be converted into speech. The maximum number of unique voice IDs is 10. */
+    /** A list of dialogue inputs, each containing text and a voice ID which will be converted into speech. The maximum number of unique voice IDs is 10. For reliable generation, keep the total character count across all `inputs[].text` values at or below 2,000 characters per request. Longer requests can terminate early in streaming responses or return a validation error. */
     inputs: ElevenLabs.DialogueInput[];
     /** Identifier of the model that will be used, you can query them using GET /v1/models. The model needs to have support for text to speech, you can check this using the can_do_text_to_speech property. */
     modelId?: string;

package/api/resources/textToSpeech/client/requests/BodyTextToSpeechFull.d.ts

@@ -49,6 +49,4 @@ export interface BodyTextToSpeechFull {
     applyTextNormalization?: ElevenLabs.BodyTextToSpeechFullApplyTextNormalization;
     /** This parameter controls language text normalization. This helps with proper pronunciation of text in some supported languages. WARNING: This parameter can heavily increase the latency of the request. Currently only supported for Japanese. */
     applyLanguageTextNormalization?: boolean;
-    /** Avatar context when this generation is made from the Avatars video editor. */
-    avatarContext?: ElevenLabs.AvatarContextRequestModel;
 }

package/api/resources/textToSpeech/client/requests/StreamTextToSpeechRequest.d.ts

@@ -49,6 +49,4 @@ export interface StreamTextToSpeechRequest {
     applyTextNormalization?: ElevenLabs.BodyTextToSpeechStreamApplyTextNormalization;
     /** This parameter controls language text normalization. This helps with proper pronunciation of text in some supported languages. WARNING: This parameter can heavily increase the latency of the request. Currently only supported for Japanese. */
     applyLanguageTextNormalization?: boolean;
-    /** Avatar context when this generation is made from the Avatars video editor. */
-    avatarContext?: ElevenLabs.AvatarContextRequestModel;
 }

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

@@ -11,7 +11,7 @@ export declare class UsageClient {
     protected readonly _options: NormalizedClientOptions<UsageClient.Options>;
     constructor(options?: UsageClient.Options);
     /**
-     * Returns the usage metrics for the current user or the entire workspace they are part of. The response provides a time axis based on the specified aggregation interval (default: day), with usage values for each interval along that axis. Usage is broken down by the selected breakdown type. For example, breakdown type "voice" will return the usage of each voice for each interval along the time axis.
+     * (Deprecated) This endpoint is deprecated. Use /v1/workspace/analytics/query/usage-by-product-over-time instead. Returns the usage metrics for the current user or the entire workspace they are part of. The response provides a time axis based on the specified aggregation interval (default: day), with usage values for each interval along that axis. Usage is broken down by the selected breakdown type. For example, breakdown type "voice" will return the usage of each voice for each interval along the time axis.
      *
      * @param {ElevenLabs.UsageGetRequest} request
      * @param {UsageClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -57,7 +57,7 @@ class UsageClient {
         this._options = (0, BaseClient_1.normalizeClientOptions)(options);
     }
     /**
-     * Returns the usage metrics for the current user or the entire workspace they are part of. The response provides a time axis based on the specified aggregation interval (default: day), with usage values for each interval along that axis. Usage is broken down by the selected breakdown type. For example, breakdown type "voice" will return the usage of each voice for each interval along the time axis.
+     * (Deprecated) This endpoint is deprecated. Use /v1/workspace/analytics/query/usage-by-product-over-time instead. Returns the usage metrics for the current user or the entire workspace they are part of. The response provides a time axis based on the specified aggregation interval (default: day), with usage values for each interval along that axis. Usage is broken down by the selected breakdown type. For example, breakdown type "voice" will return the usage of each voice for each interval along the time axis.
      *
      * @param {ElevenLabs.UsageGetRequest} request
      * @param {UsageClient.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -24,7 +24,7 @@ export interface VoicesSearchRequest {
     sort?: string;
     /** Which direction to sort the voices in. 'asc' or 'desc'. */
     sortDirection?: string;
-    /** Type of the voice to filter by. One of 'personal', 'community', 'default', 'workspace', 'non-default', 'saved'. 'non-default' is equal to all but 'default'. 'saved' is equal to non-default, but includes default voices if they have been added to a collection. */
+    /** Type of the voice to filter by. One of 'personal', 'community', 'default', 'workspace', 'non-default', 'non-community', 'saved'. 'non-default' is equal to all but 'default'. 'non-community' is equal to 'personal' and 'workspace' combined (excludes library copies). 'saved' is equal to non-default, but includes default voices if they have been added to a collection. */
     voiceType?: string;
     /** Category of the voice to filter by. One of 'premade', 'cloned', 'generated', 'professional' */
     category?: string;

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

@@ -5,6 +5,7 @@ import { GroupsClient } from "../resources/groups/client/Client";
 import { InvitesClient } from "../resources/invites/client/Client";
 import { MembersClient } from "../resources/members/client/Client";
 import { ResourcesClient } from "../resources/resources/client/Client";
+import { UsageClient } from "../resources/usage/client/Client";
 export declare namespace WorkspaceClient {
     type Options = BaseClientOptions;
 }
@@ -15,10 +16,12 @@ export declare class WorkspaceClient {
     protected _invites: InvitesClient | undefined;
     protected _members: MembersClient | undefined;
     protected _resources: ResourcesClient | undefined;
+    protected _usage: UsageClient | undefined;
     constructor(options?: WorkspaceClient.Options);
     get authConnections(): AuthConnectionsClient;
     get groups(): GroupsClient;
     get invites(): InvitesClient;
     get members(): MembersClient;
     get resources(): ResourcesClient;
+    get usage(): UsageClient;
 }

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

@@ -8,6 +8,7 @@ const Client_2 = require("../resources/groups/client/Client");
 const Client_3 = require("../resources/invites/client/Client");
 const Client_4 = require("../resources/members/client/Client");
 const Client_5 = require("../resources/resources/client/Client");
+const Client_6 = require("../resources/usage/client/Client");
 class WorkspaceClient {
     constructor(options = {}) {
         this._options = (0, BaseClient_1.normalizeClientOptions)(options);
@@ -32,5 +33,9 @@ class WorkspaceClient {
         var _a;
         return ((_a = this._resources) !== null && _a !== void 0 ? _a : (this._resources = new Client_5.ResourcesClient(this._options)));
     }
+    get usage() {
+        var _a;
+        return ((_a = this._usage) !== null && _a !== void 0 ? _a : (this._usage = new Client_6.UsageClient(this._options)));
+    }
 }
 exports.WorkspaceClient = WorkspaceClient;

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

@@ -9,3 +9,6 @@ export * from "./members/client/requests";
 export * as resources from "./resources";
 export * from "./resources/client/requests";
 export * from "./resources/types";
+export * as usage from "./usage";
+export * from "./usage/client/requests";
+export * from "./usage/types";

package/api/resources/workspace/resources/index.js

@@ -36,7 +36,7 @@ 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 });
-exports.resources = exports.members = exports.invites = exports.groups = exports.authConnections = void 0;
+exports.usage = exports.resources = exports.members = exports.invites = exports.groups = exports.authConnections = void 0;
 exports.authConnections = __importStar(require("./authConnections"));
 __exportStar(require("./authConnections/types"), exports);
 exports.groups = __importStar(require("./groups"));
@@ -48,3 +48,6 @@ __exportStar(require("./members/client/requests"), exports);
 exports.resources = __importStar(require("./resources"));
 __exportStar(require("./resources/client/requests"), exports);
 __exportStar(require("./resources/types"), exports);
+exports.usage = __importStar(require("./usage"));
+__exportStar(require("./usage/client/requests"), exports);
+__exportStar(require("./usage/types"), exports);

package/api/resources/workspace/resources/usage/client/Client.d.ts

@@ -0,0 +1,29 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../../../BaseClient";
+import { type NormalizedClientOptions } from "../../../../../../BaseClient";
+import * as core from "../../../../../../core";
+import * as ElevenLabs from "../../../../../index";
+export declare namespace UsageClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class UsageClient {
+    protected readonly _options: NormalizedClientOptions<UsageClient.Options>;
+    constructor(options?: UsageClient.Options);
+    /**
+     * Returns credit usage broken down by product type over time. Timestamps are Unix milliseconds. The response is a tabular structure with columns, column_types, column_units, and rows.
+     *
+     * @param {ElevenLabs.workspace.BodyGetWorkspaceUsageV1WorkspaceAnalyticsQueryUsageByProductOverTimePost} request
+     * @param {UsageClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workspace.usage.getUsageByProductOverTime({
+     *         startTime: 1,
+     *         endTime: 1
+     *     })
+     */
+    getUsageByProductOverTime(request: ElevenLabs.workspace.BodyGetWorkspaceUsageV1WorkspaceAnalyticsQueryUsageByProductOverTimePost, requestOptions?: UsageClient.RequestOptions): core.HttpResponsePromise<ElevenLabs.WorkspaceAnalyticsQueryResponseModel>;
+    private __getUsageByProductOverTime;
+}

package/api/resources/workspace/resources/usage/client/Client.js

@@ -0,0 +1,121 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsageClient = void 0;
+const BaseClient_1 = require("../../../../../../BaseClient");
+const core = __importStar(require("../../../../../../core"));
+const headers_1 = require("../../../../../../core/headers");
+const environments = __importStar(require("../../../../../../environments"));
+const handleNonStatusCodeError_1 = require("../../../../../../errors/handleNonStatusCodeError");
+const errors = __importStar(require("../../../../../../errors/index"));
+const serializers = __importStar(require("../../../../../../serialization/index"));
+const ElevenLabs = __importStar(require("../../../../../index"));
+class UsageClient {
+    constructor(options = {}) {
+        this._options = (0, BaseClient_1.normalizeClientOptions)(options);
+    }
+    /**
+     * Returns credit usage broken down by product type over time. Timestamps are Unix milliseconds. The response is a tabular structure with columns, column_types, column_units, and rows.
+     *
+     * @param {ElevenLabs.workspace.BodyGetWorkspaceUsageV1WorkspaceAnalyticsQueryUsageByProductOverTimePost} request
+     * @param {UsageClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.workspace.usage.getUsageByProductOverTime({
+     *         startTime: 1,
+     *         endTime: 1
+     *     })
+     */
+    getUsageByProductOverTime(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getUsageByProductOverTime(request, requestOptions));
+    }
+    __getUsageByProductOverTime(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+            const _headers = (0, headers_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({ "xi-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.apiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.apiKey }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield ((_d = this._options.fetcher) !== null && _d !== void 0 ? _d : core.fetcher)({
+                url: core.url.join((_f = (_e = (yield core.Supplier.get(this._options.baseUrl))) !== null && _e !== void 0 ? _e : (yield core.Supplier.get(this._options.environment))) !== null && _f !== void 0 ? _f : environments.ElevenLabsEnvironment.Production, "v1/workspace/analytics/query/usage-by-product-over-time"),
+                method: "POST",
+                headers: _headers,
+                contentType: "application/json",
+                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                requestType: "json",
+                body: serializers.workspace.BodyGetWorkspaceUsageV1WorkspaceAnalyticsQueryUsageByProductOverTimePost.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
+                timeoutMs: ((_j = (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.timeoutInSeconds) !== null && _j !== void 0 ? _j : 240) * 1000,
+                maxRetries: (_k = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _k !== void 0 ? _k : (_l = this._options) === null || _l === void 0 ? void 0 : _l.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_m = this._options) === null || _m === void 0 ? void 0 : _m.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return {
+                    data: serializers.WorkspaceAnalyticsQueryResponseModel.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 422:
+                        throw new ElevenLabs.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.ElevenLabsError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return (0, handleNonStatusCodeError_1.handleNonStatusCodeError)(_response.error, _response.rawResponse, "POST", "/v1/workspace/analytics/query/usage-by-product-over-time");
+        });
+    }
+}
+exports.UsageClient = UsageClient;

package/api/resources/workspace/resources/usage/client/index.d.ts

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

package/api/resources/workspace/resources/usage/client/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("./requests"), exports);

package/api/resources/workspace/resources/usage/client/requests/BodyGetWorkspaceUsageV1WorkspaceAnalyticsQueryUsageByProductOverTimePost.d.ts

@@ -0,0 +1,15 @@
+import type * as ElevenLabs from "../../../../../../index";
+/**
+ * @example
+ *     {
+ *         startTime: 1,
+ *         endTime: 1
+ *     }
+ */
+export interface BodyGetWorkspaceUsageV1WorkspaceAnalyticsQueryUsageByProductOverTimePost {
+    startTime: number;
+    endTime: number;
+    intervalSeconds?: number;
+    groupBy?: ElevenLabs.workspace.BodyGetWorkspaceUsageV1WorkspaceAnalyticsQueryUsageByProductOverTimePostGroupByItem[];
+    filters?: ElevenLabs.ColumnFilter[];
+}

package/api/resources/workspace/resources/usage/client/requests/index.d.ts

@@ -0,0 +1 @@
+export type { BodyGetWorkspaceUsageV1WorkspaceAnalyticsQueryUsageByProductOverTimePost } from "./BodyGetWorkspaceUsageV1WorkspaceAnalyticsQueryUsageByProductOverTimePost";

package/api/resources/workspace/resources/usage/client/requests/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/workspace/resources/usage/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./client";
+export * from "./types";

package/api/resources/workspace/resources/usage/index.js

@@ -0,0 +1,18 @@
+"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("./client"), exports);
+__exportStar(require("./types"), exports);

package/api/resources/workspace/resources/usage/types/BodyGetWorkspaceUsageV1WorkspaceAnalyticsQueryUsageByProductOverTimePostGroupByItem.d.ts

@@ -0,0 +1,18 @@
+export declare const BodyGetWorkspaceUsageV1WorkspaceAnalyticsQueryUsageByProductOverTimePostGroupByItem: {
+    readonly ProductType: "product_type";
+    readonly Model: "model";
+    readonly VoiceId: "voice_id";
+    readonly UserId: "user_id";
+    readonly FiatCurrency: "fiat_currency";
+    readonly FiatChargeType: "fiat_charge_type";
+    readonly Region: "region";
+    readonly ReportingWorkspaceId: "reporting_workspace_id";
+    readonly RequestSource: "request_source";
+    readonly ResourceId: "resource_id";
+    readonly SubresourceId: "subresource_id";
+    readonly RequestQueueType: "request_queue_type";
+    readonly VoiceMultiplier: "voice_multiplier";
+    readonly HashedXiApiKey: "hashed_xi_api_key";
+    readonly BillingGroupId: "billing_group_id";
+};
+export type BodyGetWorkspaceUsageV1WorkspaceAnalyticsQueryUsageByProductOverTimePostGroupByItem = (typeof BodyGetWorkspaceUsageV1WorkspaceAnalyticsQueryUsageByProductOverTimePostGroupByItem)[keyof typeof BodyGetWorkspaceUsageV1WorkspaceAnalyticsQueryUsageByProductOverTimePostGroupByItem];