Voices

Delete one of your library voices.

Deletes a voice from your library and at its provider. A voice still pinned in a cast canon or spoken in a read (the read behind a share link) is refused with 409 voice_in_use, details.uses naming every use; send the delete again with confirmed: true (?confirmed=true, or a JSON body) to delete it anyway — those characters then have no voice until they are recast. Free. Scope: story:write.

delete/voices/{voiceId}

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/voices/{voiceId}
  • Auth: HTTP bearer

Query parameters

confirmedboolean

Delete a voice that is still in use.

Response

Deleted.

deletedtrue required
voiceIdstring required
namestring required

Changes

No recorded changes to this operation across all 1 revision of this API.