Overview

Create Character Preview

Starts generating a short preview of how a listener's own voice sounds in a chosen character's part, so they can hear the result before spending one of their story credits. Rendering happens in the background and this call returns a job identifier immediately rather than audio.

Use this when: the listener has picked a character and a voice and wants to try it out. Poll Get Character Preview with the returned job ID to collect the audio once it is ready.

Security Model

oAuth

Header Parameters

Authorizationstring Required

Access token issued by Tuned Global for authorization using oAuth 2.0

StoreIdstring Required

API Key provided by Tuned Global for accessing the service

Path Parameters

albumIdstring Required

The story album to work from. It must have character stems configured.

Body Parameters

CharacterStemIdnumber

VoiceIdstring

Response

200

Object

A job identifier you pass to Get Character Preview to poll for the finished audio.

400

Object

The preview could not be queued - typically an unknown stem or voice, or the listener has no preview allowance left.

Sections

Create Character Preview

Security Model

Header Parameters

Path Parameters

Body Parameters

Response

Response