Update a state

PATCH

worlds

{id}

states

{stateId}

Update a state

curl --request PATCH \
  --url https://api.alakazam.gg/v1/worlds/{id}/states/{stateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "base": "<string>",
  "camera": {
    "static": "<string>",
    "dynamic": "<string>"
  },
  "movement": {
    "static": "<string>",
    "dynamic": "<string>"
  },
  "ambient": [
    "<string>"
  ],
  "variants": [
    {}
  ]
}
'

import requests

url = "https://api.alakazam.gg/v1/worlds/{id}/states/{stateId}"

payload = {
    "base": "<string>",
    "camera": {
        "static": "<string>",
        "dynamic": "<string>"
    },
    "movement": {
        "static": "<string>",
        "dynamic": "<string>"
    },
    "ambient": ["<string>"],
    "variants": [{}]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    base: '<string>',
    camera: {static: '<string>', dynamic: '<string>'},
    movement: {static: '<string>', dynamic: '<string>'},
    ambient: ['<string>'],
    variants: [{}]
  })
};

fetch('https://api.alakazam.gg/v1/worlds/{id}/states/{stateId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alakazam.gg/v1/worlds/{id}/states/{stateId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'base' => '<string>',
    'camera' => [
        'static' => '<string>',
        'dynamic' => '<string>'
    ],
    'movement' => [
        'static' => '<string>',
        'dynamic' => '<string>'
    ],
    'ambient' => [
        '<string>'
    ],
    'variants' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.alakazam.gg/v1/worlds/{id}/states/{stateId}"

	payload := strings.NewReader("{\n  \"base\": \"<string>\",\n  \"camera\": {\n    \"static\": \"<string>\",\n    \"dynamic\": \"<string>\"\n  },\n  \"movement\": {\n    \"static\": \"<string>\",\n    \"dynamic\": \"<string>\"\n  },\n  \"ambient\": [\n    \"<string>\"\n  ],\n  \"variants\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.alakazam.gg/v1/worlds/{id}/states/{stateId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"base\": \"<string>\",\n  \"camera\": {\n    \"static\": \"<string>\",\n    \"dynamic\": \"<string>\"\n  },\n  \"movement\": {\n    \"static\": \"<string>\",\n    \"dynamic\": \"<string>\"\n  },\n  \"ambient\": [\n    \"<string>\"\n  ],\n  \"variants\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alakazam.gg/v1/worlds/{id}/states/{stateId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"base\": \"<string>\",\n  \"camera\": {\n    \"static\": \"<string>\",\n    \"dynamic\": \"<string>\"\n  },\n  \"movement\": {\n    \"static\": \"<string>\",\n    \"dynamic\": \"<string>\"\n  },\n  \"ambient\": [\n    \"<string>\"\n  ],\n  \"variants\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

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

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "diagnostics": [
    {
      "lint": "<string>",
      "severity": "error",
      "path": "<string>",
      "message": "<string>",
      "loc": {
        "field": "<string>",
        "template": "<string>",
        "slot": "<string>",
        "fill": "<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_) is read-only (browser-safe).

Headers

If-Match

string

Path Parameters

string<uuid>

required

stateId

string

required

Body

application/json

A node in the graph. Optional fields beyond those listed are allowed (forward-compatible). Prose fields must describe pixels, not intent. The kernel doctrine lints enforce this on every write.

base

string

Scene prose for this node (pixels, not intent).

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.

Show child attributes

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.

Show child attributes

ambient

string[]

Ambient detail prose fragments.

ending

object

Marks this node as a TERMINAL sink. A node with an ending must be a dead end (no outgoing transitions).

Show child attributes

variants

object[]

A/B prompt arms (play-only; never compiled into the graph).

Response

State updated

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's compiled graph, id, name, entrance, and the scene (states + events). This is the shape returned inside the world field of a World resource (see World) and by the graph-editing routes. Additional optional properties are allowed (forward-compatible); the schemaVersion on responses pins the contract version.

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"

Update a state

curl --request PATCH \
  --url https://api.alakazam.gg/v1/worlds/{id}/states/{stateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "base": "<string>",
  "camera": {
    "static": "<string>",
    "dynamic": "<string>"
  },
  "movement": {
    "static": "<string>",
    "dynamic": "<string>"
  },
  "ambient": [
    "<string>"
  ],
  "variants": [
    {}
  ]
}
'

import requests

url = "https://api.alakazam.gg/v1/worlds/{id}/states/{stateId}"

payload = {
    "base": "<string>",
    "camera": {
        "static": "<string>",
        "dynamic": "<string>"
    },
    "movement": {
        "static": "<string>",
        "dynamic": "<string>"
    },
    "ambient": ["<string>"],
    "variants": [{}]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    base: '<string>',
    camera: {static: '<string>', dynamic: '<string>'},
    movement: {static: '<string>', dynamic: '<string>'},
    ambient: ['<string>'],
    variants: [{}]
  })
};

fetch('https://api.alakazam.gg/v1/worlds/{id}/states/{stateId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.alakazam.gg/v1/worlds/{id}/states/{stateId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'base' => '<string>',
    'camera' => [
        'static' => '<string>',
        'dynamic' => '<string>'
    ],
    'movement' => [
        'static' => '<string>',
        'dynamic' => '<string>'
    ],
    'ambient' => [
        '<string>'
    ],
    'variants' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.alakazam.gg/v1/worlds/{id}/states/{stateId}"

	payload := strings.NewReader("{\n  \"base\": \"<string>\",\n  \"camera\": {\n    \"static\": \"<string>\",\n    \"dynamic\": \"<string>\"\n  },\n  \"movement\": {\n    \"static\": \"<string>\",\n    \"dynamic\": \"<string>\"\n  },\n  \"ambient\": [\n    \"<string>\"\n  ],\n  \"variants\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.alakazam.gg/v1/worlds/{id}/states/{stateId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"base\": \"<string>\",\n  \"camera\": {\n    \"static\": \"<string>\",\n    \"dynamic\": \"<string>\"\n  },\n  \"movement\": {\n    \"static\": \"<string>\",\n    \"dynamic\": \"<string>\"\n  },\n  \"ambient\": [\n    \"<string>\"\n  ],\n  \"variants\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.alakazam.gg/v1/worlds/{id}/states/{stateId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"base\": \"<string>\",\n  \"camera\": {\n    \"static\": \"<string>\",\n    \"dynamic\": \"<string>\"\n  },\n  \"movement\": {\n    \"static\": \"<string>\",\n    \"dynamic\": \"<string>\"\n  },\n  \"ambient\": [\n    \"<string>\"\n  ],\n  \"variants\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

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

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

{
  "detail": "<string>",
  "diagnostics": [
    {
      "lint": "<string>",
      "severity": "error",
      "path": "<string>",
      "message": "<string>",
      "loc": {
        "field": "<string>",
        "template": "<string>",
        "slot": "<string>",
        "fill": "<string>"
      }
    }
  ],
  "schemaVersion": "1.0"
}

Play API

Forge API

Train API

Authorizations

Headers

Path Parameters

Body

Response