Skip to main content
PATCH
/
v3
/
voices
/
{id}
Update an Equos Voice.
curl --request PATCH \
  --url https://api.equos.ai/v3/voices/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "client": "<string>",
  "instructions": "<string>"
}
'
{
  "id": "<string>",
  "organizationId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "client": "<string>",
  "instructions": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

Equos Voice ID

Body

application/json
​
identity
enum<string>
required
Available options:
Puck,
Charon,
Kore,
Fenrir,
Aoede,
Leda,
Orus,
Zephyr,
Sulafat,
Sadachbia,
Sadaltager,
Vindemiatrix,
Zubenelgenubi,
Achird,
Pulcherrima,
Gacrux,
Schedar,
Alnilam,
Achernar,
Laomedeia,
Rasalgethi,
Algenib,
Erinome,
Despina,
Algieba,
Umbriel,
Iapetus,
Enceladus,
Autonoe,
Callirrhoe
​
client
string | null

Client identifier associated with the voice. This is useful to segment resources by client.

​
instructions
string | null

Instructions for the voice such as tone, rythm, etc.

Response

200 - application/json
​
id
string
required
​
organizationId
string
required
​
identity
enum<string>
required
Available options:
Puck,
Charon,
Kore,
Fenrir,
Aoede,
Leda,
Orus,
Zephyr,
Sulafat,
Sadachbia,
Sadaltager,
Vindemiatrix,
Zubenelgenubi,
Achird,
Pulcherrima,
Gacrux,
Schedar,
Alnilam,
Achernar,
Laomedeia,
Rasalgethi,
Algenib,
Erinome,
Despina,
Algieba,
Umbriel,
Iapetus,
Enceladus,
Autonoe,
Callirrhoe
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
client
string | null
​
instructions
string | null