Skip to main content
POST
/
v1
/
worlds
/
{id}
/
states
Add a state (node)
curl --request POST \
  --url https://api.alakazam.gg/v1/worlds/{id}/states \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "base": "<string>",
  "camera": {
    "static": "<string>",
    "dynamic": "<string>"
  },
  "movement": {
    "static": "<string>",
    "dynamic": "<string>"
  },
  "ambient": [
    "<string>"
  ],
  "ending": {},
  "variants": [
    {}
  ],
  "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",
  "stateId": "<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.

Headers

​
If-Match
string

The rev you last read. Mismatch returns 409.

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
id
string
​
base
string
​
camera
object

A static/dynamic prompt pair. The world model is conditioned on the static layer while the scene holds and on the dynamic layer while it moves. Both are pixel-prose, never authorial intent.

​
movement
object

A static/dynamic prompt pair. The world model is conditioned on the static layer while the scene holds and on the dynamic layer while it moves. Both are pixel-prose, never authorial intent.

​
ambient
string[]
​
ending
object
​
variants
object[]
​
expectedRev
string

Alternative to the If-Match header.

Response

State added

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

​
diagnostics
object[]
​
rev
string

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

​
schemaVersion
string
Example:

"1.0"

​
stateId
string