ElevenlabsOpenapi class abstract

Annotations

• @ChopperApi.new()

Constructors

ElevenlabsOpenapi()

Properties

client ↔ ChopperClient

getter/setter pair, inherited

definitionType → Type

Used internally to retrieve the service from ChopperClient.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

docsGet() → Future<Response>

Redirect To Mintlify

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

v1AudioIsolationPost({String? xiApiKey, required BodyAudioIsolationV1AudioIsolationPost body}) → Future<Response>

Audio Isolation @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1AudioIsolationStreamPost({String? xiApiKey, required BodyAudioIsolationStreamV1AudioIsolationStreamPost body}) → Future<Response>

Audio Isolation Stream @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1AudioNativePost({String? xiApiKey, required BodyCreatesAudioNativeEnabledProjectV1AudioNativePost body}) → Future<Response<AudioNativeCreateProjectResponseModel>>

Creates Audio Native Enabled Project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1AudioNativeProjectIdContentPost({required String? projectId, String? xiApiKey, required BodyUpdateAudioNativeProjectContentV1AudioNativeProjectIdContentPost body}) → Future<Response<AudioNativeEditContentResponseModel>>

Update Audio-Native Project Content @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1AudioNativeProjectIdSettingsGet({required String? projectId, String? xiApiKey}) → Future<Response<GetAudioNativeProjectSettingsResponseModel>>

Get Audio Native Project Settings @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAddToKnowledgeBasePost({String? xiApiKey, required BodyAddToKnowledgeBaseV1ConvaiAddToKnowledgeBasePost body}) → Future<Response<AddKnowledgeBaseResponseModel>>

Add To Knowledge Base @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAgentAgentIdKnowledgeBaseSizeGet({required String? agentId, String? xiApiKey}) → Future<Response<GetAgentKnowledgebaseSizeResponseModel>>

Returns The Size Of The Agent'S Knowledge Base @param agent_id @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAgentAgentIdLlmUsageCalculatePost({required String? agentId, String? xiApiKey, required LLMUsageCalculatorRequestModel? body}) → Future<Response<LLMUsageCalculatorResponseModel>>

Calculate Expected Llm Usage For An Agent @param agent_id @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAgentsAgentIdAddToKnowledgeBasePost({String? xiApiKey, required BodyAddToKnowledgeBaseV1ConvaiAgentsAgentIdAddToKnowledgeBasePost body}) → Future<Response<AddKnowledgeBaseResponseModel>>

Add To Knowledge Base @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAgentsAgentIdAvatarPost({required String? agentId, String? xiApiKey, required BodyPostAgentAvatarV1ConvaiAgentsAgentIdAvatarPost body}) → Future<Response<PostAgentAvatarResponseModel>>

Post Agent Avatar @param agent_id The id of an agent. This is returned on agent creation. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAgentsAgentIdDelete({required String? agentId, String? xiApiKey}) → Future<Response>

Delete Agent @param agent_id The id of an agent. This is returned on agent creation. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAgentsAgentIdGet({required String? agentId, String? xiApiKey}) → Future<Response<GetAgentResponseModel>>

Get Agent @param agent_id The id of an agent. This is returned on agent creation. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAgentsAgentIdKnowledgeBaseDocumentationIdGet({required String? documentationId, String? xiApiKey}) → Future<Response>

Get Documentation From Knowledge Base @param documentation_id The id of a document from the knowledge base. This is returned on document addition. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAgentsAgentIdLinkGet({required String? agentId, String? xiApiKey}) → Future<Response<GetAgentLinkResponseModel>>

Get Shareable Agent Link @param agent_id The id of an agent. This is returned on agent creation. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAgentsAgentIdPatch({required String? agentId, String? xiApiKey, required BodyPatchesAnAgentSettingsV1ConvaiAgentsAgentIdPatch? body}) → Future<Response<GetAgentResponseModel>>

Patches An Agent Settings @param agent_id The id of an agent. This is returned on agent creation. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAgentsAgentIdSimulateConversationPost({required String? agentId, String? xiApiKey, required BodySimulatesAConversationV1ConvaiAgentsAgentIdSimulateConversationPost? body}) → Future<Response<AgentSimulatedChatTestResponseModel>>

Simulates A Conversation @param agent_id The id of an agent. This is returned on agent creation. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAgentsAgentIdSimulateConversationStreamPost({required String? agentId, String? xiApiKey, required BodySimulatesAConversationStreamV1ConvaiAgentsAgentIdSimulateConversationStreamPost? body}) → Future<Response>

Simulates A Conversation (Stream) @param agent_id The id of an agent. This is returned on agent creation. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAgentsAgentIdWidgetGet({required String? agentId, String? conversationSignature, String? xiApiKey}) → Future<Response<GetAgentEmbedResponseModel>>

Get Agent Widget Config @param agent_id The id of an agent. This is returned on agent creation. @param conversation_signature An expiring token that enables a websocket conversation to start. These can be generated for an agent using the /v1/convai/conversation/get-signed-url endpoint @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAgentsCreatePost({String? xiApiKey, required BodyCreateAgentV1ConvaiAgentsCreatePost? body}) → Future<Response<CreateAgentResponseModel>>

Create Agent @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiAgentsGet({String? cursor, int? pageSize, String? search, String? xiApiKey}) → Future<Response<GetAgentsPageResponseModel>>

List Agents @param cursor Used for fetching next page. Cursor is returned in the response. @param page_size How many Agents to return at maximum. Can not exceed 100, defaults to 30. @param search Search by agents name. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiBatchCallingBatchIdGet({required String? batchId, String? xiApiKey}) → Future<Response<BatchCallDetailedResponse>>

Get A Batch Call By Id. @param batch_id @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiBatchCallingSubmitPost({String? xiApiKey, required BodySubmitABatchCallRequestV1ConvaiBatchCallingSubmitPost? body}) → Future<Response<BatchCallResponse>>

Submit A Batch Call Request. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiBatchCallingWorkspaceGet({int? limit, String? lastDoc, String? xiApiKey}) → Future<Response<WorkspaceBatchCallsResponse>>

Get All Batch Calls For A Workspace. @param limit @param last_doc @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiConversationGetSignedUrlGet({required String? agentId, String? xiApiKey}) → Future<Response<ConversationSignedUrlResponseModel>>

Get Signed Url @param agent_id The id of the agent you're taking the action on. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiConversationGetSignedUrlGet2({required String? agentId, String? xiApiKey}) → Future<Response<ConversationSignedUrlResponseModel>>

Get Signed Url @param agent_id The id of the agent you're taking the action on. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiConversationsConversationIdAudioGet({required String? conversationId, String? xiApiKey}) → Future<Response>

Get Conversation Audio @param conversation_id The id of the conversation you're taking the action on. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiConversationsConversationIdDelete({required String? conversationId, String? xiApiKey}) → Future<Response>

