Get Chapter By Id

Deprecated

GET

/v1/projects/:project_id/chapters/:chapter_id

Returns information about a specific chapter.

Path parameters

project_idstringRequired

The ID of the Studio project.

chapter_idstringRequired

The ID of the chapter.

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

Allowed values: defaultconverting

The state of the chapter.

contentobject

last_conversion_date_unixintegerOptional

The last conversion date of the chapter.

conversion_progressdoubleOptional

The conversion progress of the chapter.

statisticsobjectOptional

The statistics of the chapter.

last_conversion_errorstringOptional

The last conversion error of the chapter.

Errors

GET

1 curl https://api.elevenlabs.io/v1/projects/21m00Tcm4TlvDq8ikWAM/chapters/21m00Tcm4TlvDq8ikWAM \
2      -H "xi-api-key: <apiKey>"

200Retrieved

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": "block_id",
10         "nodes": [
11           {
12             "type": "tts_node",
13             "text": "text",
14             "voice_id": "voice_id"
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 }

Delete Chapter

Up Next

Built with

1	curl https://api.elevenlabs.io/v1/projects/21m00Tcm4TlvDq8ikWAM/chapters/21m00Tcm4TlvDq8ikWAM \
2	-H "xi-api-key: <apiKey>"

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": "block_id",
10	"nodes": [
11	{
12	"type": "tts_node",
13	"text": "text",
14	"voice_id": "voice_id"
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	}