Projects

Pin an existing voice on one person of the project cast, in an episode or not.

Pins voiceId (with voiceName, provider and gender, each read from your voice library when omitted) on the cast canon entry of character — by canon name, alias or script cue — anyone on the project cast, including a person no screenplay names yet whom a deck or trailer gives a line. Every new episode, deck, trailer and showcase speaks them with it, and an episode that later names them inherits it instead of casting a second one. A Series Bible character the canon does not hold yet is added to it. Never changes a read: reads lists the finished table reads that still speak this person with another voice — re-voice them with POST /artifacts/{artifactId}/revoice (priced). previous is the canon voice it replaced; set it again to go back. A NEW voice from a description is POST .../cast-voice/design (priced) then POST .../cast-voice/choose. Refused with 409 voice_retired for a voice on a provider that is retiring its voices, and 404 character_not_found when nobody in the cast canon or Series Bible answers to character. Free. Scope: story:write.

patch/story-projects/{projectId}/cast-voice

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/story-projects/{projectId}/cast-voice
  • Auth: HTTP bearer

Request body

characterstring required

The person: canon name, alias or script cue. Anyone on the project cast, in an episode or not; a Series Bible character the canon does not hold yet is added.

voiceIdstring required

The voice to pin, by its id at its provider (GET /voices lists yours).

voiceNamestring

The name the voice is shown under. Default: your voice library's name for it.

provider'cartesia' | 'elevenlabs' | 'openai' | 'deepgram' | 'hume'

The provider that speaks the voice. Default: the library's, else the configured one. A provider retiring its voices is refused.

genderstring

Response

The voice pinned, what it replaced, and the reads still on another voice.

projectIdstring required
characterstring required

The cast canon person the voice is pinned on.

changedboolean required

False when the person already had this voice: nothing was written.

notestring required

Changes

No recorded changes to this operation across all 2 revisions of this API.