Delete Conversation @param conversation_id The id of the conversation you're taking the action on. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiConversationsConversationIdFeedbackPost({required String? conversationId, required BodySendConversationFeedbackV1ConvaiConversationsConversationIdFeedbackPost? body}) → Future<Response>

Send Conversation Feedback @param conversation_id The id of the conversation you're taking the action on.

v1ConvaiConversationsConversationIdGet({required String? conversationId, String? xiApiKey}) → Future<Response<GetConversationResponseModel>>

Get Conversation Details @param conversation_id The id of the conversation you're taking the action on. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiConversationsGet({String? cursor, String? agentId, Object? callSuccessful, int? callStartBeforeUnix, int? callStartAfterUnix, int? pageSize, String? xiApiKey}) → Future<Response<GetConversationsPageResponseModel>>

Get Conversations @param cursor Used for fetching next page. Cursor is returned in the response. @param agent_id The id of the agent you're taking the action on. @param call_successful The result of the success evaluation @param call_start_before_unix Unix timestamp (in seconds) to filter conversations up to this start date. @param call_start_after_unix Unix timestamp (in seconds) to filter conversations after to this start date. @param page_size How many conversations to return at maximum. Can not exceed 100, defaults to 30. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiKnowledgeBaseDocumentationIdChunkChunkIdGet({required String? documentationId, required String? chunkId, String? xiApiKey}) → Future<Response<KnowledgeBaseDocumentChunkResponseModel>>

Get Documentation Chunk From Knowledge Base @param documentation_id The id of a document from the knowledge base. This is returned on document addition. @param chunk_id The id of a document RAG chunk from the knowledge base. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiKnowledgeBaseDocumentationIdContentGet({required String? documentationId, String? xiApiKey}) → Future<Response>

Get Document Content @param documentation_id The id of a document from the knowledge base. This is returned on document addition. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiKnowledgeBaseDocumentationIdDelete({required String? documentationId, bool? force, String? xiApiKey}) → Future<Response>

Delete Knowledge Base Document @param documentation_id The id of a document from the knowledge base. This is returned on document addition. @param force If set to true, the document will be deleted regardless of whether it is used by any agents and it will be deleted from the dependent agents. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiKnowledgeBaseDocumentationIdDependentAgentsGet({required String? documentationId, String? cursor, int? pageSize, String? xiApiKey}) → Future<Response<GetKnowledgeBaseDependentAgentsResponseModel>>

Get Dependent Agents List @param documentation_id The id of a document from the knowledge base. This is returned on document addition. @param cursor Used for fetching next page. Cursor is returned in the response. @param page_size How many documents to return at maximum. Can not exceed 100, defaults to 30. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiKnowledgeBaseDocumentationIdGet({required String? documentationId, String? xiApiKey}) → Future<Response>

Get Documentation From Knowledge Base @param documentation_id The id of a document from the knowledge base. This is returned on document addition. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiKnowledgeBaseDocumentationIdPatch({required String? documentationId, String? xiApiKey, required BodyUpdateDocumentV1ConvaiKnowledgeBaseDocumentationIdPatch? body}) → Future<Response>

Update Document @param documentation_id The id of a document from the knowledge base. This is returned on document addition. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiKnowledgeBaseDocumentationIdRagIndexPost({required String? documentationId, String? xiApiKey, required RAGIndexRequestModel? body}) → Future<Response<RAGIndexResponseModel>>

Compute Rag Index. @param documentation_id The id of a document from the knowledge base. This is returned on document addition. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiKnowledgeBaseFilePost({String? xiApiKey, required BodyCreateFileDocumentV1ConvaiKnowledgeBaseFilePost body}) → Future<Response<AddKnowledgeBaseResponseModel>>

Create File Document @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiKnowledgeBaseGet({String? cursor, int? pageSize, String? search, bool? showOnlyOwnedDocuments, List? types, bool? useTypesense, String? xiApiKey}) → Future<Response<GetKnowledgeBaseListResponseModel>>

Get Knowledge Base List @param cursor Used for fetching next page. Cursor is returned in the response. @param page_size How many documents to return at maximum. Can not exceed 100, defaults to 30. @param search If specified, the endpoint returns only such knowledge base documents whose names start with this string. @param show_only_owned_documents If set to true, the endpoint will return only documents owned by you (and not shared from somebody else). @param types If present, the endpoint will return only documents of the given types. @param use_typesense If set to true, the endpoint will use typesense DB to search for the documents). @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiKnowledgeBasePost({String? xiApiKey, required BodyAddToKnowledgeBaseV1ConvaiKnowledgeBasePost body}) → Future<Response<AddKnowledgeBaseResponseModel>>

Add To Knowledge Base @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiKnowledgeBaseTextPost({String? xiApiKey, required BodyCreateTextDocumentV1ConvaiKnowledgeBaseTextPost? body}) → Future<Response<AddKnowledgeBaseResponseModel>>

Create Text Document @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiKnowledgeBaseUrlPost({String? xiApiKey, required BodyCreateURLDocumentV1ConvaiKnowledgeBaseUrlPost? body}) → Future<Response<AddKnowledgeBaseResponseModel>>

Create Url Document @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiLlmUsageCalculatePost({required LLMUsageCalculatorPublicRequestModel? body}) → Future<Response<LLMUsageCalculatorResponseModel>>

Calculate Expected Llm Usage

v1ConvaiPhoneNumbersCreatePost({String? xiApiKey, required Object? body}) → Future<Response<CreatePhoneNumberResponseModel>>

Import Phone Number @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiPhoneNumbersGet({String? xiApiKey}) → Future<Response>

List Phone Numbers @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiPhoneNumbersPhoneNumberIdDelete({required String? phoneNumberId, String? xiApiKey}) → Future<Response>

Delete Phone Number @param phone_number_id The id of an agent. This is returned on agent creation. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiPhoneNumbersPhoneNumberIdGet({required String? phoneNumberId, String? xiApiKey}) → Future<Response>

Get Phone Number @param phone_number_id The id of an agent. This is returned on agent creation. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiPhoneNumbersPhoneNumberIdPatch({required String? phoneNumberId, String? xiApiKey, required UpdatePhoneNumberRequest? body}) → Future<Response>

Update Phone Number @param phone_number_id The id of an agent. This is returned on agent creation. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiSecretsGet({String? xiApiKey}) → Future<Response<GetWorkspaceSecretsResponseModel>>

Get Convai Workspace Secrets @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiSecretsPost({String? xiApiKey, required PostWorkspaceSecretRequest? body}) → Future<Response<PostWorkspaceSecretResponseModel>>

Create Convai Workspace Secret @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiSecretsSecretIdDelete({required String? secretId, String? xiApiKey}) → Future<Response>

