---
title: "Make a jabbertoon.com link that opens a cartoon, a move or a character"
method: POST
path: "/api/share_link"
---

# Make a jabbertoon.com link that opens a cartoon, a move or a character

`POST /api/share_link`

## Request

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

Turns a cartoon, a scene, a move or a character into a jabbertoon.com link: a move opens in the block editor, the rest in the studio. It all travels after the #: nothing is uploaded or kept. All but a character's end with &from=ai (the page says an AI helper wrote it). One with errors gets them instead. Give one of cartoon, program, character or file. Example: {"program": {"v": 1, "kind": "behaviour", "scripts": [{"body": [{"op": "hop"}]}]}}.

## Request body

- object
  - `cartoon` union: Its program, a cartoon file {cast, places?, program}, or its screenplay text (read on your own computer only).
    - object
    - string
  - `program` object: A move (kind "behaviour"), a scene or a cartoon program.
  - `character` object: Your own character, {"name", "content"}, or a character pack.
  - `file` string: On your own computer only: a file's name in the output folder.

## Response `200`

What share_link 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 jabbertoon.com page the link opens.
  - `kind` string, nullable: behaviour, scene, cartoon or character.
  - `link` string: The link to give the person.
  - `links` object: Every page that opens it: studio, blocks, create.
  - `code` string: The share code after #c=: "1.", base64url of the raw DEFLATE of the UTF-8 canonical JSON, ".", base64url of its CRC-32.
  - `length` integer: The link's length in characters.
  - `errors` Problem[]: The errors, in order: the first 50 at most (error_count says how many there are).
    - `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.
  - `error_count` integer: How many errors the checks found.
  - `warnings` Problem[]: The warnings, in order: the first 50 at most (warning_count says how many there are).
    - `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.
  - `warning_count` integer: How many warnings the checks found.
  - `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)