List Chapter Snapshots

GET https://api.elevenlabs.io/v1/studio/projects//chapters//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.

Reference: https://elevenlabs.io/docs/api-reference/studio/get-chapter-snapshots

Servers

https://api.elevenlabs.io (Production, default)
https://api.us.elevenlabs.io (Production US)
https://api.eu.residency.elevenlabs.io (Production EU)
https://api.in.residency.elevenlabs.io (Production India)
https://api.sg.residency.elevenlabs.io (Production Singapore)

Request

Path parameters

project_id (string, required) — The ID of the project to be used. You can use the List projects endpoint to list all the available projects.
chapter_id (string, required) — The ID of the chapter to be used. You can use the List project chapters endpoint to list all the available chapters.

Response

200

Successful Response

snapshots (list of ChapterSnapshotResponseModel, required) — List of chapter snapshots.

Errors

422 Unprocessable Entity Error

Validation Error

detail (list of ValidationError, optional)

Types

ChapterSnapshotResponseModel

chapter_snapshot_id (string, required) — The ID of the chapter snapshot.
project_id (string, required) — The ID of the project.
chapter_id (string, required) — The ID of the chapter.
created_at_unix (integer, required) — The creation date of the chapter snapshot.
name (string, required) — The name of the chapter snapshot.

ValidationError

loc (list of ValidationErrorLocItems, required)
msg (string, required)
type (string, required)

ValidationErrorLocItems

Examples

Response

JSON

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

SDK Code

TypeScript

import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";

async function main() {
    const client = new ElevenLabsClient();
    await client.studio.projects.chapters.snapshots.list("21m00Tcm4TlvDq8ikWAM", "21m00Tcm4TlvDq8ikWAM");
}
main();

Python

from elevenlabs import ElevenLabs

client = ElevenLabs()

client.studio.projects.chapters.snapshots.list(
    project_id="21m00Tcm4TlvDq8ikWAM",
    chapter_id="21m00Tcm4TlvDq8ikWAM",
)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.elevenlabs.io/v1/studio/projects/21m00Tcm4TlvDq8ikWAM/chapters/21m00Tcm4TlvDq8ikWAM/snapshots"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.elevenlabs.io/v1/studio/projects/21m00Tcm4TlvDq8ikWAM/chapters/21m00Tcm4TlvDq8ikWAM/snapshots")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

Java

import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.elevenlabs.io/v1/studio/projects/21m00Tcm4TlvDq8ikWAM/chapters/21m00Tcm4TlvDq8ikWAM/snapshots")
  .asString();

PHP

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.elevenlabs.io/v1/studio/projects/21m00Tcm4TlvDq8ikWAM/chapters/21m00Tcm4TlvDq8ikWAM/snapshots');

echo $response->getBody();

using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/studio/projects/21m00Tcm4TlvDq8ikWAM/chapters/21m00Tcm4TlvDq8ikWAM/snapshots");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);

Swift

import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/studio/projects/21m00Tcm4TlvDq8ikWAM/chapters/21m00Tcm4TlvDq8ikWAM/snapshots")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

Search documentation

Help Center