Delete Convai Workspace Secret @param secret_id @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiSecretsSecretIdPatch({required String? secretId, String? xiApiKey, required PatchWorkspaceSecretRequest? body}) → Future<Response<PostWorkspaceSecretResponseModel>>

Update Convai Workspace Secret @param secret_id @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiSettingsDashboardGet({String? xiApiKey}) → Future<Response<GetConvAIDashboardSettingsResponseModel>>

Get Convai Dashboard Settings @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiSettingsDashboardPatch({String? xiApiKey, required PatchConvAIDashboardSettingsRequest? body}) → Future<Response<GetConvAIDashboardSettingsResponseModel>>

Update Convai Dashboard Settings @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiSettingsGet({String? xiApiKey}) → Future<Response<GetConvAISettingsResponseModel>>

Get Convai Settings @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiSettingsPatch({String? xiApiKey, required PatchConvAISettingsRequest? body}) → Future<Response<GetConvAISettingsResponseModel>>

Update Convai Settings @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiSipTrunkOutboundCallPost({String? xiApiKey, required BodyHandleAnOutboundCallViaSIPTrunkV1ConvaiSipTrunkOutboundCallPost? body}) → Future<Response<SIPTrunkOutboundCallResponse>>

Handle An Outbound Call Via Sip Trunk @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ConvaiTwilioOutboundCallPost({String? xiApiKey, required BodyHandleAnOutboundCallViaTwilioV1ConvaiTwilioOutboundCallPost? body}) → Future<Response<TwilioOutboundCallResponse>>

Handle An Outbound Call Via Twilio @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingDubbingIdAudioLanguageCodeGet({required String? dubbingId, required String? languageCode, String? xiApiKey}) → Future<Response<String>>

Get Dubbed File @param dubbing_id ID of the dubbing project. @param language_code ID of the language. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingDubbingIdDelete({required String? dubbingId, String? xiApiKey}) → Future<Response<DeleteDubbingResponseModel>>

Delete Dubbing @param dubbing_id ID of the dubbing project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingDubbingIdGet({required String? dubbingId, String? xiApiKey}) → Future<Response<DubbingMetadataResponse>>

Get Dubbing @param dubbing_id ID of the dubbing project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingDubbingIdTranscriptLanguageCodeGet({required String? dubbingId, required String? languageCode, V1DubbingDubbingIdTranscriptLanguageCodeGetFormatType? formatType, String? xiApiKey}) → Future<Response<String>>

Get Dubbed Transcript @param dubbing_id ID of the dubbing project. @param language_code ID of the language. @param format_type Format to use for the subtitle file, either 'srt' or 'webvtt' @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingPost({String? xiApiKey, required BodyDubAVideoOrAnAudioFileV1DubbingPost body}) → Future<Response<DoDubbingResponseModel>>

Dub A Video Or An Audio File @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingResourceDubbingIdDubPost({required String? dubbingId, String? xiApiKey, required BodyDubsAllOrSomeSegmentsAndLanguagesV1DubbingResourceDubbingIdDubPost? body}) → Future<Response<SegmentDubResponse>>

Dubs All Or Some Segments And Languages @param dubbing_id ID of the dubbing project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingResourceDubbingIdGet({required String? dubbingId, String? xiApiKey}) → Future<Response<DubbingResource>>

Get The Dubbing Resource For An Id. @param dubbing_id ID of the dubbing project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingResourceDubbingIdLanguagePost({required String? dubbingId, String? xiApiKey, required BodyAddALanguageToTheResourceV1DubbingResourceDubbingIdLanguagePost? body}) → Future<Response<LanguageAddedResponse>>

Add A Language To The Resource @param dubbing_id ID of the dubbing project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingResourceDubbingIdRenderLanguagePost({required String? dubbingId, required String? language, String? xiApiKey, required BodyRenderAudioOrVideoForTheGivenLanguageV1DubbingResourceDubbingIdRenderLanguagePost? body}) → Future<Response<DubbingRenderResponseModel>>

Render Audio Or Video For The Given Language @param dubbing_id ID of the dubbing project. @param language Render this language @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingResourceDubbingIdSegmentSegmentIdDelete({required String? dubbingId, required String? segmentId, String? xiApiKey}) → Future<Response<SegmentDeleteResponse>>

Deletes A Single Segment @param dubbing_id ID of the dubbing project. @param segment_id ID of the segment @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingResourceDubbingIdSegmentSegmentIdLanguagePatch({required String? dubbingId, required String? segmentId, required String? language, String? xiApiKey, required SegmentUpdatePayload? body}) → Future<Response<SegmentUpdateResponse>>

Modify A Single Segment @param dubbing_id ID of the dubbing project. @param segment_id ID of the segment @param language ID of the language. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingResourceDubbingIdSpeakerSpeakerIdPatch({required String? dubbingId, required String? speakerId, String? xiApiKey, required BodyUpdateMetadataForASpeakerV1DubbingResourceDubbingIdSpeakerSpeakerIdPatch? body}) → Future<Response<SpeakerUpdatedResponse>>

Update Metadata For A Speaker @param dubbing_id ID of the dubbing project. @param speaker_id ID of the speaker. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingResourceDubbingIdSpeakerSpeakerIdSegmentPost({required String? dubbingId, required String? speakerId, String? xiApiKey, required SegmentCreatePayload? body}) → Future<Response<SegmentCreateResponse>>

Create A Segment For The Speaker @param dubbing_id ID of the dubbing project. @param speaker_id ID of the speaker. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingResourceDubbingIdSpeakerSpeakerIdSimilarVoicesGet({required String? dubbingId, required String? speakerId, String? xiApiKey}) → Future<Response<SimilarVoicesForSpeakerResponse>>

Search The Elevenlabs Library For Voices Similar To A Speaker. @param dubbing_id ID of the dubbing project. @param speaker_id ID of the speaker. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingResourceDubbingIdTranscribePost({required String? dubbingId, String? xiApiKey, required BodyTranscribesSegmentsV1DubbingResourceDubbingIdTranscribePost? body}) → Future<Response<SegmentTranscriptionResponse>>

Transcribes Segments @param dubbing_id ID of the dubbing project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1DubbingResourceDubbingIdTranslatePost({required String? dubbingId, String? xiApiKey, required BodyTranslatesAllOrSomeSegmentsAndLanguagesV1DubbingResourceDubbingIdTranslatePost? body}) → Future<Response<SegmentTranslationResponse>>

Translates All Or Some Segments And Languages @param dubbing_id ID of the dubbing project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ForcedAlignmentPost({String? xiApiKey, required BodyCreateForcedAlignmentV1ForcedAlignmentPost body}) → Future<Response<ForcedAlignmentResponseModel>>

Create Forced Alignment @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1HistoryDownloadPost({String? xiApiKey, required BodyDownloadHistoryItemsV1HistoryDownloadPost? body}) → Future<Response<String>>

