Skip to main content
POST
/
v1
/
worlds
/
{id}
/
lint
Lint (advisory)
curl --request POST \
  --url https://api.alakazam.gg/v1/worlds/{id}/lint \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "ok": true,
  "diagnostics": [
    {
      "lint": "<string>",
      "path": "<string>",
      "message": "<string>",
      "loc": {
        "field": "<string>",
        "template": "<string>",
        "slot": "<string>",
        "fill": "<string>"
      }
    }
  ],
  "counts": {
    "error": 123,
    "warning": 123,
    "info": 123
  },
  "promptBudget": 1900
}

Authorizations

Authorization
string
header
required

An app API key, e.g. Authorization: Bearer sk_live_…. Secret (sk_) for writes/sessions; publishable (pk_) for read/embed.

Path Parameters

id
string<uuid>
required

Body

application/json

Optional override; omit to lint the stored world.

world
object

A playable world. The full contract is published as JSON Schema at https://alakazam.gg/schema/smworld-1.0.json (see schema/COMPATIBILITY.md). Additional optional properties are allowed (forward-compatible).

data
object

A playable world. The full contract is published as JSON Schema at https://alakazam.gg/schema/smworld-1.0.json (see schema/COMPATIBILITY.md). Additional optional properties are allowed (forward-compatible).

Response

Lint report

ok
boolean
diagnostics
object[]
counts
object
promptBudget
integer

The per-prompt character budget assembled prompts must stay under.

Example:

1900