Sessions
Mint a runtime session token
Call from YOUR backend with a secret key. Returns a short-lived token your end-user’s browser passes to @alakazamworld/embed. Reserves one session against your daily quota.
POST
/
v1
/
sessions
/
token
Mint a runtime session token
curl --request POST \
--url https://api.alakazam.gg/v1/sessions/token \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"playerIdentity": "<string>",
"origin": "<string>",
"ttlSeconds": 300
}
'import requests
url = "https://api.alakazam.gg/v1/sessions/token"
payload = {
"worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"playerIdentity": "<string>",
"origin": "<string>",
"ttlSeconds": 300
}
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({
worldId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
playerIdentity: '<string>',
origin: '<string>',
ttlSeconds: 300
})
};
fetch('https://api.alakazam.gg/v1/sessions/token', 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/sessions/token",
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([
'worldId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'playerIdentity' => '<string>',
'origin' => '<string>',
'ttlSeconds' => 300
]),
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/sessions/token"
payload := strings.NewReader("{\n \"worldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"playerIdentity\": \"<string>\",\n \"origin\": \"<string>\",\n \"ttlSeconds\": 300\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/sessions/token")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"worldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"playerIdentity\": \"<string>\",\n \"origin\": \"<string>\",\n \"ttlSeconds\": 300\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alakazam.gg/v1/sessions/token")
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 \"worldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"playerIdentity\": \"<string>\",\n \"origin\": \"<string>\",\n \"ttlSeconds\": 300\n}"
response = http.request(request)
puts response.read_body{
"token": "<string>",
"expiresIn": 123,
"worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"jti": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"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>",
"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).
Body
application/json
The world to run (its UUID, not the slug). Accepts a world you generated via the API, and ALSO a world you built in the web Studio: a Studio world's UUID is allowed when the key's account owns (authored) it, even though it has no app_id. See the 'Run a Studio world' guide.
Your stable id for the end-user.
The embedding origin; binds the token's aud and CSP frame-ancestors.
Required range:
60 <= x <= 3600⌘I
Mint a runtime session token
curl --request POST \
--url https://api.alakazam.gg/v1/sessions/token \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"playerIdentity": "<string>",
"origin": "<string>",
"ttlSeconds": 300
}
'import requests
url = "https://api.alakazam.gg/v1/sessions/token"
payload = {
"worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"playerIdentity": "<string>",
"origin": "<string>",
"ttlSeconds": 300
}
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({
worldId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
playerIdentity: '<string>',
origin: '<string>',
ttlSeconds: 300
})
};
fetch('https://api.alakazam.gg/v1/sessions/token', 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/sessions/token",
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([
'worldId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'playerIdentity' => '<string>',
'origin' => '<string>',
'ttlSeconds' => 300
]),
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/sessions/token"
payload := strings.NewReader("{\n \"worldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"playerIdentity\": \"<string>\",\n \"origin\": \"<string>\",\n \"ttlSeconds\": 300\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/sessions/token")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"worldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"playerIdentity\": \"<string>\",\n \"origin\": \"<string>\",\n \"ttlSeconds\": 300\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alakazam.gg/v1/sessions/token")
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 \"worldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"playerIdentity\": \"<string>\",\n \"origin\": \"<string>\",\n \"ttlSeconds\": 300\n}"
response = http.request(request)
puts response.read_body{
"token": "<string>",
"expiresIn": 123,
"worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"jti": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"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>",
"errors": [
"<string>"
],
"schemaVersion": "<string>"
}