Download History Items @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1HistoryGet({int? pageSize, String? startAfterHistoryItemId, String? voiceId, String? search, String? source, String? xiApiKey}) → Future<Response<GetSpeechHistoryResponseModel>>

List Generated Items @param page_size How many history items to return at maximum. Can not exceed 1000, defaults to 100. @param start_after_history_item_id After which ID to start fetching, use this parameter to paginate across a large collection of history items. In case this parameter is not provided history items will be fetched starting from the most recently created one ordered descending by their creation date. @param voice_id Voice ID to be filtered for, you can use GET https://api.elevenlabs.io/v1/voices to receive a list of voices and their IDs. @param search search term used for filtering @param source Source of the generated history item @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1HistoryHistoryItemIdAudioGet({required String? historyItemId, String? xiApiKey}) → Future<Response<String>>

Get Audio From History Item @param history_item_id History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1HistoryHistoryItemIdDelete({required String? historyItemId, String? xiApiKey}) → Future<Response<DeleteHistoryItemResponse>>

Delete History Item @param history_item_id History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1HistoryHistoryItemIdGet({required String? historyItemId, String? xiApiKey}) → Future<Response<SpeechHistoryItemResponseModel>>

Get History Item @param history_item_id History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ModelsGet({String? xiApiKey}) → Future<Response<List<ModelResponseModel>>>

Get Models @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsAddPost({String? xiApiKey, required BodyAddProjectV1ProjectsAddPost body}) → Future<Response<AddProjectResponseModel>>

Add Project @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsGet({String? xiApiKey}) → Future<Response<GetProjectsResponseModel>>

Get Projects @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsPodcastCreatePost({String? xiApiKey, required BodyCreatePodcastV1ProjectsPodcastCreatePost? body}) → Future<Response<PodcastProjectResponseModel>>

Create Podcast @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdChaptersAddPost({required String? projectId, String? xiApiKey, required BodyAddChapterToAProjectV1ProjectsProjectIdChaptersAddPost? body}) → Future<Response<AddChapterResponseModel>>

Add Chapter To A Project @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdChaptersChapterIdConvertPost({required String? projectId, required String? chapterId, String? xiApiKey}) → Future<Response>

Convert Chapter @param project_id The ID of the Studio project. @param chapter_id The ID of the chapter. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdChaptersChapterIdDelete({required String? projectId, required String? chapterId, String? xiApiKey}) → Future<Response>

Delete Chapter @param project_id The ID of the Studio project. @param chapter_id The ID of the chapter. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdChaptersChapterIdGet({required String? projectId, required String? chapterId, String? xiApiKey}) → Future<Response<ChapterWithContentResponseModel>>

Get Chapter By Id @param project_id The ID of the Studio project. @param chapter_id The ID of the chapter. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdChaptersChapterIdPatch({required String? projectId, required String? chapterId, String? xiApiKey, required BodyEditChapterV1ProjectsProjectIdChaptersChapterIdPatch? body}) → Future<Response<EditChapterResponseModel>>

Edit Chapter @param project_id The ID of the Studio project. @param chapter_id The ID of the chapter. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdChaptersChapterIdSnapshotsChapterSnapshotIdStreamPost({required String? projectId, required String? chapterId, required String? chapterSnapshotId, String? xiApiKey, required BodyStreamChapterAudioV1ProjectsProjectIdChaptersChapterIdSnapshotsChapterSnapshotIdStreamPost? body}) → Future<Response>

Stream Chapter Audio @param project_id The ID of the Studio project. @param chapter_id The ID of the chapter. @param chapter_snapshot_id The ID of the chapter snapshot. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdChaptersChapterIdSnapshotsGet({required String? projectId, required String? chapterId, String? xiApiKey}) → Future<Response<ChapterSnapshotsResponseModel>>

List Chapter Snapshots @param project_id The ID of the Studio project. @param chapter_id The ID of the chapter. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdChaptersGet({required String? projectId, String? xiApiKey}) → Future<Response<GetChaptersResponseModel>>

Get Chapters @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdContentPost({required String? projectId, String? xiApiKey, required BodyEditProjectContentV1ProjectsProjectIdContentPost body}) → Future<Response<EditProjectResponseModel>>

Edit Project Content @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdConvertPost({required String? projectId, String? xiApiKey}) → Future<Response>

Convert Project @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdDelete({required String? projectId, String? xiApiKey}) → Future<Response>

Delete Project @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdGet({required String? projectId, String? xiApiKey}) → Future<Response<ProjectExtendedResponseModel>>

Get Project By Id @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdPost({required String? projectId, String? xiApiKey, required BodyEditBasicProjectInfoV1ProjectsProjectIdPost? body}) → Future<Response<EditProjectResponseModel>>

Edit Basic Project Info @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdSnapshotsGet({required String? projectId, String? xiApiKey}) → Future<Response<ProjectSnapshotsResponseModel>>

Get Project Snapshots @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdSnapshotsProjectSnapshotIdArchivePost({required String? projectId, required String? projectSnapshotId, String? xiApiKey}) → Future<Response>

Streams Archive With Project Audio @param project_id The ID of the Studio project. @param project_snapshot_id The ID of the Studio project snapshot. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdSnapshotsProjectSnapshotIdStreamPost({required String? projectId, required String? projectSnapshotId, String? xiApiKey, required BodyStreamProjectAudioV1ProjectsProjectIdSnapshotsProjectSnapshotIdStreamPost? body}) → Future<Response>

Stream Project Audio @param project_id The ID of the Studio project. @param project_snapshot_id The ID of the Studio project snapshot. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1ProjectsProjectIdUpdatePronunciationDictionariesPost({required String? projectId, String? xiApiKey, required BodyUpdatePronunciationDictionariesV1ProjectsProjectIdUpdatePronunciationDictionariesPost? body}) → Future<Response>

Update Pronunciation Dictionaries @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1PronunciationDictionariesAddFromFilePost({String? xiApiKey, required BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromFilePost body}) → Future<Response<AddPronunciationDictionaryResponseModel>>

Add A Pronunciation Dictionary @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1PronunciationDictionariesAddFromRulesPost({String? xiApiKey, required BodyAddAPronunciationDictionaryV1PronunciationDictionariesAddFromRulesPost? body}) → Future<Response<AddPronunciationDictionaryResponseModel>>

Add A Pronunciation Dictionary @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1PronunciationDictionariesDictionaryIdVersionIdDownloadGet({required String? dictionaryId, required String? versionId, String? xiApiKey}) → Future<Response<String>>

Get A Pls File With A Pronunciation Dictionary Version Rules @param dictionary_id The id of the pronunciation dictionary @param version_id The id of the version of the pronunciation dictionary @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1PronunciationDictionariesGet({String? cursor, int? pageSize, String? sort, String? sortDirection, String? xiApiKey}) → Future<Response<GetPronunciationDictionariesMetadataResponseModel>>

