studio

List Chapters

Changed on

Returns a list of a Studio project's chapters.

get/v1/studio/projects/{project_id}/chapters

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
  • Auth
    none declared

Path parameters

project_idstring required

The ID of the Studio project.

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.

Response

Successful Response

Example response

{
  "chapters": [
    {
      "can_be_downloaded": true,
      "chapter_id": "aw1NgEzBg83R7vgmiJt6",
      "conversion_progress": 0.5,
      "last_conversion_date_unix": 1714204800,
      "last_conversion_error": "Error message",
      "name": "Chapter 1",
      "state": "converting",
      "statistics": {
        "characters_converted": 500,
        "characters_unconverted": 1000,
        "credits_needed_to_convert": 1000,
        "paragraphs_converted": 20,
        "paragraphs_unconverted": 10,
        "voice_statistics": [
          {
            "characters_converted": 300,
            "characters_unconverted": 600,
            "project_voice_ref_id": "voice123",
            "voice_id": "voice123"
          },
          {
            "characters_converted": 200,
            "characters_unconverted": 400,
            "project_voice_ref_id": "voice456",
            "voice_id": "voice456"
          }
        ]
      }
    }
  ]
}

Changes

  • 009bd651509aRevision changes
    • info

      response property chapters/items/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

      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