Overview

Register Voice

Registers a voice the listener has trained, giving it a display name and a profile image so it can be picked from a list when they create a story. The voice model itself is trained with the third-party voice provider first; this call records it against the listener's account and returns the internal ID the voice-story endpoints use.

The request is multipart/form-data, not JSON.

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

Body Parameters

voiceId (text, required) el_7Kd91LqZ string

name (text, required) Ada's reading voice string

profileImage (file, required) ada-voice.jpgstring

Response

200

Object

The call was successful.

400

Object

One of the three parts is missing or empty. The body names which one, for example "Voice id is not provided." - surface it, as the parts are easy to mis-name in a multipart request.

415

Object

The request was not multipart/form-data, or the profile image is not an allowed image type.

Sections

Register Voice

Security Model

Header Parameters

Body Parameters

Response

Response