Get Pronunciation Dictionaries @param cursor Used for fetching next page. Cursor is returned in the response. @param page_size How many pronunciation dictionaries to return at maximum. Can not exceed 100, defaults to 30. @param sort Which field to sort by, one of 'created_at_unix' or 'name'. @param sort_direction Which direction to sort the voices in. 'ascending' or 'descending'. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1PronunciationDictionariesPronunciationDictionaryIdAddRulesPost({required String? pronunciationDictionaryId, String? xiApiKey, required BodyAddRulesToThePronunciationDictionaryV1PronunciationDictionariesPronunciationDictionaryIdAddRulesPost? body}) → Future<Response<PronunciationDictionaryRulesResponseModel>>

Add Rules To The Pronunciation Dictionary @param pronunciation_dictionary_id The id of the pronunciation dictionary @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1PronunciationDictionariesPronunciationDictionaryIdGet({required String? pronunciationDictionaryId, String? xiApiKey}) → Future<Response<GetPronunciationDictionaryMetadataResponseModel>>

Get Metadata For A Pronunciation Dictionary @param pronunciation_dictionary_id The id of the pronunciation dictionary @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1PronunciationDictionariesPronunciationDictionaryIdRemoveRulesPost({required String? pronunciationDictionaryId, String? xiApiKey, required BodyRemoveRulesFromThePronunciationDictionaryV1PronunciationDictionariesPronunciationDictionaryIdRemoveRulesPost? body}) → Future<Response<PronunciationDictionaryRulesResponseModel>>

Remove Rules From The Pronunciation Dictionary @param pronunciation_dictionary_id The id of the pronunciation dictionary @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1SharedVoicesGet({int? pageSize, V1SharedVoicesGetCategory? category, String? gender, String? age, String? accent, String? language, String? locale, String? search, List? useCases, List? descriptives, bool? featured, int? minNoticePeriodDays, bool? includeCustomRates, bool? includeLiveModerated, bool? readerAppEnabled, String? ownerId, String? sort, int? page, String? xiApiKey}) → Future<Response<GetLibraryVoicesResponseModel>>

Get Voices @param page_size How many shared voices to return at maximum. Can not exceed 100, defaults to 30. @param category Voice category used for filtering @param gender Gender used for filtering @param age Age used for filtering @param accent Accent used for filtering @param language Language used for filtering @param locale Locale used for filtering @param search Search term used for filtering @param use_cases Use-case used for filtering @param descriptives Search term used for filtering @param featured Filter featured voices @param min_notice_period_days Filter voices with a minimum notice period of the given number of days. @param include_custom_rates Include/exclude voices with custom rates @param include_live_moderated Include/exclude voices that are live moderated @param reader_app_enabled Filter voices that are enabled for the reader app @param owner_id Filter voices by public owner ID @param sort Sort criteria @param page @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1SimilarVoicesPost({String? xiApiKey, required BodyGetSimilarLibraryVoicesV1SimilarVoicesPost body}) → Future<Response<GetLibraryVoicesResponseModel>>

Get Similar Library Voices @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1SoundGenerationPost({V1SoundGenerationPostOutputFormat? outputFormat, String? xiApiKey, required BodySoundGenerationV1SoundGenerationPost? body}) → Future<Response<String>>

Sound Generation @param output_format 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. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1SpeechToSpeechVoiceIdPost({required String? voiceId, bool? enableLogging, int? optimizeStreamingLatency, V1SpeechToSpeechVoiceIdPostOutputFormat? outputFormat, String? xiApiKey, required BodySpeechToSpeechV1SpeechToSpeechVoiceIdPost body}) → Future<Response<String>>

Speech To Speech @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param enable_logging When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers. @param optimize_streaming_latency You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values: 0 - default mode (no latency optimizations) 1 - normal latency optimizations (about 50% of possible latency improvement of option 3) 2 - strong latency optimizations (about 75% of possible latency improvement of option 3) 3 - max latency optimizations 4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates). Defaults to None. @param output_format 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. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1SpeechToSpeechVoiceIdStreamPost({required String? voiceId, bool? enableLogging, int? optimizeStreamingLatency, V1SpeechToSpeechVoiceIdStreamPostOutputFormat? outputFormat, String? xiApiKey, required BodySpeechToSpeechStreamingV1SpeechToSpeechVoiceIdStreamPost body}) → Future<Response<String>>

Speech To Speech Streaming @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param enable_logging When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers. @param optimize_streaming_latency You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values: 0 - default mode (no latency optimizations) 1 - normal latency optimizations (about 50% of possible latency improvement of option 3) 2 - strong latency optimizations (about 75% of possible latency improvement of option 3) 3 - max latency optimizations 4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates). Defaults to None. @param output_format 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. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1SpeechToTextPost({bool? enableLogging, String? xiApiKey, required BodySpeechToTextV1SpeechToTextPost body}) → Future<Response<SpeechToTextChunkResponseModel>>

Speech To Text @param enable_logging When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioPodcastsPost({String? xiApiKey, required BodyCreatePodcastV1StudioPodcastsPost? body}) → Future<Response<PodcastProjectResponseModel>>

Create Podcast @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsGet({String? xiApiKey}) → Future<Response<GetProjectsResponseModel>>

List Studio Projects @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsPost({String? xiApiKey, required BodyCreateStudioProjectV1StudioProjectsPost body}) → Future<Response<AddProjectResponseModel>>

Create Studio Project @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdChaptersChapterIdConvertPost({required String? projectId, required String? chapterId, String? xiApiKey}) → Future<Response<ConvertChapterResponseModel>>

Convert Chapter @param project_id The ID of the Studio project. @param chapter_id The ID of the chapter. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdChaptersChapterIdDelete({required String? projectId, required String? chapterId, String? xiApiKey}) → Future<Response<DeleteChapterResponseModel>>

Delete Chapter @param project_id The ID of the Studio project. @param chapter_id The ID of the chapter. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdChaptersChapterIdGet({required String? projectId, required String? chapterId, String? xiApiKey}) → Future<Response<ChapterWithContentResponseModel>>

Get Chapter @param project_id The ID of the Studio project. @param chapter_id The ID of the chapter. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdChaptersChapterIdPost({required String? projectId, required String? chapterId, String? xiApiKey, required BodyUpdateChapterV1StudioProjectsProjectIdChaptersChapterIdPost? body}) → Future<Response<EditChapterResponseModel>>

Update Chapter @param project_id The ID of the Studio project. @param chapter_id The ID of the chapter. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdChaptersChapterIdSnapshotsChapterSnapshotIdGet({required String? projectId, required String? chapterId, required String? chapterSnapshotId, String? xiApiKey}) → Future<Response<ChapterSnapshotExtendedResponseModel>>

