Sign in

v5

latestOpenAPI 3.1.02026-08-043621,4011.8 MB
speech-history

List Generated Items

Returns a list of your generated audio (e.g. text to speech, speech to speech, Studio, dubbing). Music and SFX generations are not included and cannot currently be retrieved via the API.

get/v1/history

Query parameters

page_sizeinteger

How many history items to return at maximum. Can not exceed 1000, defaults to 100.

How many history items to return at maximum. Can not exceed 1000, defaults to 100.

start_after_history_item_idstring nullable

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.

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 nullable

Voice ID to be filtered for, you can use GET https://api.elevenlabs.io/v1/voices to receive a list of voices and their IDs.

Voice ID to be filtered for, you can use GET https://api.elevenlabs.io/v1/voices to receive a list of voices and their IDs.

model_idstring nullable

Model ID to filter history items by.

Example:eleven_turbo_v2

Model ID to filter history items by.

date_before_unixinteger nullable

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

Example:1640995200

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

date_after_unixinteger nullable

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

Example:1640995200

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

sort_direction'asc' | 'desc' nullable

Sort direction for the results.

Example:desc

Sort direction for the results.

searchstring nullable

search term used for filtering

Example:In the land far far away

search term used for filtering

source'TTS' | 'STS' | 'Flows' nullable

Source of the generated history item

Example:TTS

Source of the generated history item

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Response

Successful Response

last_history_item_idstring nullable

The ID of the last history item.

has_moreboolean required

Whether there are more history items to fetch.

scanned_untilinteger nullable

The timestamp of the last history item.

Example response

{
  "has_more": true,
  "history": [
    {
      "character_count_change_from": 17189,
      "character_count_change_to": 17231,
      "content_type": "audio/mpeg",
      "date_unix": 1714650306,
      "history_item_id": "ja9xsmfGhxYcymxGcOGB",
      "model_id": "eleven_multilingual_v2",
      "request_id": "BF0BZg4IwLGBlaVjv9Im",
      "settings": {
        "similarity_boost": 0.5,
        "stability": 0.71,
        "style": 0,
        "use_speaker_boost": true
      },
      "source": "TTS",
      "state": "created",
      "text": "Hello, world!",
      "voice_category": "premade",
      "voice_id": "21m00Tcm4TlvDq8ikWAM",
      "voice_name": "Rachel"
    }
  ],
  "last_history_item_id": "ja9xsmfGhxYcymxGcOGB",
  "scanned_until": 1714650306
}
All 362 operations