ADMINISTRATIONHistory

Get generated items

Returns a list of your generated audio.

Headers

xi-api-keystringRequired

Query parameters

page_sizeintegerOptionalDefaults to 100
How many history items to return at maximum. Can not exceed 1000, defaults to 100.
start_after_history_item_idstring or nullOptional
After which ID to start fetching, use this parameter to paginate across a large collection of history items. In case this parameter is not provided history items will be fetched starting from the most recently created one ordered descending by their creation date.
voice_idstring or nullOptional

ID of the voice to be filtered for. You can use the Get voices endpoint list all the available voices.

model_idstring or nullOptional
Search term used for filtering history items. If provided, source becomes required.
date_before_unixinteger or nullOptional

Unix timestamp to filter history items before this date (exclusive).

date_after_unixinteger or nullOptional

Unix timestamp to filter history items after this date (inclusive).

sort_directionenum or nullOptionalDefaults to desc
Sort direction for the results.
Allowed values:
searchstring or nullOptional
search term used for filtering
sourceenum or nullOptional
Source of the generated history item
Allowed values:

Response

Successful Response
historylist of objects
A list of speech history items.
has_moreboolean
Whether there are more history items to fetch.
last_history_item_idstring or null
The ID of the last history item.
scanned_untilinteger or null
The timestamp of the last history item.

Errors