Get Chapter Snapshot @param project_id The ID of the Studio project. @param chapter_id The ID of the chapter. @param chapter_snapshot_id The ID of the chapter snapshot. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdChaptersChapterIdSnapshotsChapterSnapshotIdStreamPost({required String? projectId, required String? chapterId, required String? chapterSnapshotId, String? xiApiKey, required BodyStreamChapterAudioV1StudioProjectsProjectIdChaptersChapterIdSnapshotsChapterSnapshotIdStreamPost? body}) → Future<Response<String>>

Stream Chapter Audio @param project_id The ID of the Studio project. @param chapter_id The ID of the chapter. @param chapter_snapshot_id The ID of the chapter snapshot. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdChaptersChapterIdSnapshotsGet({required String? projectId, required String? chapterId, String? xiApiKey}) → Future<Response<ChapterSnapshotsResponseModel>>

List Chapter Snapshots @param project_id The ID of the Studio project. @param chapter_id The ID of the chapter. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdChaptersGet({required String? projectId, String? xiApiKey}) → Future<Response<GetChaptersResponseModel>>

List Chapters @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdChaptersPost({required String? projectId, String? xiApiKey, required BodyCreateChapterV1StudioProjectsProjectIdChaptersPost? body}) → Future<Response<AddChapterResponseModel>>

Create Chapter @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdContentPost({required String? projectId, String? xiApiKey, required BodyUpdateStudioProjectContentV1StudioProjectsProjectIdContentPost body}) → Future<Response<EditProjectResponseModel>>

Update Studio Project Content @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdConvertPost({required String? projectId, String? xiApiKey}) → Future<Response<ConvertProjectResponseModel>>

Convert Studio Project @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdDelete({required String? projectId, String? xiApiKey}) → Future<Response<DeleteProjectResponseModel>>

Delete Studio Project @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdGet({required String? projectId, String? xiApiKey}) → Future<Response<ProjectExtendedResponseModel>>

Get Studio Project @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdPost({required String? projectId, String? xiApiKey, required BodyUpdateStudioProjectV1StudioProjectsProjectIdPost? body}) → Future<Response<EditProjectResponseModel>>

Update Studio Project @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdPronunciationDictionariesPost({required String? projectId, String? xiApiKey, required BodyCreatePronunciationDictionariesV1StudioProjectsProjectIdPronunciationDictionariesPost? body}) → Future<Response<CreatePronunciationDictionaryResponseModel>>

Create Pronunciation Dictionaries @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdSnapshotsGet({required String? projectId, String? xiApiKey}) → Future<Response<ProjectSnapshotsResponseModel>>

List Studio Project Snapshots @param project_id The ID of the Studio project. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdSnapshotsProjectSnapshotIdArchivePost({required String? projectId, required String? projectSnapshotId, String? xiApiKey}) → Future<Response<String>>

Stream Archive With Studio Project Audio @param project_id The ID of the Studio project. @param project_snapshot_id The ID of the Studio project snapshot. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdSnapshotsProjectSnapshotIdGet({required String? projectId, required String? projectSnapshotId, String? xiApiKey}) → Future<Response<ProjectSnapshotExtendedResponseModel>>

Get Project Snapshot @param project_id The ID of the Studio project. @param project_snapshot_id The ID of the Studio project snapshot. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1StudioProjectsProjectIdSnapshotsProjectSnapshotIdStreamPost({required String? projectId, required String? projectSnapshotId, String? xiApiKey, required BodyStreamStudioProjectAudioV1StudioProjectsProjectIdSnapshotsProjectSnapshotIdStreamPost? body}) → Future<Response>

Stream Studio Project Audio @param project_id The ID of the Studio project. @param project_snapshot_id The ID of the Studio project snapshot. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1TextToSpeechVoiceIdPost({required String? voiceId, bool? enableLogging, int? optimizeStreamingLatency, V1TextToSpeechVoiceIdPostOutputFormat? outputFormat, String? xiApiKey, required BodyTextToSpeechV1TextToSpeechVoiceIdPost? body}) → Future<Response<String>>

Text To Speech @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param enable_logging When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers. @param optimize_streaming_latency You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values: 0 - default mode (no latency optimizations) 1 - normal latency optimizations (about 50% of possible latency improvement of option 3) 2 - strong latency optimizations (about 75% of possible latency improvement of option 3) 3 - max latency optimizations 4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates). Defaults to None. @param output_format 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. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1TextToSpeechVoiceIdStreamPost({required String? voiceId, bool? enableLogging, int? optimizeStreamingLatency, V1TextToSpeechVoiceIdStreamPostOutputFormat? outputFormat, String? xiApiKey, required BodyTextToSpeechStreamingV1TextToSpeechVoiceIdStreamPost? body}) → Future<Response<String>>

Text To Speech Streaming @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param enable_logging When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers. @param optimize_streaming_latency You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values: 0 - default mode (no latency optimizations) 1 - normal latency optimizations (about 50% of possible latency improvement of option 3) 2 - strong latency optimizations (about 75% of possible latency improvement of option 3) 3 - max latency optimizations 4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates). Defaults to None. @param output_format 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. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1TextToSpeechVoiceIdStreamWithTimestampsPost({required String? voiceId, bool? enableLogging, int? optimizeStreamingLatency, V1TextToSpeechVoiceIdStreamWithTimestampsPostOutputFormat? outputFormat, String? xiApiKey, required BodyTextToSpeechStreamingWithTimestampsV1TextToSpeechVoiceIdStreamWithTimestampsPost? body}) → Future<Response<StreamingAudioChunkWithTimestampsResponseModel>>

Text To Speech Streaming With Timestamps @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param enable_logging When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers. @param optimize_streaming_latency You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values: 0 - default mode (no latency optimizations) 1 - normal latency optimizations (about 50% of possible latency improvement of option 3) 2 - strong latency optimizations (about 75% of possible latency improvement of option 3) 3 - max latency optimizations 4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates). Defaults to None. @param output_format 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. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1TextToSpeechVoiceIdWithTimestampsPost({required String? voiceId, bool? enableLogging, int? optimizeStreamingLatency, V1TextToSpeechVoiceIdWithTimestampsPostOutputFormat? outputFormat, String? xiApiKey, required BodyTextToSpeechWithTimestampsV1TextToSpeechVoiceIdWithTimestampsPost? body}) → Future<Response<AudioWithTimestampsResponseModel>>

