Chalkline API · free · no key · no Grok credits
Use Chalkline from your own app
Think of this like a temp-mail API. You do not log in. You send a small JSON “recipe.” Chalkline sends back a full board file. Then a human (or you) opens that file in the studio and hits play.
Cost
Free. No key. Does not spend Grok, OpenAI, or OpenRouter.
Limit
60 calls a minute per visitor. That’s a lot.
What you get
A .json board. Not an MP4. The studio still draws the film.
If you only remember four steps
- 1
Ping (optional)
Open
https://your-chalkline-site/api/chalkline?action=pingin a tab. You should see"service": "chalkline". If you do, the API is up. - 2
Send a tiny recipe, not a movie
POST JSON with a name, aspect (
16:9or9:16), and scenes. Each scene is alayout, a shorttitle, and acaption(the spoken line). Do not send 10 MB photos here. - 3
Save the `board` object
The reply looks like
{ service, ok, board }. Ifokis true, downloadboardas a.jsonfile. - 4
Import it in the studio
Chalkline → Open studio → Import JSON → Play. Drop photos after if you need them. Export WebM or MP4 from there.
Copy-paste this
Works in a vibe-coded site, Cursor, or the browser console. Change the titles. Don’t overthink it.
// Paste this in your app, Cursor, or a browser console on any site.
const res = await fetch("https://your-chalkline-site/api/chalkline/boards", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
name: "My first board",
aspect: "16:9",
background: "whiteboard",
scenes: [
{
layout: "title",
title: "Hello Chalkline",
caption: "The hand will draw this headline."
},
{
layout: "steps",
title: "Three beats",
caption: "Incise, open, close.",
items: [
{ icon: "scalpel", label: "Incise" },
{ icon: "sinus", label: "Window" },
{ icon: "check", label: "Close" }
]
}
]
})
});
const data = await res.json();
if (!data.ok) throw new Error(data.error);
download(data.board); // see helper below
function download(board) {
const blob = new Blob([JSON.stringify(board, null, 2)], { type: "application/json" });
const a = document.createElement("a");
a.href = URL.createObjectURL(blob);
a.download = (board.name || "chalkline-board") + ".json";
a.click();
}Try it on this page
https://your-chalkline-site/api/chalkline
Tell your AI this
Paste the block below into ChatGPT / Cursor / Claude when you want it to drive Chalkline for you.
You are talking to the Chalkline API, a free whiteboard-board compiler.
Base: https://your-chalkline-site/api/chalkline
No API key. No Grok. No MP4. You send a small storyboard, you get a board JSON.
Do this:
1. GET https://your-chalkline-site/api/chalkline?action=directing and follow those rules.
2. GET https://your-chalkline-site/api/chalkline?action=icons if you need icon ids.
3. POST https://your-chalkline-site/api/chalkline/boards with JSON:
{ name, aspect: "16:9"|"9:16", background: "whiteboard", scenes: [...] }
Each scene: { layout, title, caption, items?: [{ icon, label }] }
Layouts: title, hero, steps, list, compare, timeline, grid, cycle, quote, close.
Mix layouts. Captions are the spoken line. Titles stay short.
4. If ok, give the human the board JSON as a downloadable .json file.
5. Tell them: open Chalkline studio → Import JSON → Play → Export.
Never put photos in createBoard. Never claim you returned a video file.Layouts you can send
title— Big headline + subtitlehero— Headline with one supporting linesteps— 3–4 icon + label beatslist— Numbered linescompare— Left vs righttimeline— A sequencegrid— 2×2 cardscycle— Things that loopquote— A line someone saidclose— The takeaway
Mix them. Two scenes in a row with the same layout looks copy-pasted. Icon names come from GET https://your-chalkline-site/api/chalkline?action=icons.
Every action
| Call | When to use it |
|---|---|
| GET ?action=ping | Is the API awake? |
| GET ?action=icons | What icon ids can I put on a scene? |
| GET ?action=directing | Rules so an agent doesn’t make a boring board |
| POST ?action=createBoard | Turn my recipe into a board JSON |
| POST ?action=validateBoard | I already have a big JSON — is it ok? |
REST aliases if you hate query strings: POST /api/chalkline/boards and POST /api/chalkline/boards/validate.
Don’t do these
- Don’t send photos through createBoard. Add pictures later in the studio, or in a full JSON you already have.
- Don’t expect an MP4 back. This API builds the board. The website draws it.
- Don’t put a Grok / OpenAI key in the request. This door doesn’t use one.
- Don’t write 12 scenes that are all “title + image.” Mix layouts.
- Don’t hammer it. 60 calls a minute is the cap; retry after a pause.