Get generated items | ElevenLabs Documentation

from elevenlabs import ElevenLabs
from elevenlabs.environment import ElevenLabsEnvironment
client = ElevenLabs(
    environment=ElevenLabsEnvironment.PRODUCTION
)
client.history.list(
    page_size=1,
    start_after_history_item_id="start_after_history_item_id",
    voice_id="voice_id",
    model_id="model_id",
    date_before_unix=1,
    date_after_unix=1,
    sort_direction="asc",
    search="search",
    source="TTS"
)

{
  "history": [
    {
      "history_item_id": "ja9xsmfGhxYcymxGcOGB",
      "date_unix": 1714650306,
      "character_count_change_from": 17189,
      "character_count_change_to": 17231,
      "content_type": "audio/mpeg",
      "state": "created",
      "request_id": "BF0BZg4IwLGBlaVjv9Im",
      "voice_id": "21m00Tcm4TlvDq8ikWAM",
      "model_id": "eleven_multilingual_v2",
      "voice_name": "Rachel",
      "voice_category": "premade",
      "text": "Hello, world!",
      "settings": {
        "similarity_boost": 0.5,
        "stability": 0.71,
        "style": 0,
        "use_speaker_boost": true
      },
      "feedback": {
        "thumbs_up": true,
        "feedback": "This is an example of test feedback.",
        "emotions": true,
        "inaccurate_clone": false,
        "glitches": true,
        "audio_quality": true,
        "other": false,
        "review_status": "not_reviewed"
      },
      "share_link_id": "share_link_id",
      "source": "TTS",
      "alignments": {
        "alignment": {
          "characters": [
            "characters"
          ],
          "character_start_times_seconds": [
            1.1
          ],
          "character_end_times_seconds": [
            1.1
          ]
        },
        "normalized_alignment": {
          "characters": [
            "characters"
          ],
          "character_start_times_seconds": [
            1.1
          ],
          "character_end_times_seconds": [
            1.1
          ]
        }
      },
      "dialogue": [
        {
          "text": "text",
          "voice_id": "voice_id",
          "voice_name": "voice_name"
        }
      ]
    }
  ],
  "has_more": true,
  "last_history_item_id": "ja9xsmfGhxYcymxGcOGB",
  "scanned_until": 1714650306
}

Returns a list of your generated audio.

Headers

xi-api-keystringOptional

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_idstringOptional

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_idstringOptional

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

model_idstringOptional

Search term used for filtering history items. If provided, source becomes required.

date_before_unixintegerOptional

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

date_after_unixintegerOptional

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

sort_directionenumOptional

Sort direction for the results.

Allowed values:

searchstringOptional

search term used for filtering

sourceenumOptional

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.

Headers

Query parameters

Response

Errors