Text To Speech With Timestamps @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param enable_logging When enable_logging is set to false zero retention mode will be used for the request. This will mean history features are unavailable for this request, including request stitching. Zero retention mode may only be used by enterprise customers. @param optimize_streaming_latency You can turn on latency optimizations at some cost of quality. The best possible final latency varies by model. Possible values: 0 - default mode (no latency optimizations) 1 - normal latency optimizations (about 50% of possible latency improvement of option 3) 2 - strong latency optimizations (about 75% of possible latency improvement of option 3) 3 - max latency optimizations 4 - max latency optimizations, but also with text normalizer turned off for even more latency savings (best latency, but can mispronounce eg numbers and dates). Defaults to None. @param output_format 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. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1TextToVoiceCreatePreviewsPost({V1TextToVoiceCreatePreviewsPostOutputFormat? outputFormat, String? xiApiKey, required VoicePreviewsRequestModel? body}) → Future<Response<VoicePreviewsResponseModel>>

Generate A Voice Preview From Description @param output_format 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. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1TextToVoiceCreateVoiceFromPreviewPost({String? xiApiKey, required BodyCreateANewVoiceFromVoicePreviewV1TextToVoiceCreateVoiceFromPreviewPost? body}) → Future<Response<VoiceResponseModel>>

Create A New Voice From Voice Preview @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1UsageCharacterStatsGet({required int? startUnix, required int? endUnix, bool? includeWorkspaceMetrics, BreakdownTypes? breakdownType, UsageAggregationInterval? aggregationInterval, MetricType? metric, String? xiApiKey}) → Future<Response<UsageCharactersResponseModel>>

Get Characters Usage Metrics @param start_unix UTC Unix timestamp for the start of the usage window, in milliseconds. To include the first day of the window, the timestamp should be at 00:00:00 of that day. @param end_unix UTC Unix timestamp for the end of the usage window, in milliseconds. To include the last day of the window, the timestamp should be at 23:59:59 of that day. @param include_workspace_metrics Whether or not to include the statistics of the entire workspace. @param breakdown_type How to break down the information. Cannot be "user" if include_workspace_metrics is False. @param aggregation_interval How to aggregate usage data over time. Can be "hour", "day", "week", "month", or "cumulative". @param metric Which metric to aggregate. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1UserGet({String? xiApiKey}) → Future<Response<UserResponseModel>>

Get User Info @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1UserSubscriptionGet({String? xiApiKey}) → Future<Response<ExtendedSubscriptionResponseModel>>

Get User Subscription Info @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoiceGenerationCreateVoicePost({String? xiApiKey, required BodyCreateAPreviouslyGeneratedVoiceV1VoiceGenerationCreateVoicePost? body}) → Future<Response<VoiceResponseModel>>

Create A Previously Generated Voice @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoiceGenerationGenerateVoiceParametersGet() → Future<Response<VoiceGenerationParameterResponseModel>>

Voice Generation Parameters

v1VoiceGenerationGenerateVoicePost({String? xiApiKey, required BodyGenerateARandomVoiceV1VoiceGenerationGenerateVoicePost? body}) → Future<Response>

Generate A Random Voice @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesAddPost({String? xiApiKey, required BodyAddVoiceV1VoicesAddPost body}) → Future<Response<AddVoiceIVCResponseModel>>

Add Voice @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesAddPublicUserIdVoiceIdPost({required String? publicUserId, required String? voiceId, String? xiApiKey, required BodyAddSharedVoiceV1VoicesAddPublicUserIdVoiceIdPost? body}) → Future<Response<AddVoiceResponseModel>>

Add Shared Voice @param public_user_id Public user ID used to publicly identify ElevenLabs users. @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesGet({bool? showLegacy, String? xiApiKey}) → Future<Response<GetVoicesResponseModel>>

List Voices @param show_legacy If set to true, legacy premade voices will be included in responses from /v1/voices @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesPvcPost({String? xiApiKey, required BodyCreatePVCVoiceV1VoicesPvcPost? body}) → Future<Response<AddVoiceResponseModel>>

Create Pvc Voice @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesPvcVoiceIdCaptchaGet({required String? voiceId, String? xiApiKey}) → Future<Response>

Get Pvc Voice Captcha @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesPvcVoiceIdCaptchaPost({required String? voiceId, String? xiApiKey, required BodyVerifyPVCVoiceCaptchaV1VoicesPvcVoiceIdCaptchaPost body}) → Future<Response<VerifyPVCVoiceCaptchaResponseModel>>

Verify Pvc Voice Captcha @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesPvcVoiceIdPost({required String? voiceId, String? xiApiKey, required BodyEditPVCVoiceV1VoicesPvcVoiceIdPost? body}) → Future<Response<AddVoiceResponseModel>>

Edit Pvc Voice @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesPvcVoiceIdSamplesPost({required String? voiceId, String? xiApiKey, required BodyAddSamplesToPVCVoiceV1VoicesPvcVoiceIdSamplesPost body}) → Future<Response<List<SampleResponseModel>>>

Add Samples To Pvc Voice @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesPvcVoiceIdSamplesSampleIdAudioGet({required String? voiceId, required String? sampleId, String? xiApiKey, required BodyRetrieveVoiceSampleAudioV1VoicesPvcVoiceIdSamplesSampleIdAudioGet? body}) → Future<Response<VoiceSamplePreviewResponseModel>>

Retrieve Voice Sample Audio @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param sample_id Sample ID to be used @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesPvcVoiceIdSamplesSampleIdDelete({required String? voiceId, required String? sampleId, String? xiApiKey}) → Future<Response<DeleteVoiceSampleResponseModel>>

Delete Pvc Voice Sample @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param sample_id Sample ID to be used @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesPvcVoiceIdSamplesSampleIdPost({required String? voiceId, required String? sampleId, String? xiApiKey, required BodyUpdatePVCVoiceSampleV1VoicesPvcVoiceIdSamplesSampleIdPost? body}) → Future<Response<AddVoiceResponseModel>>

Update Pvc Voice Sample @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param sample_id Sample ID to be used @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesPvcVoiceIdSamplesSampleIdSeparateSpeakersPost({required String? voiceId, required String? sampleId, String? xiApiKey}) → Future<Response<StartSpeakerSeparationResponseModel>>

Start Speaker Separation @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param sample_id Sample ID to be used @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesPvcVoiceIdSamplesSampleIdSpeakersGet({required String? voiceId, required String? sampleId, String? xiApiKey}) → Future<Response<SpeakerSeparationResponseModel>>

Retrieve Speaker Separation Status @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param sample_id Sample ID to be used @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesPvcVoiceIdSamplesSampleIdSpeakersSpeakerIdAudioGet({required String? voiceId, required String? sampleId, required String? speakerId, String? xiApiKey}) → Future<Response<SpeakerAudioResponseModel>>

Retrieve Separated Speaker Audio @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param sample_id Sample ID to be used @param speaker_id Speaker ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id}/samples/{sample_id}/speakers to list all the available speakers for a sample. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesPvcVoiceIdSamplesSampleIdWaveformGet({required String? voiceId, required String? sampleId, String? xiApiKey}) → Future<Response<VoiceSampleVisualWaveformResponseModel>>

