Edit project chapter

PATCH

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

Edits a 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.

Request

This endpoint expects an object.

namestringOptional

The name of the chapter, used for identification only.

contentobjectOptional

The chapter content to use.

Response

Successful Response

chapterobject

Errors

PATCH

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

200Updated

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": "_other"
14             }
15           ]
16         }
17       ]
18     },
19     "last_conversion_date_unix": 1,
20     "conversion_progress": 1.1,
21     "statistics": {
22       "characters_unconverted": 1,
23       "characters_converted": 1,
24       "paragraphs_converted": 1,
25       "paragraphs_unconverted": 1
26     },
27     "last_conversion_error": "last_conversion_error"
28   }
29 }

Built with

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

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": "_other"
14	}
15	]
16	}
17	]
18	},
19	"last_conversion_date_unix": 1,
20	"conversion_progress": 1.1,
21	"statistics": {
22	"characters_unconverted": 1,
23	"characters_converted": 1,
24	"paragraphs_converted": 1,
25	"paragraphs_unconverted": 1
26	},
27	"last_conversion_error": "last_conversion_error"
28	}
29	}