Check out a version
Set the working graph (world) to a version’s snapshot AND move HEAD onto it, atomically. A later save then branches off the checked-out version. Returns the restored world and the new rev (also the ETag).
curl --request POST \
--url https://api.alakazam.gg/v1/worlds/{id}/checkout \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expectedRev": "<string>"
}
'import requests
url = "https://api.alakazam.gg/v1/worlds/{id}/checkout"
payload = {
"versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expectedRev": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({versionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', expectedRev: '<string>'})
};
fetch('https://api.alakazam.gg/v1/worlds/{id}/checkout', 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}/checkout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'versionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'expectedRev' => '<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}/checkout"
payload := strings.NewReader("{\n \"versionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expectedRev\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.alakazam.gg/v1/worlds/{id}/checkout")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"versionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expectedRev\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alakazam.gg/v1/worlds/{id}/checkout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"versionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expectedRev\": \"<string>\"\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>"
}
},
"rev": "<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>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}Authorizations
An app API key, e.g. Authorization: Bearer sk_live_…. Secret (sk_) for writes/sessions; publishable (pk_) is read-only (browser-safe).
Headers
The rev you read; checkout returns 409 if it is stale (optimistic concurrency).
Path Parameters
Body
Response
World checked out
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
curl --request POST \
--url https://api.alakazam.gg/v1/worlds/{id}/checkout \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expectedRev": "<string>"
}
'import requests
url = "https://api.alakazam.gg/v1/worlds/{id}/checkout"
payload = {
"versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expectedRev": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({versionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', expectedRev: '<string>'})
};
fetch('https://api.alakazam.gg/v1/worlds/{id}/checkout', 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}/checkout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'versionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'expectedRev' => '<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}/checkout"
payload := strings.NewReader("{\n \"versionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expectedRev\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.alakazam.gg/v1/worlds/{id}/checkout")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"versionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expectedRev\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alakazam.gg/v1/worlds/{id}/checkout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"versionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"expectedRev\": \"<string>\"\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>"
}
},
"rev": "<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>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}
