> ## Documentation Index
> Fetch the complete documentation index at: https://docs.alakazam.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Lint (advisory)

> Run the doctrine lints advisorily — this NEVER returns 4xx on doctrine hits. Lints an inline `world`/`data` override if provided, else the stored world. `ok` is true when there are zero error-severity findings.




## OpenAPI

````yaml /alakazam-v1.yaml post /v1/worlds/{id}/lint
openapi: 3.1.0
info:
  title: Alakazam — Programmable Worlds API
  version: '1.0'
  description: >
    **Alakazam is the programmable worlds API.** Generate playable, AI-rendered
    worlds from a prompt or an image, program their logic, and embed them in
    your own products and games.


    A world is *programmable*: a live graph of states and events you generate,
    then read, edit, fork, drive, and react to through the API. Two surfaces: a
    **Creation API** (generate, read, manage, fork worlds) and a **Runtime/Embed
    API** (mint short-lived session tokens your end-users' browsers use to boot
    an embedded world).


    **Authentication.** Two schemes. Management endpoints (`/v1/apps*`) use your
    Supabase user session. Data endpoints use an **API key** issued per app:
    `pk_…` (publishable, browser-safe, read + embed) and `sk_…` (secret,
    server-only, create worlds + mint sessions). Never ship a secret key to a
    browser.


    **Usage & quota.** Generations and session mints are metered per app and
    reserved before any GPU spend; exceeding the daily quota returns `402`.
servers:
  - url: https://api.alakazam.gg
    description: Production (placeholder — set to your conjure-service host)
security: []
tags:
  - name: Apps & Keys
    description: >-
      Create apps (tenants) and manage API keys. Authenticated with your user
      session.
  - name: Worlds
    description: >-
      Create, read, manage, and fork SMWorld games. Authenticated with an API
      key.
  - name: Graph editing
    description: >
      Read and program a world's graph — states (nodes), events (edges), and the
      entrance — with deterministic CRUD, a batch op vocabulary, a
      natural-language kernel-agent edit, and the kernel validate/lint gate.
      Every write is validated fail-closed before it persists. Authenticated
      with an API key.
  - name: Versions
    description: >
      Snapshot, branch, check out, and diff a world's graph. Versions form a
      branching tree of full snapshots; a HEAD pointer tracks the working graph.
      Authenticated with an API key.
  - name: Characters
    description: >
      Create, manage, and talk to characters — a SMWorld subtype that pairs a
      stance-graph with a "brain" (persona, lore, voice). CRUD is authenticated
      with an API key; the live talk turn (/say) and voice (/tts) are called
      from the browser with a short-lived session token.
  - name: Sessions
    description: Mint short-lived runtime tokens for embedding a world.
  - name: Usage
    description: Per-app usage and quota.
  - name: Webhooks
    description: >-
      Register HTTPS endpoints to receive signed server-side event
      notifications. Managed with your user session.
paths:
  /v1/worlds/{id}/lint:
    post:
      tags:
        - Graph editing
      summary: Lint (advisory)
      description: >
        Run the doctrine lints advisorily — this NEVER returns 4xx on doctrine
        hits. Lints an inline `world`/`data` override if provided, else the
        stored world. `ok` is true when there are zero error-severity findings.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: object
              description: Optional override; omit to lint the stored world.
              properties:
                world:
                  $ref: '#/components/schemas/SMWorld'
                data:
                  $ref: '#/components/schemas/SMWorld'
      responses:
        '200':
          description: Lint report
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                  diagnostics:
                    type: array
                    items:
                      $ref: '#/components/schemas/KernelDiagnostic'
                  counts:
                    type: object
                    properties:
                      error:
                        type: integer
                      warning:
                        type: integer
                      info:
                        type: integer
                  promptBudget:
                    type: integer
                    example: 1900
                    description: >-
                      The per-prompt character budget assembled prompts must
                      stay under.
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    SMWorld:
      type: object
      description: >
        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).
      additionalProperties: true
      required:
        - id
        - name
        - entrance
        - scene
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        cover:
          type: string
        entrance:
          type: object
          required:
            - image
            - state
          properties:
            image:
              type: object
              required:
                - src
              properties:
                label:
                  type: string
                src:
                  type: string
                  description: Seed image for the boot.
            state:
              type: string
              description: Initial state id.
        scene:
          type: object
          required:
            - states
            - events
          properties:
            states:
              type: object
              additionalProperties: true
            events:
              type: array
              items:
                type: object
                additionalProperties: true
    KernelDiagnostic:
      type: object
      description: >
        A single finding from the kernel grammar + doctrine lint suite.
        STRUCTURAL lints (e.g. `dangling-ref`, `transition-needs-to`,
        `kernel-cycle`, `slot-*`) are always fatal `error`s and block the write
        (422). Doctrine/budget lints (e.g. `negation`, `whiteout`,
        `lethal-override`, `budget`) are advisory and surface as
        `warning`/`info`.
      required:
        - lint
        - severity
        - path
        - message
      properties:
        lint:
          type: string
          description: The lint id (e.g. `dangling-ref`, `negation`, `budget`).
        severity:
          type: string
          enum:
            - error
            - warning
            - info
        path:
          type: string
          description: Human-readable location, e.g. `event[Step outside].movement.static`.
        message:
          type: string
          description: What is wrong and, where possible, how to fix it.
        loc:
          type: object
          description: Structured location for editor/narrator UIs.
          properties:
            field:
              type: string
            template:
              type: string
            slot:
              type: string
            fill:
              type: string
    Error:
      type: object
      properties:
        detail:
          type: string
          description: Human-readable error message.
        errors:
          type: array
          items:
            type: string
          description: Field-level validation errors (e.g. on 422 from POST /v1/worlds).
        schemaVersion:
          type: string
      required:
        - detail
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        An app API key, e.g. `Authorization: Bearer sk_live_…`. Secret (`sk_`)
        for writes/sessions; publishable (`pk_`) for read/embed.

````