Get a world

GET

worlds

{id}

Get a world

curl --request GET \
  --url https://api.alakazam.gg/v1/worlds/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.alakazam.gg/v1/worlds/{id}', 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}",
  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}"

	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))

}

require 'uri'
require 'net/http'

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

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",
  "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>"
    }
  },
  "schemaVersion": "1.0",
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "cover": "<string>",
  "visibility": "private",
  "plays": 123,
  "likes": 123,
  "playUrl": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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

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

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).

Path Parameters

string<uuid>

required

Response

The world resource. NOTE: the compiled graph is nested under world (see the World schema), not flattened at the top level.

A single world resource, as returned by GET /v1/worlds/{id} and PATCH /v1/worlds/{id}. NOTE: the compiled graph is NESTED under the world property (an SMWorld), entrance/scene/states/events live at world.entrance, world.scene, etc., NOT at the top level. The top level carries the world's metadata + engagement counters. (The graph-read routes like GET /v1/worlds/{id}/scene, /states, and /events return narrower sub-projections of the graph instead; the graph-write routes return the graph nested under world, like this resource.)

string<uuid>

required

world

object

required

The compiled playable graph (states + events + entrance).

Show child attributes

schemaVersion

string

required

Example:

"1.0"

slug

string | null

name

string

description

string

cover

string | null

visibility

enum<string>

Available options:

private,

unlisted,

public

plays

integer

Lifetime session-connect count.

likes

integer

Lifetime like count.

playUrl

string | null

Public play link for public worlds only; absent otherwise.

created_at

string<date-time>

updated_at

string<date-time>

Get a world

curl --request GET \
  --url https://api.alakazam.gg/v1/worlds/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.alakazam.gg/v1/worlds/{id}', 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}",
  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}"

	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))

}

require 'uri'
require 'net/http'

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

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",
  "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>"
    }
  },
  "schemaVersion": "1.0",
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "cover": "<string>",
  "visibility": "private",
  "plays": 123,
  "likes": 123,
  "playUrl": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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

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

Play API

Forge API

Train API

Authorizations

Path Parameters

Response