Skip to main content
GET
/
v1
/
worlds
/
{id}
/
versions
/
{versionId}
Get one version snapshot
curl --request GET \
  --url https://api.alakazam.gg/v1/worlds/{id}/versions/{versionId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parentVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "snapshot": {
    "id": "<string>",
    "name": "<string>",
    "entrance": {
      "image": {
        "src": "<string>",
        "label": "<string>"
      },
      "state": "<string>"
    },
    "scene": {
      "states": {},
      "events": [
        {}
      ]
    },
    "description": "<string>",
    "cover": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

An app API key, e.g. Authorization: Bearer sk_live_…. Secret (sk_) for writes/sessions; publishable (pk_) for read/embed.

Path Parameters

​
id
string<uuid>
required
​
versionId
string<uuid>
required

Response

The version snapshot

A version node plus its full world snapshot.

​
id
string<uuid>
required
​
worldId
string<uuid>
required
​
parentVersionId
string<uuid> | null
required
​
source
enum<string>
required
Available options:
save,
branch,
manual,
ai,
import
​
title
string | null
required
​
createdAt
string<date-time>
required
​
snapshot
object
required

A playable world. The full contract is published as JSON Schema at https://alakazam.gg/schema/smworld-1.0.json (see schema/COMPATIBILITY.md). Additional optional properties are allowed (forward-compatible).