Versions
Get one version snapshot
GET
/
v1
/
worlds
/
{id}
/
versions
/
{versionId}
Get one version snapshot
curl --request GET \
--url https://api.alakazam.gg/v1/worlds/{id}/versions/{versionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.alakazam.gg/v1/worlds/{id}/versions/{versionId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.alakazam.gg/v1/worlds/{id}/versions/{versionId}', 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}/versions/{versionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.alakazam.gg/v1/worlds/{id}/versions/{versionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.alakazam.gg/v1/worlds/{id}/versions/{versionId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alakazam.gg/v1/worlds/{id}/versions/{versionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "save",
"title": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"snapshot": {
"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>"
}
}
}{
"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).
Response
The version snapshot
A version node plus its full world snapshot.
Available options:
save, branch, manual, ai, import 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
⌘I
Get one version snapshot
curl --request GET \
--url https://api.alakazam.gg/v1/worlds/{id}/versions/{versionId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.alakazam.gg/v1/worlds/{id}/versions/{versionId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.alakazam.gg/v1/worlds/{id}/versions/{versionId}', 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}/versions/{versionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.alakazam.gg/v1/worlds/{id}/versions/{versionId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.alakazam.gg/v1/worlds/{id}/versions/{versionId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alakazam.gg/v1/worlds/{id}/versions/{versionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parentVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source": "save",
"title": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"snapshot": {
"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>"
}
}
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}{
"detail": "<string>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}
