v4

OpenAPI 3.1.02026-07-313621,3961.8 MB

studio

Get Chapter

Returns information about a specific chapter.

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

Path parameters

project_idstring required

The ID of the Studio project.

Example:21m00Tcm4TlvDq8ikWAM

The ID of the Studio project.

chapter_idstring required

The ID of the chapter.

Example:21m00Tcm4TlvDq8ikWAM

The ID of the chapter.

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

chapter_idstring required

The ID of the chapter.

namestring required

The name of the chapter.

last_conversion_date_unixinteger nullable

The last conversion date of the chapter.

conversion_progressnumber nullable

The conversion progress of the chapter.

can_be_downloadedboolean required

Whether the chapter can be downloaded.

state'default' | 'converting' required

The state of the chapter.

has_videoboolean nullable

Whether the chapter has a video.

has_visual_contentboolean nullable

Whether the chapter has any visual content (video, image, or text clips).

voice_idsstring[] nullable

List of voice ids used by the chapter

last_conversion_errorstring nullable

The last conversion error of the chapter.

Example response

{
  "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
  }
}