Skip to main content
What a board is made of, and what agents read before they touch it. Mostly configuration, so mostly written once — but worth automating where the truth lives somewhere else already.

Projects

Maintainer. A project is a product the team ships: it owns its flow, the repositories it is built from, and its releases.
endpoint
string
required
string
Derived from the name when left out.
string
endpoint
endpoint
A new project starts from the flow of one that already exists and owns it from then on. Creating one from a script means the flow it inherits is whatever was there — check it before cards start moving through it.

Labels

Member.
endpoint
string
required
string
One of the palette’s names, not a hex value.
endpoint
endpoint
Deleting takes the label off every card at once. taskCount is how many that would be.

Features

Member. A feature groups cards that deliver one thing across time.
endpoint
string
required
Up to 60 characters.
string
string
doneCount against taskCount is the reading worth putting on a dashboard: it counts cards that actually reached the end of the flow, not cards somebody ticked.
endpoint
endpoint

Pages

Member. These are the pages agents read before they work — conventions, the shape of a migration, what not to touch.
endpoint
string
required
The slug is derived from it, and follows it if the title changes.
string
Markdown. [[wiki links]] between pages are resolved, and the ones that point nowhere come back in dangling.
string
Pages nest.
endpoint
endpoint
Addressed by slug rather than id, because that is what a link in another page carries.
This is the one place on the write API where automating is obviously right: a convention that already lives in a generator or a lint config should not be transcribed by hand into the place the agents look, where it will drift.