v4

OpenAPI 3.1.02026-07-313621,3961.8 MB
studio

Stream Chapter Audio

Stream the audio from a chapter snapshot. Use GET /v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots to return the snapshots of a chapter.

post/v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_id}/stream

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.

chapter_snapshot_idstring required

The ID of the chapter snapshot.

Example:21m00Tcm4TlvDq8ikWAM

The ID of the chapter snapshot.

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.

Request body

convert_to_mpegboolean

Whether to convert the audio to mpeg format.

Response

Streaming audio data