Get Chapter | ElevenLabs Documentation

from elevenlabs import ElevenLabs
client = ElevenLabs()
client.studio.projects.chapters.get(
    project_id="21m00Tcm4TlvDq8ikWAM",
    chapter_id="21m00Tcm4TlvDq8ikWAM",
)

{
  "chapter_id": "aw1NgEzBg83R7vgmiJt6",
  "name": "Chapter 1",
  "can_be_downloaded": true,
  "state": "default",
  "content": {
    "blocks": [
      {
        "block_id": "block_id",
        "nodes": [
          {
            "type": "tts_node",
            "text": "text",
            "voice_id": "voice_id"
          }
        ]
      }
    ]
  },
  "last_conversion_date_unix": 1714204800,
  "conversion_progress": 0.5,
  "has_video": true,
  "has_visual_content": true,
  "voice_ids": [
    "voice_ids"
  ],
  "statistics": {
    "characters_unconverted": 100,
    "characters_converted": 200,
    "paragraphs_converted": 5,
    "paragraphs_unconverted": 3,
    "voice_statistics": [
      {
        "voice_id": "voice_id",
        "characters_unconverted": 1,
        "characters_converted": 1
      }
    ]
  },
  "last_conversion_error": "last_conversion_error"
}

Returns information about a specific chapter.

Path parameters

project_idstringRequired

The ID of the project to be used. You can use the List projects endpoint to list all the available projects.

chapter_idstringRequired

The ID of the chapter to be used. You can use the List project chapters endpoint to list all the available chapters.

Response

Successful Response

chapter_idstring

The ID of the chapter.

namestring

The name of the chapter.

can_be_downloadedboolean

Whether the chapter can be downloaded.

stateenum

The state of the chapter.

Allowed values:

contentobject

last_conversion_date_unixinteger

The last conversion date of the chapter.

conversion_progressdouble

The conversion progress of the chapter.

has_videoboolean

Whether the chapter has a video.

has_visual_contentboolean

Whether the chapter has any visual content (video, image, or text clips).

voice_idslist of strings

List of voice ids used by the chapter

statisticsobject

The statistics of the chapter.

last_conversion_errorstring

The last conversion error of the chapter.

Errors

422

Chapters Get Request Unprocessable Entity Error

Path parameters

Headers

Response

Errors