Update voice

voices.update(id: str, **kwargs: VoiceUpdateParams) -> VoiceUpdateResponse

PUT

/v1/ai/voice/{id}

Updates metadata for a specific voice. Only provided fields will be changed.

Parameters

id

str

required

The id of the voice, which can be retrieved by a call to List voices.

description

Optional[str]

A description of this voice.

gender

Optional[str]

A tag describing the gender of this voice, e.g. male, female, nonbinary.

name

Optional[str]

The display name for this voice.

starred

Optional[bool]

If true, adds this voice to your starred list.

tags

Optional[Iterable[str]]

Replaces the tags attached to this voice with the given list.

Returns

class VoiceUpdateResponse: …

PUT

Update voice

import asyncio
import os

from lmnt import AsyncLmnt

async def main():
  client = AsyncLmnt(
    api_key=os.environ.get('LMNT_API_KEY'),  # This is the default and can be omitted
  )
  response = await client.voices.update(
    id='9c4a8f2b3e1d7c40',
    name='renamed-voice',
  )
  print(response)

asyncio.run(main())

Response 200

VoiceUpdateResponse(
    voice=Voice(
        id='9c4a8f2b3e1d7c40',
        name='renamed-voice',
        owner='me',
        state='ready',
        description=None,
        gender='U',
        preview_url='https://api.lmnt.com/v1/ai/voice/9c4a8f2b3e1d7c40/preview',
        starred=False,
        type='instant',
    ),
)