Create Chapter

POST

/v1/studio/projects/:project_id/chapters

Creates a new chapter either as blank or from a URL.

Path parameters

project_idstringRequired

The ID of the Studio project.

Request

This endpoint expects an object.

namestringRequired

The name of the chapter, used for identification only.

from_urlstringOptional

An optional URL from which we will extract content to initialize the Studio project. If this is set, ‘from_url’ must be null. If neither ‘from_url’ or ‘from_document’ are provided we will initialize the Studio project as blank.

Response

Successful Response

chapterobject

Errors

POST

1 curl -X POST https://api.elevenlabs.io/v1/studio/projects/21m00Tcm4TlvDq8ikWAM/chapters \
2      -H "xi-api-key: <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "name"
6 }'

200Successful

1 {
2   "chapter": {
3     "chapter_id": "chapter_id",
4     "name": "name",
5     "can_be_downloaded": true,
6     "state": "default",
7     "content": {
8       "blocks": [
9         {
10           "block_id": "block_id",
11           "nodes": [
12             {
13               "type": "tts_node",
14               "text": "text",
15               "voice_id": "voice_id"
16             }
17           ]
18         }
19       ]
20     },
21     "last_conversion_date_unix": 1,
22     "conversion_progress": 1.1,
23     "statistics": {
24       "characters_unconverted": 1,
25       "characters_converted": 1,
26       "paragraphs_converted": 1,
27       "paragraphs_unconverted": 1
28     },
29     "last_conversion_error": "last_conversion_error"
30   }
31 }

Update Chapter

Up Next

Built with

1	curl -X POST https://api.elevenlabs.io/v1/studio/projects/21m00Tcm4TlvDq8ikWAM/chapters \
2	-H "xi-api-key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "name"
6	}'

1	{
2	"chapter": {
3	"chapter_id": "chapter_id",
4	"name": "name",
5	"can_be_downloaded": true,
6	"state": "default",
7	"content": {
8	"blocks": [
9	{
10	"block_id": "block_id",
11	"nodes": [
12	{
13	"type": "tts_node",
14	"text": "text",
15	"voice_id": "voice_id"
16	}
17	]
18	}
19	]
20	},
21	"last_conversion_date_unix": 1,
22	"conversion_progress": 1.1,
23	"statistics": {
24	"characters_unconverted": 1,
25	"characters_converted": 1,
26	"paragraphs_converted": 1,
27	"paragraphs_unconverted": 1
28	},
29	"last_conversion_error": "last_conversion_error"
30	}
31	}