Worlds

Create a world (generate or import)

Two modes, selected by the body. Generate (default): produce a playable SMWorld from a premise and/or seed frame — or from a chapter/book excerpt via text (book-to-game) — reserving one generation against your daily quota before spending GPU. Import: pass a compiled world object to persist it VERBATIM (no generation/GPU) — the graph is schema-validated but not recompiled, and it returns 201 with imported:true. Import still reserves one generation of quota (anti-spam) and is bounded in size (see 413). Worlds created with a live key are attributed to your account and appear in your web Studio under My Creations (test-mode creations stay out of the Studio list).

POST

worlds

curl --request POST \
  --url https://api.alakazam.gg/v1/worlds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "premise": "<string>",
  "frame_b64": "<string>",
  "frame_url": "<string>",
  "text": "<string>",
  "world": {},
  "name": "<string>",
  "description": "<string>",
  "pov": "third_person_shoulder",
  "async": false,
  "subject_ref": {
    "image_b64": "<string>",
    "image_url": "<string>",
    "descriptor": "<string>"
  }
}
'

import requests

url = "https://api.alakazam.gg/v1/worlds"

payload = {
    "premise": "<string>",
    "frame_b64": "<string>",
    "frame_url": "<string>",
    "text": "<string>",
    "world": {},
    "name": "<string>",
    "description": "<string>",
    "pov": "third_person_shoulder",
    "async": False,
    "subject_ref": {
        "image_b64": "<string>",
        "image_url": "<string>",
        "descriptor": "<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({
    premise: '<string>',
    frame_b64: '<string>',
    frame_url: '<string>',
    text: '<string>',
    world: {},
    name: '<string>',
    description: '<string>',
    pov: 'third_person_shoulder',
    async: false,
    subject_ref: {image_b64: '<string>', image_url: '<string>', descriptor: '<string>'}
  })
};