Retrieve Voice Sample Visual Waveform @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param sample_id Sample ID to be used @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesPvcVoiceIdTrainPost({required String? voiceId, String? xiApiKey, required BodyRunPVCTrainingV1VoicesPvcVoiceIdTrainPost? body}) → Future<Response<StartPVCVoiceTrainingResponseModel>>

Run Pvc Training @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesPvcVoiceIdVerificationPost({required String? voiceId, String? xiApiKey, required BodyRequestManualVerificationV1VoicesPvcVoiceIdVerificationPost body}) → Future<Response<RequestPVCManualVerificationResponseModel>>

Request Manual Verification @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesSettingsDefaultGet() → Future<Response<VoiceSettingsResponseModel>>

Get Default Voice Settings.

v1VoicesVoiceIdDelete({required String? voiceId, String? xiApiKey}) → Future<Response<DeleteVoiceResponseModel>>

Delete Voice @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesVoiceIdEditPost({required String? voiceId, String? xiApiKey, required BodyEditVoiceV1VoicesVoiceIdEditPost body}) → Future<Response<EditVoiceResponseModel>>

Edit Voice @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesVoiceIdGet({required String? voiceId, bool? withSettings, String? xiApiKey}) → Future<Response<VoiceResponseModel>>

Get Voice @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param with_settings This parameter is now deprecated. It is ignored and will be removed in a future version. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesVoiceIdSamplesSampleIdAudioGet({required String? voiceId, required String? sampleId, String? xiApiKey}) → Future<Response>

Get Audio From Sample @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param sample_id Sample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id} to list all the available samples for a voice. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesVoiceIdSamplesSampleIdDelete({required String? voiceId, required String? sampleId, String? xiApiKey}) → Future<Response<DeleteSampleResponseModel>>

Delete Sample @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param sample_id Sample ID to be used, you can use GET https://api.elevenlabs.io/v1/voices/{voice_id} to list all the available samples for a voice. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesVoiceIdSettingsEditPost({required String? voiceId, String? xiApiKey, required VoiceSettingsResponseModel? body}) → Future<Response<EditVoiceSettingsResponseModel>>

Edit Voice Settings @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1VoicesVoiceIdSettingsGet({required String? voiceId, String? xiApiKey}) → Future<Response<VoiceSettingsResponseModel>>

Get Voice Settings @param voice_id Voice ID to be used, you can use https://api.elevenlabs.io/v1/voices to list all the available voices. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1WorkspaceGroupsGroupIdMembersPost({required String? groupId, String? xiApiKey, required BodyAddMemberToUserGroupV1WorkspaceGroupsGroupIdMembersPost? body}) → Future<Response<AddWorkspaceGroupMemberResponseModel>>

Add Member To User Group @param group_id The ID of the target group. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1WorkspaceGroupsGroupIdMembersRemovePost({required String? groupId, String? xiApiKey, required BodyDeleteMemberFromUserGroupV1WorkspaceGroupsGroupIdMembersRemovePost? body}) → Future<Response<DeleteWorkspaceGroupMemberResponseModel>>

Delete Member From User Group @param group_id The ID of the target group. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1WorkspaceGroupsSearchGet({required String? name, String? xiApiKey}) → Future<Response<List<WorkspaceGroupByNameResponseModel>>>

Search User Groups @param name Name of the target group. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1WorkspaceInvitesAddBulkPost({String? xiApiKey, required BodyInviteMultipleUsersV1WorkspaceInvitesAddBulkPost? body}) → Future<Response<AddWorkspaceInviteResponseModel>>

Invite Multiple Users @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1WorkspaceInvitesAddPost({String? xiApiKey, required BodyInviteUserV1WorkspaceInvitesAddPost? body}) → Future<Response<AddWorkspaceInviteResponseModel>>

Invite User @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1WorkspaceInvitesDelete({String? xiApiKey, required BodyDeleteExistingInvitationV1WorkspaceInvitesDelete? body}) → Future<Response<DeleteWorkspaceInviteResponseModel>>

Delete Existing Invitation @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1WorkspaceMembersDelete({required BodyDeleteMemberV1WorkspaceMembersDelete? body}) → Future<Response<DeleteWorkspaceMemberResponseModel>>

Delete Member

v1WorkspaceMembersPost({String? xiApiKey, required BodyUpdateMemberV1WorkspaceMembersPost? body}) → Future<Response<UpdateWorkspaceMemberResponseModel>>

Update Member @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1WorkspaceResourcesResourceIdGet({required String? resourceId, required WorkspaceResourceType? resourceType, String? xiApiKey}) → Future<Response<ResourceMetadataResponseModel>>

Get Resource @param resource_id The ID of the target resource. @param resource_type Resource type of the target resource. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1WorkspaceResourcesResourceIdSharePost({required String? resourceId, String? xiApiKey, required BodyShareWorkspaceResourceV1WorkspaceResourcesResourceIdSharePost? body}) → Future<Response>

Share Workspace Resource @param resource_id The ID of the target resource. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v1WorkspaceResourcesResourceIdUnsharePost({required String? resourceId, String? xiApiKey, required BodyUnshareWorkspaceResourceV1WorkspaceResourcesResourceIdUnsharePost? body}) → Future<Response>

Unshare Workspace Resource @param resource_id The ID of the target resource. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

v2VoicesGet({String? nextPageToken, int? pageSize, String? search, String? sort, String? sortDirection, String? voiceType, String? category, String? fineTuningState, String? collectionId, bool? includeTotalCount, String? xiApiKey}) → Future<Response<GetVoicesV2ResponseModel>>

Get Voices V2 @param next_page_token The next page token to use for pagination. Returned from the previous request. @param page_size How many voices to return at maximum. Can not exceed 100, defaults to 10. Page 0 may include more voices due to default voices being included. @param search Search term to filter voices by. Searches in name, description, labels, category. @param sort Which field to sort by, one of 'created_at_unix' or 'name'. 'created_at_unix' may not be available for older voices. @param sort_direction Which direction to sort the voices in. 'asc' or 'desc'. @param voice_type Type of the voice to filter by. One of 'personal', 'community', 'default', 'workspace', 'non-default'. 'non-default' is equal to 'personal' plus 'community'. @param category Category of the voice to filter by. One of 'premade', 'cloned', 'generated', 'professional' @param fine_tuning_state State of the voice's fine tuning to filter by. Applicable only to professional voices clones. One of 'draft', 'not_verified', 'not_started', 'queued', 'fine_tuning', 'fine_tuned', 'failed', 'delayed' @param collection_id Collection ID to filter voices by. @param include_total_count Whether to include the total count of voices found in the response. Incurs a performance cost. @param xi-api-key Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

create({ChopperClient? client, Client? httpClient, Authenticator? authenticator, ErrorConverter? errorConverter, Converter? converter, Uri? baseUrl, List<Interceptor>? interceptors}) → ElevenlabsOpenapi