autessa.voice
Voice cloning and voice client configuration.
autessa.voice.deepClone.createDatasetMUTATE
autessa.voice.deepClone.createDataset({ voiceName })Start a deep voice clone by creating its training dataset; the first step of the deep-clone lifecycle.
Creates a new deep voice clone in PENDING state with an empty dataset. Only voiceName is required. Your company must have voice fine-tuning enabled. Next: upload audio with voice.deepClone.uploadFiles, then voice.deepClone.startFinetune, then poll voice.deepClone.getStatus until COMPLETED.
Request fields
- Name
voiceName- Type
- string
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
voiceCloneId- Type
- string (opaque id)
- Description
- References instant voice clone by opaque id.
- Name
datasetId- Type
- string
- Description
autessa.voice.deepClone.deleteMUTATE
autessa.voice.deepClone.delete({ deepVoiceCloneId })Permanently delete a deep voice clone.
Irreversible. Requires ADMIN access (owner-level). Any agent voice configuration still referencing this clone's serviceVoiceId will no longer resolve.
Request fields
- Name
deepVoiceCloneId- Type
- string (opaque id)
- Description
- References deep voice clone by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
autessa.voice.deepClone.getREAD
autessa.voice.deepClone.get({ deepVoiceCloneId })Fetch a deep clone's current training status and progress by id (identical response to getStatus).
Returns the same status/progress/serviceVoiceId shape as voice.deepClone.getStatus, and like it advances a TRAINING job when polled. Requires READ access. Use voice.deepClone.getSharingDetails for the clone's sharing configuration.
Request fields
- Name
deepVoiceCloneId- Type
- string (opaque id)
- Description
- References deep voice clone by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
status- Type
- "PENDING" | "UPLOADING" | "TRAINING" | "COMPLETED" | "FAILED"
- Description
- Name
progress- Type
- number
- Description
- Name
serviceVoiceId- Type
- string
- Description
autessa.voice.deepClone.getAllREAD
autessa.voice.deepClone.getAll()List every deep voice clone you can access in the current company, split by how you got access.
Returns your accessible deep clones in three buckets: clones you own, clones shared company-wide, and clones shared specifically with you. Not paginated. Each summary carries training status and progress.
Request fields
No fields.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
ownedClones- Type
- DeepVoiceCloneSummary[]
- Description
- Name
companySharedClones- Type
- DeepVoiceCloneSummary[]
- Description
- Name
sharedWithMeClones- Type
- DeepVoiceCloneSummary[]
- Description
autessa.voice.deepClone.getSharingDetailsREAD
autessa.voice.deepClone.getSharingDetails({ deepVoiceCloneId })Get a deep clone's sharing configuration: sharing level, company permission, per-user grants, and your access level.
Read-only view of exactly what voice.deepClone.share would modify. Requires READ.
Request fields
- Name
deepVoiceCloneId- Type
- string (opaque id)
- Description
- References deep voice clone by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
sharingLevel- Type
- "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
- Description
- Name
companyPermissionLevel- Type
- "READ" | "WRITE" | "PUBLISH" | "ADMIN"
- Description
- Name
sharedWith- Type
- UserShareWrapper[]
- Description
- Name
userAccessLevel- Type
- "READ" | "WRITE" | "PUBLISH" | "ADMIN"
- Description
autessa.voice.deepClone.getStatusREAD
autessa.voice.deepClone.getStatus({ deepVoiceCloneId })Poll a deep clone's training status and progress; returns the usable serviceVoiceId once COMPLETED.
Returns status (PENDING, UPLOADING, TRAINING, COMPLETED, FAILED) and a 0-100 progress percentage. Requires READ access. Polling contract: once COMPLETED or FAILED the values are cached and returned immediately; while TRAINING this call also advances the job by checking the training backend live. On COMPLETED, serviceVoiceId is populated and progress is 100 — select it as an agent voice. A background job also finishes the clone even if you stop polling. There is no server-imposed poll rate limit; polling every few seconds to a minute is reasonable.
Request fields
- Name
deepVoiceCloneId- Type
- string (opaque id)
- Description
- References deep voice clone by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
status- Type
- "PENDING" | "UPLOADING" | "TRAINING" | "COMPLETED" | "FAILED"
- Description
- Name
progress- Type
- number
- Description
- Name
serviceVoiceId- Type
- string
- Description
autessa.voice.deepClone.startFinetuneMUTATE
autessa.voice.deepClone.startFinetune({ deepVoiceCloneId })Kick off the fine-tune training job for a deep clone whose dataset is ready.
Starts training from the uploaded dataset and moves the clone to TRAINING, returning the fine-tune job id. Requires WRITE (or ADMIN) access; the dataset must already exist (from createDataset + uploadFiles). On failure the clone goes FAILED. Poll voice.deepClone.getStatus until COMPLETED to get the usable serviceVoiceId.
Request fields
- Name
deepVoiceCloneId- Type
- string (opaque id)
- Description
- References deep voice clone by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
fineTuneJobId- Type
- string
- Description
autessa.voice.deepClone.uploadFilesMUTATE
autessa.voice.deepClone.uploadFiles({ deepVoiceCloneId, audioS3Uris })Add uploaded audio files to a deep clone's training dataset; callable repeatedly to build up the dataset.
Adds each s3:// URI in audioS3Uris to the deep clone's dataset (upload the bytes first via voice.generateAudioUploadLink). Sets the clone to UPLOADING; on failure the clone goes FAILED. Requires WRITE (or ADMIN) access. Call once per batch until the dataset is complete, then start training with voice.deepClone.startFinetune.
Request fields
- Name
deepVoiceCloneId- Type
- string (opaque id)
- Description
- References deep voice clone by opaque id.
- Name
audioS3Uris- Type
- string[]
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
filesUploaded- Type
- number
- Description
autessa.voice.generateAudioUploadLinkMUTATE
autessa.voice.generateAudioUploadLink()Generate a presigned S3 PUT URL for uploading a WAV audio sample; PUT the bytes, then pass the returned s3Uri into an instant or deep clone.
Takes no arguments. The URL expires in 600 seconds and targets temporary storage — upload and use the s3Uri promptly (for voice.instantClone.create's audioS3Uri or voice.deepClone.uploadFiles' audioS3Uris).
Request fields
No fields.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
uploadUrl- Type
- string
- Description
- Name
s3Uri- Type
- string
- Description
- Name
expiresInSeconds- Type
- number
- Description
autessa.voice.instantClone.createMUTATE
autessa.voice.instantClone.create({ voiceName, audioS3Uri })Create an instant voice clone from a single audio sample; usable immediately.
Clones a voice in one call from the WAV at audioS3Uri (upload it first via voice.generateAudioUploadLink). voiceName and audioS3Uri are required. The clone is created PRIVATE and owned by you; its serviceVoiceId is returned and can immediately be selected as an agent voice. Your company must have voice cloning enabled, else the call errors.
Request fields
- Name
voiceName- Type
- string
- Description
- Name
audioS3Uri- Type
- string
- Description
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
voiceCloneId- Type
- string (opaque id)
- Description
- References instant voice clone by opaque id.
- Name
voiceName- Type
- string
- Description
- Name
serviceVoiceId- Type
- string
- Description
autessa.voice.instantClone.deleteMUTATE
autessa.voice.instantClone.delete({ instantVoiceCloneId })Permanently delete an instant voice clone.
Irreversible. Requires ADMIN access (owner-level). Any agent voice configuration still referencing this clone's serviceVoiceId will no longer resolve.
Request fields
- Name
instantVoiceCloneId- Type
- string (opaque id)
- Description
- References instant voice clone by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
autessa.voice.instantClone.getREAD
autessa.voice.instantClone.get({ instantVoiceCloneId })Fetch one instant voice clone by id, including its sharing configuration and your access level.
Requires READ access on the clone. Returns the clone's name, synthesis voice id, sharing level and your effective access level.
Request fields
- Name
instantVoiceCloneId- Type
- string (opaque id)
- Description
- References instant voice clone by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
voiceCloneId- Type
- string (opaque id)
- Description
- References instant voice clone by opaque id.
- Name
voiceName- Type
- string
- Description
- Name
serviceVoiceId- Type
- string
- Description
- Name
sharingLevel- Type
- "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
- Description
- Name
companyPermissionLevel- Type
- "READ" | "WRITE" | "PUBLISH" | "ADMIN"
- Description
- Name
userAccessLevel- Type
- "READ" | "WRITE" | "PUBLISH" | "ADMIN"
- Description
- Name
createdAt- Type
- string (ISO 8601)
- Description
autessa.voice.instantClone.getAllREAD
autessa.voice.instantClone.getAll()List every instant voice clone you can access in the current company, split by how you got access.
Returns your accessible instant clones in three buckets: clones you own, clones shared company-wide, and clones shared specifically with you. Not paginated.
Request fields
No fields.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
ownedClones- Type
- VoiceCloneSummary[]
- Description
- Name
companySharedClones- Type
- VoiceCloneSummary[]
- Description
- Name
sharedWithMeClones- Type
- VoiceCloneSummary[]
- Description
autessa.voice.instantClone.getSharingDetailsREAD
autessa.voice.instantClone.getSharingDetails({ instantVoiceCloneId })Get an instant clone's sharing configuration: sharing level, company permission, per-user grants, and your access level.
Read-only view of exactly what voice.instantClone.share would modify. Requires READ.
Request fields
- Name
instantVoiceCloneId- Type
- string (opaque id)
- Description
- References instant voice clone by opaque id.
Response fields
- Name
errors- Type
- string[]
- Description
- Name
deprecationWarnings- Type
- string[]
- Description
- Name
sessionToken- Type
- string
- Description
- Name
sharingLevel- Type
- "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
- Description
- Name
companyPermissionLevel- Type
- "READ" | "WRITE" | "PUBLISH" | "ADMIN"
- Description
- Name
sharedWith- Type
- UserShareWrapper[]
- Description
- Name
userAccessLevel- Type
- "READ" | "WRITE" | "PUBLISH" | "ADMIN"
- Description