Artifacts

Restore a character's previous voice on a table read artifact.

Undoes the newest recast of character (or of any character when omitted): the previous voice comes back with the recording the read had before the recast — its voices-only track, and the finished mix and video while they still match — and the cast canon voice when the canon still holds the one the recast pinned. Free. Restoring again returns to the voice this restore replaced. GET /artifacts/{artifactId}/cast lists what is restorable (restorable). 409 cast_voice_precondition_failed when the character has not been recast on this read. Requires Idempotency-Key. Scope: artifact:publish.

post/artifacts/{artifactId}/voice/restore

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/artifacts/{artifactId}/voice/restore
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Customer-generated stable identifier for safe retries of idempotent POST requests.

Request body

characterstring

The character to restore. Omitted: the newest recast of any character.

Response

The previous voice and what came back with it.

artifactIdstring required
characterstring required
voiceobject nullable required

The voice the character speaks with now; null when it had none before the recast.

voiceMapobject required
recordingRestoredboolean required

The read's voices-only track came back.

finishedMixRestoredboolean required

The finished MP3 came back; no new finalize is needed.

videoRestoredboolean required

The rendered video came back (only while the share link still holds that render).

canonRestoredboolean required

The cast canon voice came back (only while the canon still held the voice the recast pinned).

Changes

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