Get history item

Retrieves a history item.

Path parameters

history_item_idstringRequired

ID of the history item to be used. You can use the Get generated items endpoint to retrieve a list of history items.

Headers

xi-api-keystringRequired

Response

Successful Response

history_item_idstring

The ID of the history item.

voice_idstring

The ID of the voice used.

voice_namestring

The name of the voice.

textstring

The text used to generate the audio item.

date_unixinteger

Unix timestamp of when the item was created.

character_count_change_frominteger

The character count change from.

character_count_change_tointeger

The character count change to.

content_typestring

The content type of the generated item.

stateenum

The state of the history item.

Allowed values:
request_idstringOptional

The ID of the request.

model_idstringOptional

The ID of the model.

voice_categoryenumOptional

The category of the voice. Either ‘premade’, ‘cloned’, ‘generated’ or ‘professional’.

Allowed values:
settingsmap from strings to anyOptional

The settings of the history item.

feedbackobjectOptional

Feedback associated with the generated item. Returns null if no feedback has been provided.

sourceenumOptional

The source of the history item. Either TTS (text to speech), STS (speech to text) or STT (speech to text).

Allowed values:
alignmentsobjectOptional

The alignments of the history item.

Errors