v4

OpenAPI 3.1.02026-07-313621,3961.8 MB

studio

Get Chapter Snapshot

Returns the chapter snapshot.

get/v1/studio/projects/{project_id}/chapters/{chapter_id}/snapshots/{chapter_snapshot_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.

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.

Response

Successful Response

chapter_snapshot_idstring required

The ID of the chapter snapshot.

project_idstring required

The ID of the project.

chapter_idstring required

The ID of the chapter.

created_at_unixinteger required

The creation date of the chapter snapshot.

namestring required

The name of the chapter snapshot.

Example response

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