Set the entrance - Alakazam

PATCH

worlds

{id}

entrance

Set the entrance

curl --request PATCH \
  --url https://api.alakazam.gg/v1/worlds/{id}/entrance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": "<string>",
  "expectedRev": "<string>"
}
'

{
  "world": {
    "id": "<string>",
    "name": "<string>",
    "entrance": {
      "image": {
        "src": "<string>",
        "label": "<string>"
      },
      "state": "<string>"
    },
    "scene": {
      "states": {},
      "events": [
        {}
      ]
    },
    "description": "<string>",
    "cover": "<string>"
  },
  "diagnostics": [
    {
      "lint": "<string>",
      "path": "<string>",
      "message": "<string>",
      "loc": {
        "field": "<string>",
        "template": "<string>",
        "slot": "<string>",
        "fill": "<string>"
      }
    }
  ],
  "rev": "<string>",
  "schemaVersion": "1.0"
}

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.

Headers

If-Match

string

Path Parameters

string<uuid>

required

Body

application/json

state

string

required

image

object

Show child attributes

expectedRev

string

Response

Entrance set

The result of a graph write. world is the new, kernel-validated world; diagnostics carries advisory (warning/info) findings; rev is the new concurrency token (also returned as the ETag header).

world

object

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

Show child attributes

diagnostics

object[]

Show child attributes

rev

string

The new revision token. Pass it as If-Match on the next write.

schemaVersion

string

Example:

"1.0"

Apply a batch of graph opsApply an ordered batch of `GraphOp`s atomically: unapplicable ops are collected in `applyErrors` (the editor's behavior), then the resulting world is validated ONCE through the kernel gate. A 422 means the batch was rejected as a whole — nothing persists. This single endpoint backs nearly all editor mutations.

⌘I

Set the entrance

curl --request PATCH \
  --url https://api.alakazam.gg/v1/worlds/{id}/entrance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "state": "<string>",
  "expectedRev": "<string>"
}
'

{
  "world": {
    "id": "<string>",
    "name": "<string>",
    "entrance": {
      "image": {
        "src": "<string>",
        "label": "<string>"
      },
      "state": "<string>"
    },
    "scene": {
      "states": {},
      "events": [
        {}
      ]
    },
    "description": "<string>",
    "cover": "<string>"
  },
  "diagnostics": [
    {
      "lint": "<string>",
      "path": "<string>",
      "message": "<string>",
      "loc": {
        "field": "<string>",
        "template": "<string>",
        "slot": "<string>",
        "fill": "<string>"
      }
    }
  ],
  "rev": "<string>",
  "schemaVersion": "1.0"
}