v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
studio

List Chapter Snapshots

Gets information about all the snapshots of a chapter. Each snapshot can be downloaded as audio. Whenever a chapter is converted a snapshot will automatically be created.

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

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.

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

{
  "snapshots": [
    {
      "chapter_id": "aw1NgEzBg83R7vgmiJt3",
      "chapter_snapshot_id": "aw1NgEzBg83R7vgmiJt1",
      "created_at_unix": 1714204800,
      "name": "My Chapter Snapshot",
      "project_id": "aw1NgEzBg83R7vgmiJt2"
    }
  ]
}