fetch('https://api.alakazam.gg/v1/worlds', 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",
  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([
    'premise' => '<string>',
    'frame_b64' => '<string>',
    'frame_url' => '<string>',
    'text' => '<string>',
    'world' => [
        
    ],
    'name' => '<string>',
    'description' => '<string>',
    'pov' => 'third_person_shoulder',
    'async' => false,
    'subject_ref' => [
        'image_b64' => '<string>',
        'image_url' => '<string>',
        'descriptor' => '<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"

	payload := strings.NewReader("{\n  \"premise\": \"<string>\",\n  \"frame_b64\": \"<string>\",\n  \"frame_url\": \"<string>\",\n  \"text\": \"<string>\",\n  \"world\": {},\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"pov\": \"third_person_shoulder\",\n  \"async\": false,\n  \"subject_ref\": {\n    \"image_b64\": \"<string>\",\n    \"image_url\": \"<string>\",\n    \"descriptor\": \"<string>\"\n  }\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"premise\": \"<string>\",\n  \"frame_b64\": \"<string>\",\n  \"frame_url\": \"<string>\",\n  \"text\": \"<string>\",\n  \"world\": {},\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"pov\": \"third_person_shoulder\",\n  \"async\": false,\n  \"subject_ref\": {\n    \"image_b64\": \"<string>\",\n    \"image_url\": \"<string>\",\n    \"descriptor\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"premise\": \"<string>\",\n  \"frame_b64\": \"<string>\",\n  \"frame_url\": \"<string>\",\n  \"text\": \"<string>\",\n  \"world\": {},\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"pov\": \"third_person_shoulder\",\n  \"async\": false,\n  \"subject_ref\": {\n    \"image_b64\": \"<string>\",\n    \"image_url\": \"<string>\",\n    \"descriptor\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "ok": true,
  "cover": "<string>",
  "schemaVersion": "1.0",
  "mock": true
}

{
  "worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "imported": true,
  "schemaVersion": "1.0"
}

{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phase": "<string>",
  "progress": 123,
  "worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "actsDone": 123,
  "actsTotal": 123,
  "error": "<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>",
  "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).

Headers

Idempotency-Key

string

A retried request with the same key returns the original result without re-generating. Keyed per (app, mode, key value) — test and live keep separate idempotency caches, so reusing a key across modes is safe.

Body

application/json

premise

string

GENERATE mode: a "what if…" pitch. Required if no frame and no world is given.

frame_b64

string

GENERATE mode: base64 seed frame (data-URL or raw).

frame_url

string

GENERATE mode: URL of a seed frame.

text

string

GENERATE mode (BOOK-TO-GAME): a chapter or book excerpt turned into a playable world through the book pipeline (segment → bible → author an act, fail-closed validate). One chapter → one world. Mutually exclusive with premise/frame_b64/frame_url (sending both → 400); over 40000 chars → 400. Recommend async:true for chapters. Meters one generation; tenancy, mode and author stamping match every other create. subject_ref is NOT yet supported with text (sending both → 400) — to carry a character across chapters, author each chapter with premise/frame + subject_ref.

Maximum string length: 40000

world

object

IMPORT mode: a complete compiled SMWorld to store verbatim. When present, generation is skipped and the response is 201 with imported:true. name/description (below) override the blob's own.

name

string

description

string

IMPORT mode: overrides the imported blob's description.

pov

string

default:third_person_shoulder

GENERATE mode only.

async

boolean

default:false

GENERATE mode: queue a durable job and return 202 with a jobId instead of generating inline. Poll GET /v1/jobs/{jobId}. (Ignored by import and by test-mode keys, which return synchronously.)

subject_ref

object

GENERATE mode: a canonical-character reference (subjectRef) for cross-scene consistency — the PIXEL counterpart of the prose subject lock. When present, the opening seed is painted FROM this character and the reference is stored on the world as subjectRef {imageUrl, descriptor}, so later scenes/levels/chapters regenerate seeds that keep the same face, build, hair and clothing (see POST /v1/worlds/{id}/scenes). A image_b64 is hosted to a durable URL first. Threads through the async job path too. FAIL CLOSED: if a supplied image_b64 cannot be hosted the request returns 502 (no world is created) rather than silently dropping the reference.

Show child attributes

Response

World created (generate, sync)

worldId

string<uuid>

slug

string | null

boolean

Whether the kernel author landed clean.

cover

string

schemaVersion

string

Example:

"1.0"

mock

boolean

Present and true only for TEST-mode keys — a deterministic sandbox response, no real generation. See Testing.

Get a world

Create a world (generate or import)

curl --request POST \
  --url https://api.alakazam.gg/v1/worlds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "premise": "<string>",
  "frame_b64": "<string>",
  "frame_url": "<string>",
  "text": "<string>",
  "world": {},
  "name": "<string>",
  "description": "<string>",
  "pov": "third_person_shoulder",
  "async": false,
  "subject_ref": {
    "image_b64": "<string>",
    "image_url": "<string>",
    "descriptor": "<string>"
  }
}
'

import requests

url = "https://api.alakazam.gg/v1/worlds"

payload = {
    "premise": "<string>",
    "frame_b64": "<string>",
    "frame_url": "<string>",
    "text": "<string>",
    "world": {},
    "name": "<string>",
    "description": "<string>",
    "pov": "third_person_shoulder",
    "async": False,
    "subject_ref": {
        "image_b64": "<string>",
        "image_url": "<string>",
        "descriptor": "<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({
    premise: '<string>',
    frame_b64: '<string>',
    frame_url: '<string>',
    text: '<string>',
    world: {},
    name: '<string>',
    description: '<string>',
    pov: 'third_person_shoulder',
    async: false,
    subject_ref: {image_b64: '<string>', image_url: '<string>', descriptor: '<string>'}
  })
};

fetch('https://api.alakazam.gg/v1/worlds', 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",
  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([
    'premise' => '<string>',
    'frame_b64' => '<string>',
    'frame_url' => '<string>',
    'text' => '<string>',
    'world' => [
        
    ],
    'name' => '<string>',
    'description' => '<string>',
    'pov' => 'third_person_shoulder',
    'async' => false,
    'subject_ref' => [
        'image_b64' => '<string>',
        'image_url' => '<string>',
        'descriptor' => '<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"

	payload := strings.NewReader("{\n  \"premise\": \"<string>\",\n  \"frame_b64\": \"<string>\",\n  \"frame_url\": \"<string>\",\n  \"text\": \"<string>\",\n  \"world\": {},\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"pov\": \"third_person_shoulder\",\n  \"async\": false,\n  \"subject_ref\": {\n    \"image_b64\": \"<string>\",\n    \"image_url\": \"<string>\",\n    \"descriptor\": \"<string>\"\n  }\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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"premise\": \"<string>\",\n  \"frame_b64\": \"<string>\",\n  \"frame_url\": \"<string>\",\n  \"text\": \"<string>\",\n  \"world\": {},\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"pov\": \"third_person_shoulder\",\n  \"async\": false,\n  \"subject_ref\": {\n    \"image_b64\": \"<string>\",\n    \"image_url\": \"<string>\",\n    \"descriptor\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"premise\": \"<string>\",\n  \"frame_b64\": \"<string>\",\n  \"frame_url\": \"<string>\",\n  \"text\": \"<string>\",\n  \"world\": {},\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"pov\": \"third_person_shoulder\",\n  \"async\": false,\n  \"subject_ref\": {\n    \"image_b64\": \"<string>\",\n    \"image_url\": \"<string>\",\n    \"descriptor\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "ok": true,
  "cover": "<string>",
  "schemaVersion": "1.0",
  "mock": true
}

{
  "worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "slug": "<string>",
  "imported": true,
  "schemaVersion": "1.0"
}

{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phase": "<string>",
  "progress": 123,
  "worldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "actsDone": 123,
  "actsTotal": 123,
  "error": "<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>",
  "errors": [
    "<string>"
  ],
  "schemaVersion": "<string>"
}

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

Apps & Keys

Worlds

API Reference

Scenario Studio

Sessions

Characters

Vision

Usage

Webhooks

Graph editing

Versions

Simulation & Data

Create a world (generate or import)

Authorizations

Headers

Body

Response