Get a world - Alakazam

GET

worlds

{id}

Get a world

curl --request GET \
  --url https://api.alakazam.gg/v1/worlds/{id} \
  --header 'Authorization: Bearer <token>'

{
  "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

string<uuid>

required

Response

The full world

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).

string

required

name

string

required

entrance

object

required

Show child attributes

scene

object

required

Show child attributes

description

string

cover

string

Delete a world

⌘I

Get a world

curl --request GET \
  --url https://api.alakazam.gg/v1/worlds/{id} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "name": "<string>",
  "entrance": {
    "image": {
      "src": "<string>",
      "label": "<string>"
    },
    "state": "<string>"
  },
  "scene": {
    "states": {},
    "events": [
      {}
    ]
  },
  "description": "<string>",
  "cover": "<string>"
}