Check a Jabbertoon cartoon, scene, move, pack or character

Checks a cartoon, with the studio's own checks, before anyone sees it. Give one of cartoon, program, pack, character or file. Returns errors (it will not play as written: also a character or background the site lacks) and warnings, each {code, where, says, fix, url}, with did_you_mean and an RFC 6902 patch when certain; issues a viewer would see (off stage, overlapping, an empty stage, a line cut off) with a summary of who is where and says what when (seconds; x as a share of the stage); and, when ok, the canonical program and a link. repair: true also returns the program with every certain patch applied. Nothing you send is kept. Example: list_characters' cartoon_example.

post/api/validate

Request

  • Base URL: https://jabbertoon.com
  • URL: https://jabbertoon.com/api/validate
  • Auth: none required

Request body

programobject

A move (get_move gives ready-made ones) or a scene program.

packobject

A whole pack: its manifest and its content.

characterobject

Your own character, {"name", "content"}, or a character pack.

filestring

On your own computer only: a .json or .txt file's name in the output folder.

repairboolean

true: also return repaired: the program with every certain patch applied, and the changes.

Response

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

okboolean required

True when there are no errors.

urlstring required

The page that describes this format.

checkedstring

What was checked: program, character, pack or cartoon.

kindstring nullable

The program's kind (behaviour, scene, cartoon), character, or the pack's type.

error_countinteger

How many errors the checks found.

warning_countinteger

How many warnings the checks found.

summaryobject nullable

What the cartoon shows: its length, its cast, and per scene who is where, who says what when and the captions (seconds; x as a share of the stage).

play_checkobject nullable

On your own computer: the cartoon played as a video would (ok, ran_s, cut, errors). Online: null.

textstring nullable

The program as screenplay text (on your own computer; null online, and text_reason says why).

text_reasonstring
programobject nullable

The program that was checked, as canonical JSON (a cartoon file's cast and places merged in).

linkstring nullable

When ok: a jabbertoon.com link that opens it (share_link gives the same).

repairedobject

With repair: true: {program, text (when the cartoon was sent as screenplay text, on the local door: the repaired program written as text), changes: [{code, where, from, to}], ok, error_count, warning_count}.

notesstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.