Skip to main content
PATCH
/
v1
/
worlds
/
{id}
Update world metadata
curl --request PATCH \
  --url https://api.alakazam.gg/v1/worlds/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "cover": "<string>"
}
'
{
  "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

Body

application/json
​
name
string
​
description
string
​
cover
string
​
visibility
enum<string>
Available options:
private,
unlisted,
public

Response

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

​
id
string
required
​
name
string
required
​
entrance
object
required
​
scene
object
required
​
description
string
​
cover
string