Sign in

v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
speech-history

Get History Item

Retrieves a history item.

get/v1/history/{history_item_id}

Path parameters

history_item_idstring required

History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs.

Example:VW7YKqPnjY4h39yTbx2L

History item ID to be used, you can use GET https://api.elevenlabs.io/v1/history to receive a list of history items and their IDs.

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

history_item_idstring required

The ID of the history item.

request_idstring nullable

The ID of the request.

voice_idstring nullable

The ID of the voice used.

model_idstring nullable

The ID of the model.

voice_namestring nullable

The name of the voice.

voice_category'premade' | 'cloned' | 'generated' | 'professional' nullable

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

textstring nullable

The text used to generate the audio item.

date_unixinteger required

Unix timestamp of when the item was created.

character_count_change_frominteger required

The character count change from.

character_count_change_tointeger required

The character count change to.

content_typestring required

The content type of the generated item.

state'created' | 'deleted' | 'processing' required

The state of the history item.

settingsobject nullable

The settings of the history item.

share_link_idstring nullable

The ID of the share link.

source'TTS' | 'STS' | 'Projects' | 'PD' | 'AN' | 'Dubbing' | 'PlayAPI' | 'ConvAI' | 'VoiceGeneration' | 'InVPC' | 'Flows' nullable

The source of the history item. Either TTS (text to speech), STS (speech to text), AN (audio native), Projects, Dubbing, PlayAPI, PD (pronunciation dictionary) or ConvAI (Agents Platform).

output_formatstring nullable

The output format the audio was originally generated in.

Example response

{
  "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"
}