studio

Update Chapter

Changed on

Updates a chapter.

post/v1/studio/projects/{project_id}/chapters/{chapter_id}

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/studio/projects/{project_id}/chapters/{chapter_id}
  • Auth
    none declared

Path parameters

project_idstring required

The ID of the Studio project.

Example:21m00Tcm4TlvDq8ikWAM
chapter_idstring required

The ID of the chapter.

Example:21m00Tcm4TlvDq8ikWAM

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body

namestring nullable

The name of the chapter, used for identification only.

Example request

{
  "name": "Chapter 1"
}

Response

Successful Response

Example response

{
  "chapter": {
    "can_be_downloaded": true,
    "chapter_id": "aw1NgEzBg83R7vgmiJt6",
    "content": {
      "blocks": []
    },
    "conversion_progress": 0.5,
    "last_conversion_date_unix": 1714204800,
    "name": "Chapter 1",
    "state": "default",
    "statistics": {
      "characters_converted": 200,
      "characters_unconverted": 100,
      "paragraphs_converted": 5,
      "paragraphs_unconverted": 3
    }
  }
}

Changes

  • 009bd651509aRevision changes
    • info

      response property chapter/content/blocks/items/nodes/items/anyOf[subschema #1: ChapterContentBlockTtsNodeResponseModel]/voice_id deprecated

    • info

      response property chapter/statistics/anyOf[subschema #1: ChapterStatisticsResponseModel]/voice_statistics/anyOf[subschema #1]/items/voice_id deprecated

    • info

      added the required property /////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      the response required property /////// became read-only for the status

    • info

      the response required property ////// became read-only for the status

  • 37fac3c5a2d7Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property ////// to the response with the status