Get Chapter

1 import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js"; 2 3 const client = new ElevenLabsClient({ apiKey: "YOUR_API_KEY" }); 4 await client.studio.projects.chapters.get("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM");

1 { 2 "chapter_id": "aw1NgEzBg83R7vgmiJt6", 3 "name": "Chapter 1", 4 "can_be_downloaded": true, 5 "state": "converting", 6 "content": { 7 "blocks": [ 8 { 9 "block_id": "foo", 10 "nodes": [ 11 { 12 "type": "foo", 13 "voice_id": "foo", 14 "text": "foo" 15 } 16 ] 17 } 18 ] 19 }, 20 "last_conversion_date_unix": 1714204800, 21 "conversion_progress": 0.5, 22 "statistics": { 23 "characters_unconverted": 1000, 24 "characters_converted": 500, 25 "paragraphs_converted": 20, 26 "paragraphs_unconverted": 10 27 }, 28 "last_conversion_error": "Error message" 29 }

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 or null

The last conversion date of the chapter.

conversion_progressdouble or null

The conversion progress of the chapter.

statisticsobject or null

The statistics of the chapter.

last_conversion_errorstring or null

The last conversion error of the chapter.

Path parameters

Headers

Response

Errors