Graph editing
Update an event
Patch any field of an edge addressed by name (kind/from/to/hotkey/requires/grants/timing/…). The body is the partial event, or { patch: {...} }. Validated fail-closed.
PATCH
/
v1
/
worlds
/
{id}
/
events
/
{eventName}
Update an event
curl --request PATCH \
--url https://api.alakazam.gg/v1/worlds/{id}/events/{eventName} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"from": [
"<string>"
],
"to": "<string>",
"base": "<string>",
"detail": "<string>",
"hotkey": "<string>",
"hidden": true,
"oneShot": true,
"requires": [
"<string>"
],
"grants": [
"<string>"
],
"anchor": {
"label": "<string>",
"aliases": [
"<string>"
]
}
}
'import requests
url = "https://api.alakazam.gg/v1/worlds/{id}/events/{eventName}"
payload = {
"name": "<string>",
"from": ["<string>"],
"to": "<string>",
"base": "<string>",
"detail": "<string>",
"hotkey": "<string>",
"hidden": True,
"oneShot": True,
"requires": ["<string>"],
"grants": ["<string>"],
"anchor": {
"label": "<string>",
"aliases": ["<string>"]
}
}
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({
name: '<string>',
from: ['<string>'],
to: '<string>',
base: '<string>',
detail: '<string>',
hotkey: '<string>',
hidden: true,
oneShot: true,
requires: ['<string>'],
grants: ['<string>'],
anchor: {label: '<string>', aliases: ['<string>']}
})
};
fetch('https://api.alakazam.gg/v1/worlds/{id}/events/{eventName}', 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}/events/{eventName}",
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([
'name' => '<string>',
'from' => [
'<string>'
],
'to' => '<string>',
'base' => '<string>',
'detail' => '<string>',
'hotkey' => '<string>',
'hidden' => true,
'oneShot' => true,
'requires' => [
'<string>'
],
'grants' => [
'<string>'
],
'anchor' => [
'label' => '<string>',
'aliases' => [
'<string>'
]
]
]),
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}/events/{eventName}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"from\": [\n \"<string>\"\n ],\n \"to\": \"<string>\",\n \"base\": \"<string>\",\n \"detail\": \"<string>\",\n \"hotkey\": \"<string>\",\n \"hidden\": true,\n \"oneShot\": true,\n \"requires\": [\n \"<string>\"\n ],\n \"grants\": [\n \"<string>\"\n ],\n \"anchor\": {\n \"label\": \"<string>\",\n \"aliases\": [\n \"<string>\"\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}/events/{eventName}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"from\": [\n \"<string>\"\n ],\n \"to\": \"<string>\",\n \"base\": \"<string>\",\n \"detail\": \"<string>\",\n \"hotkey\": \"<string>\",\n \"hidden\": true,\n \"oneShot\": true,\n \"requires\": [\n \"<string>\"\n ],\n \"grants\": [\n \"<string>\"\n ],\n \"anchor\": {\n \"label\": \"<string>\",\n \"aliases\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alakazam.gg/v1/worlds/{id}/events/{eventName}")
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 \"name\": \"<string>\",\n \"from\": [\n \"<string>\"\n ],\n \"to\": \"<string>\",\n \"base\": \"<string>\",\n \"detail\": \"<string>\",\n \"hotkey\": \"<string>\",\n \"hidden\": true,\n \"oneShot\": true,\n \"requires\": [\n \"<string>\"\n ],\n \"grants\": [\n \"<string>\"\n ],\n \"anchor\": {\n \"label\": \"<string>\",\n \"aliases\": [\n \"<string>\"\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
An app API key, e.g. Authorization: Bearer sk_live_…. Secret (sk_) for writes/sessions; publishable (pk_) is read-only (browser-safe).
Headers
Body
application/json
An edge in the graph, addressed by its unique name. A transition MUST carry a to; an override MUST NOT. Optional fields beyond those listed are allowed (forward-compatible).
Unique edge id within the world.
Available options:
transition, override, terminal Source state id(s) this edge fires from.
Destination state id. Required for transition, forbidden for override.
Bound key. Reserved keys (WASD / digits) are rejected.
Pin this choice to a detected OBJECT in the live frame. When set, the player runs a VLM detect loop and renders this edge as a clickable chip over the matched object (interactive object detection). Use /v1/perceive + /v1/ground/* to discover the right label.
Show child attributes
Show child attributes
Response
Event 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).
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
Show child attributes
Show child attributes
Show child attributes
The new revision token. Pass it as If-Match on the next write.
Example:
"1.0"
⌘I
Update an event
curl --request PATCH \
--url https://api.alakazam.gg/v1/worlds/{id}/events/{eventName} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"from": [
"<string>"
],
"to": "<string>",
"base": "<string>",
"detail": "<string>",
"hotkey": "<string>",
"hidden": true,
"oneShot": true,
"requires": [
"<string>"
],
"grants": [
"<string>"
],
"anchor": {
"label": "<string>",
"aliases": [
"<string>"
]
}
}
'import requests
url = "https://api.alakazam.gg/v1/worlds/{id}/events/{eventName}"
payload = {
"name": "<string>",
"from": ["<string>"],
"to": "<string>",
"base": "<string>",
"detail": "<string>",
"hotkey": "<string>",
"hidden": True,
"oneShot": True,
"requires": ["<string>"],
"grants": ["<string>"],
"anchor": {
"label": "<string>",
"aliases": ["<string>"]
}
}
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({
name: '<string>',
from: ['<string>'],
to: '<string>',
base: '<string>',
detail: '<string>',
hotkey: '<string>',
hidden: true,
oneShot: true,
requires: ['<string>'],
grants: ['<string>'],
anchor: {label: '<string>', aliases: ['<string>']}
})
};
fetch('https://api.alakazam.gg/v1/worlds/{id}/events/{eventName}', 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}/events/{eventName}",
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([
'name' => '<string>',
'from' => [
'<string>'
],
'to' => '<string>',
'base' => '<string>',
'detail' => '<string>',
'hotkey' => '<string>',
'hidden' => true,
'oneShot' => true,
'requires' => [
'<string>'
],
'grants' => [
'<string>'
],
'anchor' => [
'label' => '<string>',
'aliases' => [
'<string>'
]
]
]),
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}/events/{eventName}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"from\": [\n \"<string>\"\n ],\n \"to\": \"<string>\",\n \"base\": \"<string>\",\n \"detail\": \"<string>\",\n \"hotkey\": \"<string>\",\n \"hidden\": true,\n \"oneShot\": true,\n \"requires\": [\n \"<string>\"\n ],\n \"grants\": [\n \"<string>\"\n ],\n \"anchor\": {\n \"label\": \"<string>\",\n \"aliases\": [\n \"<string>\"\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}/events/{eventName}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"from\": [\n \"<string>\"\n ],\n \"to\": \"<string>\",\n \"base\": \"<string>\",\n \"detail\": \"<string>\",\n \"hotkey\": \"<string>\",\n \"hidden\": true,\n \"oneShot\": true,\n \"requires\": [\n \"<string>\"\n ],\n \"grants\": [\n \"<string>\"\n ],\n \"anchor\": {\n \"label\": \"<string>\",\n \"aliases\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alakazam.gg/v1/worlds/{id}/events/{eventName}")
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 \"name\": \"<string>\",\n \"from\": [\n \"<string>\"\n ],\n \"to\": \"<string>\",\n \"base\": \"<string>\",\n \"detail\": \"<string>\",\n \"hotkey\": \"<string>\",\n \"hidden\": true,\n \"oneShot\": true,\n \"requires\": [\n \"<string>\"\n ],\n \"grants\": [\n \"<string>\"\n ],\n \"anchor\": {\n \"label\": \"<string>\",\n \"aliases\": [\n \"<string>\"\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"
}