---
title: "Read Jabbertoon's guide for writing a cartoon"
method: POST
path: "/api/get_guide"
---

# Read Jabbertoon's guide for writing a cartoon

`POST /api/get_guide`

## Request

- Base URL: `https://jabbertoon.com`
- URL: `https://jabbertoon.com/api/get_guide`
- Auth: none required

Call this first. Returns one topic of Jabbertoon's guide as Markdown (under 20,000 characters): start (what it makes and the order of calls), cartoon (the JSON program: cast, scenes, lines, moves), text (the same cartoon as screenplay text), moves, characters, looks, voices, places, errors, limits, build (the 3D builder's steps), export (a build as a 3D printer's STL or 3MF, glTF for Blender, SVG blueprints, Minecraft), world (a world of blocks), walk (a place to walk), game (a game's steps), song (the editor's own file: Studio characters, lines, moves, camera shots and a song the cast sings). Units everywhere: x and y are shares of the stage (0 to 1, the ground at 0.92), times are seconds. Example: {"topic": "cartoon"}.

## Request body

- object
  - `topic` 'start' | 'cartoon' | 'text' | 'moves' | 'characters' | 'looks' | 'voices' | 'places' | 'errors' | 'limits' | 'build' | 'game' | 'song' | 'walk' | 'export' | 'shapes' | 'examples' | 'keys' | 'world': Leave it out for start, which names the others.

## Response `200`

What get_guide answers. ok is false when what you sent has problems; they are listed with where, says and fix.

- object
  - `ok` boolean, required
  - `url` string, required: The page on jabbertoon.com this topic comes from.
  - `topic` string
  - `title` string
  - `text` string: The topic, as Markdown.
  - `characters` integer: How long text is, in characters.
  - `topics` object[]: Every topic, in order.
    - `topic` string
    - `title` string
  - `as_of` string: The date of the catalog the lists in it come from.
  - `engine` Engine
    - `version` string: The block language's version.
    - `git` string: The git tree id of the engine that answered (the same on every door).
  - `notes` string[]
  - `error` Problem
    - `code` string, required
    - `where` string, nullable, required
    - `says` string, required
    - `fix` string, nullable, required
    - `url` string: The code's entry on https://jabbertoon.com/docs/errors/.
    - `did_you_mean` string[]
    - `patch` object[]: RFC 6902 operations on what you sent that make the fix, given only when the fix is certain.

## Other responses

- `4XX`: A request the server cannot use (400 bad_arguments, 404 not_found, 405, 413 too_large, 415, 503 busy or timeout: try again after Retry-After).
- `5XX`: A request the server cannot use (400 bad_arguments, 404 not_found, 405, 413 too_large, 415, 503 busy or timeout: try again after Retry-After).

---

[API](https://skmtc.dev/jabbertoon/apis/jabbertoon-tools-for-ai-assistants-and-developers.md) · [All operations](https://skmtc.dev/jabbertoon/apis/jabbertoon-tools-for-ai-assistants-and-developers/llms.txt) · [OpenAPI document](https://skmtc.dev/jabbertoon/apis/jabbertoon-tools-for-ai-assistants-and-developers/revisions/004970e97459?raw)