Block schema reference
Every block a page or a front page can hold, every attribute it takes, the JSON type of each one, and the values the validator accepts. Generated from the validator itself, so it cannot disagree with a write. The same data is served as JSON — for a script, or to generate types from:
curl https://forumulate.com/api/docs/block-schemaEach block also has a Markdown spelling (Markdown directives), and the section library hands out whole bands built from these blocks (Section library). The keys of each space type’s theme namespace — theme.faq, theme.blog and the rest — are typed the same way in Theme namespaces.
Numbers written as strings. The Markdown dialect writes every attribute as a string (::column{width="60"}). Block JSON takes a number; where a row says “Also accepts a numeric string”, "60" is accepted too and stored as 60. Anything else that is not a number — "60%", "" — is a 422 naming the path.
Reading the tables
Path is where the value goes, from the block’s
attrs.columns[]is an array of objects with the keys listed under it;.*is each value of a record (an object whose keys are listed under Values);.0and.1are the positions of a fixed-length pair.Type is the JSON type the validator takes.
enumtakes exactly the listed values — numbers as numbers (heading.attrs.levelis2, not"2"). A type likeenum | stringtakes one of the words, or any string (a theme colour token or a#hex).Values / range is the closed list, a number’s bounds, or a string’s length.
Required is blank for an optional key: leave it out and the default applies.
Same keys as means the object takes exactly the keys already listed under that path.
Blocks (87)
audience
Holds blocks (required). Markdown directive: audience.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| yes | ||
|
| |||
|
| yes |
blockquote
Holds blocks (required).
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
| up to 300 chars | ||
|
| |||
|
| 14–96 | ||
|
|
|
bulletList
Holds blocks (required).
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| |||
|
| 8–160 | ||
|
| 8–160 | ||
|
| 8–160 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 100–900 |
button
Holds nothing. Markdown directive: button.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
| |||
|
| up to 80 chars | An icon name from | |
|
| yes | ||
|
| up to 300 chars | ||
|
| |||
|
|
| ||
|
| |||
|
|
|
buttons
Holds blocks (required). Markdown directive: buttons.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
|
card
Holds nothing. Markdown directive: card.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 24 chars | ||
|
|
| ||
|
| |||
|
| up to 40 chars | ||
|
| |||
|
| |||
|
| up to 80 chars | An icon name from | |
|
|
| ||
|
| |||
|
| up to 40 chars | ||
|
| yes |
cards
Holds blocks (required). Markdown directive: cards.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
| |||
|
|
| ||
|
| 1–6 | ||
|
| 1–6 | ||
|
| 1–6 | ||
|
| 1–6 | ||
|
|
| ||
|
| 12–24 | ||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–120 | ||
|
| 12–64 | ||
|
| 160–480 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 32–96 | ||
|
| 12–24 | ||
|
|
| ||
|
|
|
carousel
Holds blocks (required). Markdown directive: carousel.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
| |||
|
| |||
|
|
| ||
|
| 2000–30000 | ||
|
| up to 120 chars | ||
|
| |||
|
| 1–6 | ||
|
| 1–4 | ||
|
| 1–3 |
carouselSlide
Holds blocks (required). Markdown directive: slide.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 120 chars |
checklist
Holds blocks (required).
No attributes of its own.
checklistItem
Holds blocks (required).
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| yes |
codeBlock
Holds text.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
| |||
|
| |||
|
| |||
|
|
| ||
|
| |||
|
| |||
|
| |||
|
| 0–1000000 | ||
|
|
| ||
|
| 1–80 chars | ||
|
| 3–500 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| |||
|
| |||
|
| up to 20000 chars | ||
|
| 40–800 | ||
|
|
| ||
|
|
| ||
|
| |||
|
| up to 40 chars | ||
|
| up to 20 chars | ||
|
| |||
|
|
| ||
|
| |||
|
| |||
|
| |||
|
| yes | ||
|
| 0–100000 | yes | |
|
| 0–100000 | yes | |
|
| 0–100000 | yes | |
|
| up to 2000 chars | yes | |
|
| yes | Same keys as | |
|
| yes | ||
|
| 0–100000 | yes | |
|
| up to 2000 chars | yes | |
|
| 0–100000 | yes | |
|
|
codeGroup
Holds blocks (required). Markdown directive: codeGroup.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| 0–1000000 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| up to 40 chars | ||
|
|
| ||
|
| up to 200 chars | ||
|
|
| ||
|
|
column
Holds blocks (required). Markdown directive: column.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| |||
|
| 5–95 | Percent of the row (5–95). Absent = an equal share. Also accepts |
columns
Holds blocks (required). Markdown directive: columns.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
|
| ||
|
| up to 500 chars | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
|
|
contactForm
Holds nothing. Markdown directive: contactform.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 1000 chars | ||
|
| up to 64 chars | yes | |
|
| up to 60 chars | ||
|
| up to 200 chars | ||
|
| up to 60 chars |
corrections
Holds nothing. Markdown directive: corrections.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 80 chars | ||
|
| yes | ||
|
| `` | yes | |
|
| up to 4000 chars | ||
|
| up to 1000 chars | yes | |
|
|
|
customCode
Holds nothing. Markdown directive: customcode.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 10000 chars | ||
|
| up to 20000 chars | yes |
drawing
Holds nothing.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| yes |
embed
Holds nothing. Markdown directive: embed.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| yes |
errorCodes
Holds nothing. Markdown directive: errorCodes.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| yes | ||
|
| yes | ||
|
| up to 400 chars | ||
|
| 100–599 | ||
|
| up to 80 chars |
event
Holds nothing. Markdown directive: event.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 200 chars | yes | |
|
|
| ||
|
| |||
|
| |||
|
| |||
|
| yes |
eventRsvp
Holds nothing. Markdown directive: rsvp.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
| up to 200 chars | yes | |
|
| up to 80 chars | ||
|
| |||
|
| |||
|
| yes |
example
Holds blocks (required). Markdown directive: example.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| yes | |
|
| up to 80 chars |
expandable
Holds blocks (required). Markdown directive: expandable.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
|
| ||
|
|
| ||
|
| yes |
expandableGroup
Holds blocks (required). Markdown directive: expandablegroup.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
|
|
extensionBlock
Holds nothing.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| yes | ||
|
| yes | ||
|
| yes | ||
|
|
field
Holds blocks (required). Markdown directive: field.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 24 chars | ||
|
| up to 200 chars | ||
|
| |||
|
|
| ||
|
| 1–120 chars | yes | |
|
| |||
|
| up to 80 chars |
file
Holds nothing.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
| yes |
fileTree
Holds blocks (required). Markdown directive: filetree.
No attributes of its own.
form
Holds nothing. Markdown directive: form.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 500 chars | ||
|
| up to 1000 chars | ||
|
| yes | ||
|
| up to 500 chars | ||
|
| up to 60 chars | ||
|
| up to 200 chars | yes | |
|
| up to 60 chars | ||
|
| |||
|
| |||
|
| up to 40 chars | yes | |
|
| up to 120 chars | ||
|
| up to 200 chars | ||
|
| up to 200 chars | ||
|
| |||
|
| |||
|
| |||
|
| up to 40 chars | yes | |
|
| up to 20 chars | yes | |
|
| up to 200 chars | ||
|
|
| yes | |
|
| up to 500 chars | ||
|
| up to 64 chars | yes | |
|
|
| ||
|
| up to 2048 chars | ||
|
| up to 60 chars | ||
|
| up to 1000 chars | ||
|
| up to 200 chars |
gallery
Holds blocks (required). Markdown directive: gallery.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
| 2–6 | ||
|
|
| ||
|
|
grid
Holds blocks (required). Markdown directive: grid.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| 1–12 | ||
|
|
|
gridItem
Holds blocks (required). Markdown directive: gridItem.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 1–12 | yes | |
|
| 1–12 | ||
|
| |||
|
| 0–360 | ||
|
| yes | ||
|
| 0–100 | ||
|
|
| yes | |
|
|
| yes | |
|
| |||
|
| 0–360 | ||
|
| yes | ||
|
| 0–100 | ||
|
|
| yes | |
|
|
| yes | |
|
| |||
|
| up to 2048 chars | A glyph name from | |
|
|
| ||
|
| 1–12 | ||
|
|
| ||
|
|
| ||
|
| 1–20 | ||
|
| 1–100 | ||
|
|
| ||
|
| 1–12 | ||
|
|
|
heading
Holds text.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
| up to 2048 chars | A glyph name from | |
|
| |||
|
|
| ||
|
|
| yes | |
|
| 0.9–2 | ||
|
| |||
|
| yes | ||
|
| 1–80 chars | yes | |
|
|
| ||
|
|
| ||
|
| |||
|
| 8–160 | ||
|
| 8–160 | ||
|
| 8–160 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
| -0.2–0.5 | ||
|
|
| ||
|
| 100–900 |
hero
Holds nothing. Markdown directive: hero.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
| yes | ||
|
| up to 60 chars | yes | |
|
|
| ||
|
| up to 80 chars | ||
|
|
| ||
|
|
| ||
|
| |||
|
| up to 300 chars | ||
|
|
| yes | |
|
| |||
|
| yes | ||
|
|
| ||
|
| up to 160 chars | ||
|
|
| ||
|
| up to 600 chars | ||
|
| up to 240 chars | yes |
hint
Holds blocks (required). Markdown directive: hint.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
| up to 80 chars | An icon name from | |
|
|
| ||
|
|
| yes | Also accepts |
|
| up to 120 chars | ||
|
| 0–24 | ||
|
|
horizontalRule
Holds nothing.
No attributes of its own.
image
Holds nothing.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
| |||
|
|
| ||
|
| up to 2000 chars | ||
|
| |||
|
|
| ||
|
| yes | ||
|
| |||
|
|
|
imageCompare
Holds nothing. Markdown directive: compare.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| yes | ||
|
| up to 300 chars | ||
|
| up to 40 chars | ||
|
| yes | ||
|
| up to 300 chars | ||
|
| up to 40 chars | ||
|
| up to 2000 chars | ||
|
| 0–100 |
layer
Holds nothing. Markdown directive: layer.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| yes | |
|
| 0–1 | ||
|
| -1–1 | ||
|
| -180–180 | ||
|
| 1–40 | ||
|
| |||
|
| up to 120 chars | ||
|
| 100–900 | ||
|
| 1–100 | ||
|
| 0–100 | ||
|
| -50–100 | ||
|
| 0–5 |
listItem
Holds blocks (required).
No attributes of its own.
logoWall
Holds nothing. Markdown directive: logos.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| 2–8 | ||
|
| |||
|
| yes | ||
|
| up to 120 chars | yes | |
|
| |||
|
| yes | ||
|
| |||
|
|
| ||
|
|
| ||
|
| up to 160 chars |
lottie
Holds nothing. Markdown directive: lottie.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 300 chars | ||
|
| |||
|
| 48–2400 | ||
|
|
| ||
|
| 0.2–5 | ||
|
| 25–400 | ||
|
| up to 2048 chars | yes |
marquee
Holds blocks (required). Markdown directive: marquee.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
| |||
|
|
| ||
|
| |||
|
|
|
math
Holds nothing.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| yes |
mermaid
Holds nothing.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| yes |
modal
Holds blocks (required). Markdown directive: modal.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 80 chars | yes | |
|
|
| ||
|
|
| ||
|
| up to 160 chars |
officeMap
Holds nothing. Markdown directive: offices.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
| 1–4 | ||
|
| yes | ||
|
| up to 400 chars | ||
|
| |||
|
| -85.0511–85.0511 | yes | |
|
| -180–180 | yes | |
|
| up to 120 chars | yes | |
|
| up to 240 chars | ||
|
| 2–18 | ||
|
| |||
|
| 2–18 |
openapi
Holds nothing.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
| yes | ||
|
| |||
|
| |||
|
| yes | ||
|
| yes | Recursive: the same shape as the enclosing object of this name. | |
|
| |||
|
| |||
|
| yes | ||
|
| yes | ||
|
| |||
|
|
| ||
|
| yes | ||
|
| |||
|
| yes | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| yes | ||
|
| yes | ||
|
| |||
|
| |||
|
| yes | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| yes | ||
|
| |||
|
| yes | ||
|
| |||
|
| Recursive: the same shape as the enclosing object of this name. | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| yes | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| yes | Same keys as | |
|
| yes | ||
|
| yes | ||
|
| |||
|
| |||
|
| |||
|
| yes | ||
|
| |||
|
| yes | ||
|
| Same keys as | ||
|
| |||
|
| yes | ||
|
| |||
|
| |||
|
| yes | Same keys as | |
|
| yes | ||
|
| |||
|
| |||
|
| yes | ||
|
| |||
|
| |||
|
| yes | ||
|
|
| yes | |
|
| yes | ||
|
| yes | ||
|
| |||
|
|
| yes | |
|
| |||
|
| |||
|
| yes | ||
|
| |||
|
| |||
|
| yes | ||
|
| |||
|
| |||
|
| |||
|
|
| ||
|
|
orderedList
Holds blocks (required).
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| |||
|
| 8–160 | ||
|
| 8–160 | ||
|
| 8–160 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 100–900 |
paragraph
Holds text.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
|
| ||
|
| |||
|
| 8–160 | ||
|
| 8–160 | ||
|
| 8–160 | ||
|
|
| ||
|
| 100–900 |
person
Holds nothing. Markdown directive: person.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 600 chars | ||
|
|
| ||
|
| |||
|
| yes | ||
|
| up to 60 chars | yes | |
|
| up to 120 chars | yes | |
|
| |||
|
| up to 300 chars | ||
|
|
| ||
|
| up to 120 chars |
playground
Holds nothing. Markdown directive: playground.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 20000 chars | ||
|
| |||
|
| up to 300 chars | ||
|
| up to 300 chars | ||
|
| |||
|
| 120–1200 | ||
|
| up to 20000 chars | ||
|
| up to 20000 chars | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| up to 120 chars |
pricing
Holds nothing. Markdown directive: pricing.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 8 chars | ||
|
| 0–3 | ||
|
|
| ||
|
| yes | ||
|
| up to 40 chars | yes | |
|
| up to 20 chars | ||
|
| yes | ||
|
| up to 40 chars | ||
|
| |||
|
| yes | ||
|
| up to 60 chars | yes | |
|
| up to 400 chars | ||
|
| yes | ||
|
|
| ||
|
| up to 200 chars | yes | |
|
| up to 80 chars | ||
|
| |||
|
| up to 80 chars | yes | |
|
| up to 120 chars | ||
|
| 0–1000000000 | yes |
product
Holds nothing. Markdown directive: product.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 40 chars | ||
|
| 1–4 | ||
|
|
| ||
|
| 1–50 | ||
|
|
| ||
|
| up to 64 chars | yes | |
|
| |||
|
|
productCard
Holds nothing. Markdown directive: productCard.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 40 chars | ||
|
| |||
|
| up to 2048 chars | ||
|
| up to 2048 chars | ||
|
|
| ||
|
| up to 200 chars | ||
|
| 0–1000000000 | ||
|
| |||
|
| |||
|
| up to 40 chars | ||
|
| `` | yes |
prompt
Holds nothing. Markdown directive: prompt.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
|
| ||
|
| |||
|
| |||
|
| 1–40 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| up to 80 chars | An icon name from | |
|
| |||
|
|
| ||
|
|
| ||
|
| 0–6 | ||
|
| 1–6 | ||
|
|
| ||
|
| |||
|
|
| ||
|
| up to 2048 chars | yes | |
|
| up to 40 chars | yes | |
|
| yes | ||
|
|
| ||
|
|
| ||
|
|
quiz
Holds nothing. Markdown directive: quiz.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
| |||
|
| up to 300 chars | yes | |
|
| up to 2000 chars | ||
|
| |||
|
| up to 500 chars | ||
|
|
rateLimit
Holds nothing. Markdown directive: rateLimit.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| 1–10000000 | ||
|
| |||
|
| 1–10000000 | yes | |
|
| up to 300 chars | ||
|
| up to 60 chars | ||
|
|
| yes |
reusableRef
Holds nothing. Markdown directive: reusable.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 200 chars | ||
|
| yes | ||
|
| |||
|
| up to 500 chars |
section
Holds blocks (required).
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
|
| ||
|
|
| ||
|
| |||
|
| 0–360 | ||
|
| yes | ||
|
| 0–100 | ||
|
|
| yes | |
|
|
| yes | |
|
| |||
|
| 0–360 | ||
|
| yes | ||
|
| 0–100 | ||
|
|
| yes | |
|
|
| yes | |
|
| |||
|
|
| ||
|
| |||
|
|
| yes | |
|
| 0–1 | yes | |
|
|
| ||
|
|
| ||
|
| yes | ||
|
| Same keys as | ||
|
| |||
|
| |||
|
| yes | ||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–8 | yes | |
|
|
| ||
|
| |||
|
|
| ||
|
| 1–40 chars | yes | |
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–360 | ||
|
|
| yes | |
|
|
| yes | |
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
|
sources
Holds nothing. Markdown directive: sources.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 80 chars | ||
|
| yes | ||
|
| `` | ||
|
| up to 200 chars | ||
|
| up to 120 chars | ||
|
| up to 300 chars | yes | |
|
| `` | yes | |
|
| |||
|
|
|
spaceBand
Holds nothing. Markdown directive: band.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| up to 60 chars | ||
|
| yes | ||
|
| up to 500 chars | ||
|
|
| ||
|
|
| ||
|
| up to 60 chars | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
| |||
|
| |||
|
| |||
|
| up to 500 chars | yes | |
|
| 1–90 | ||
|
| up to 80 chars | ||
|
|
| ||
|
|
| ||
|
| up to 120 chars | ||
|
| up to 160 chars | ||
|
| 1–120 chars | ||
|
| up to 200 chars | ||
|
|
| ||
|
| 0.8–2 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 100–900 | ||
|
|
| ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
| 1–120 chars | ||
|
|
| ||
|
| 1–30 | ||
|
| |||
|
| 1–64 chars | ||
|
| up to 300 chars | ||
|
| |||
|
| yes | ||
|
| 1–80 chars | yes | |
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
|
| ||
|
| up to 80 chars | ||
|
| 0–4000 | ||
|
| up to 120 chars | ||
|
| |||
|
|
| ||
|
| |||
|
|
| ||
|
|
| ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
| |||
|
| |||
|
| |||
|
|
| ||
|
| |||
|
| |||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
| up to 60 chars | ||
|
|
| ||
|
| 100–900 |
spaceCategories
Holds nothing. Markdown directive: categories.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
| 1–6 | ||
|
| 1–6 | ||
|
| 1–6 | ||
|
| up to 300 chars | ||
|
|
| ||
|
| up to 200 chars | ||
|
|
| ||
|
| 1–50 | ||
|
|
| ||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
| |||
|
| up to 80 chars | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
| 100–900 | ||
|
| 0–4000 | ||
|
| |||
|
| |||
|
| |||
|
|
| ||
|
| |||
|
| up to 120 chars | ||
|
|
| ||
|
| up to 64 chars | ||
|
| |||
|
|
| ||
|
| 0–4000 | ||
|
| |||
|
| 1–6 | ||
|
| 0–4000 | ||
|
|
| ||
|
| |||
|
|
| ||
|
|
| ||
|
| 16–128 | ||
|
|
| ||
|
| 400–800 | ||
|
|
| ||
|
| 0–5 | ||
|
| 0–5 | ||
|
| 0–5 | ||
|
| 0–5 | ||
|
| |||
|
|
| ||
|
|
| ||
|
| 12–18 |
spaceFeed
Holds nothing. Markdown directive: feed.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
|
| ||
|
| |||
|
| |||
|
| 12–96 | ||
|
|
| ||
|
| |||
|
|
| ||
|
| 0.8–3 | ||
|
| |||
|
| up to 20 chars | ||
|
| |||
|
| up to 8 chars | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| 100–900 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| up to 35 chars | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–6 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 100–900 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
| 0–1 | ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
|
| ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| |||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
| up to 4 chars | ||
|
| 100–900 | ||
|
|
| ||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| -0.1–0.5 | ||
|
| 100–900 | ||
|
| |||
|
|
| ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| -0.1–0.5 | ||
|
| 100–900 | ||
|
| |||
|
|
| ||
|
|
| ||
|
| up to 8 chars | ||
|
| |||
|
|
| ||
|
| |||
|
|
| ||
|
| up to 60 chars | ||
|
| 0–4000 | ||
|
|
| ||
|
| 100–900 | ||
|
| |||
|
| |||
|
| up to 4 chars | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| keys: | ||
|
| 0–4000 | ||
|
| keys: | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
| |||
|
| |||
|
|
| ||
|
| |||
|
| |||
|
|
| ||
|
| |||
|
|
| ||
|
| 0.8–3 | ||
|
| 0.8–3 | ||
|
| 0.8–3 | ||
|
| 0.8–3 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 100–900 | ||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
| |||
|
|
| ||
|
| |||
|
|
| yes | |
|
|
| yes | |
|
| 2–12 | ||
|
|
| ||
|
| 1–12 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–4 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0.8–2 | ||
|
| 0.8–2 | ||
|
| 0.8–2 | ||
|
| 0.8–2 | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| -0.1–0.5 | ||
|
| -0.1–0.5 | ||
|
| -0.1–0.5 | ||
|
| -0.1–0.5 | ||
|
| 100–900 | ||
|
|
| ||
|
| |||
|
| yes | Same keys as | |
|
| 1–80 chars | yes | |
|
| |||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
| |||
|
|
| ||
|
| 0–4000 | ||
|
|
| ||
|
| |||
|
|
| ||
|
|
| yes | |
|
| 0–4000 | ||
|
| |||
|
| 1–6 | ||
|
| 1–6 | ||
|
| 0–400 | ||
|
| 1–6 | ||
|
| |||
|
| |||
|
| up to 300 chars | Shown when the feed is empty. Unset: the default message; "" hides the feed. | |
|
| |||
|
|
| ||
|
| |||
|
| |||
|
| up to 120 chars | ||
|
| |||
|
| up to 120 chars | ||
|
|
| ||
|
| up to 64 chars | ||
|
| up to 60 chars | ||
|
| |||
|
|
| ||
|
| up to 60 chars | ||
|
| |||
|
| |||
|
| up to 120 chars | ||
|
| |||
|
|
| ||
|
|
| ||
|
| |||
|
|
| ||
|
| up to 120 chars | ||
|
|
| ||
|
|
| ||
|
| up to 60 chars | ||
|
| up to 60 chars | ||
|
|
| ||
|
| |||
|
| |||
|
| 0–24 | ||
|
| |||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
|
| ||
|
| |||
|
| |||
|
| |||
|
| |||
|
|
| ||
|
|
| ||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0.8–3 | ||
|
|
| ||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
| |||
|
| |||
|
| up to 300 chars | ||
|
| up to 200 chars | ||
|
| |||
|
|
| ||
|
| 0–4000 | ||
|
| 100–900 | ||
|
| |||
|
| 1–50 | yes | |
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| 0–4000 | ||
|
| up to 500 chars | yes | |
|
| 100–900 | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
| |||
|
| |||
|
|
| ||
|
| Same keys as | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| up to 35 chars | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–6 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 100–900 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| Same keys as | ||
|
| |||
|
| Same keys as | ||
|
|
| ||
|
| Same keys as | ||
|
| Same keys as | ||
|
| |||
|
|
| ||
|
|
| ||
|
| up to 8 chars | ||
|
| Same keys as | ||
|
| |||
|
| |||
|
| up to 4 chars | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| keys: | ||
|
| 0–4000 | ||
|
| keys: | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
| |||
|
| Same keys as | ||
|
| |||
|
|
| ||
|
| 0.8–3 | ||
|
| 0.8–3 | ||
|
| 0.8–3 | ||
|
| 0.8–3 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 100–900 | ||
|
| Same keys as | ||
|
|
| ||
|
| 1–12 | ||
|
|
| ||
|
|
| Same keys as | |
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0.8–2 | ||
|
| 0.8–2 | ||
|
| 0.8–2 | ||
|
| 0.8–2 | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| -0.1–0.5 | ||
|
| -0.1–0.5 | ||
|
| -0.1–0.5 | ||
|
| -0.1–0.5 | ||
|
| 100–900 | ||
|
|
| ||
|
|
| ||
|
| |||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
|
| |
|
| 1–5 | ||
|
|
| ||
|
|
| ||
|
| 0.8–2 | ||
|
| 0.8–2 | ||
|
| 0.8–2 | ||
|
| 0.8–2 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| -0.1–0.5 | ||
|
| -0.1–0.5 | ||
|
| -0.1–0.5 | ||
|
| -0.1–0.5 | ||
|
| 1–50 | ||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 16–48 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 1–4 | ||
|
|
| ||
|
| |||
|
|
| ||
|
|
| ||
|
| |||
|
| up to 24 chars | ||
|
| up to 24 chars | ||
|
| up to 24 chars | ||
|
| up to 24 chars | ||
|
| up to 24 chars | ||
|
| up to 24 chars | ||
|
| |||
|
| |||
|
| 0–… | ||
|
| 0–… | ||
|
| 0–… | ||
|
| |||
|
|
| ||
|
| 0–4000 | ||
|
| |||
|
|
| ||
|
| |||
|
| |||
|
| 16–48 | ||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| |||
|
|
| ||
|
| |||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 64–160 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 40–160 | ||
|
| |||
|
| |||
|
| 1–4 | ||
|
| 1–4 | ||
|
| 1–4 | ||
|
| 1–4 | ||
|
| 0–4000 | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
| up to 60 chars | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
| 100–900 | ||
|
| 0–4000 | ||
|
| |||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
| |||
|
| up to 80 chars | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
| 100–900 | ||
|
| 0–4000 | ||
|
| 0–50 | ||
|
| 1–50 | ||
|
|
| ||
|
| |||
|
| 1–6 | ||
|
|
| ||
|
| |||
|
| 1–6 | ||
|
| 1–6 | ||
|
| 1–6 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| up to 64 chars | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| up to 64 chars | ||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
| up to 60 chars | ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 100–900 | ||
|
| |||
|
| Same keys as | ||
|
| 1–60 chars | yes | |
|
|
| ||
|
| 1–30 | ||
|
|
| ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
| |||
|
|
| ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| |||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
| up to 60 chars | ||
|
|
| ||
|
| 100–900 | ||
|
| |||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
|
| ||
|
| |||
|
|
| ||
|
| 1–12 | ||
|
|
|
spaceLeaderboard
Holds nothing. Markdown directive: leaderboard.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
|
| ||
|
| up to 200 chars | ||
|
| 1–20 | ||
|
|
| ||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
| |||
|
| up to 80 chars | ||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| 0–4000 | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
| 100–900 | ||
|
| 0–4000 | ||
|
|
| ||
|
|
| ||
|
| 10–48 | ||
|
|
| ||
|
| up to 64 chars |
spacer
Holds nothing. Markdown directive: spacer.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
|
| ||
|
|
| ||
|
|
|
stats
Holds nothing. Markdown directive: stats.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
| 2–6 | ||
|
| yes | ||
|
| 0–3 | ||
|
| up to 400 chars | ||
|
| up to 120 chars | yes | |
|
| up to 12 chars | ||
|
| up to 12 chars | ||
|
| -1000000000000–1000000000000 | yes | |
|
|
|
step
Holds blocks (required). Markdown directive: step.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
| up to 24 chars | ||
|
| up to 80 chars | An icon name from | |
|
|
stepper
Holds blocks (required). Markdown directive: stepper.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
|
| ||
|
| 12–32 |
story
Holds blocks (required). Markdown directive: story.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 120 chars | ||
|
|
| ||
|
|
| ||
|
| 0–240 |
storyStep
Holds blocks (required). Markdown directive: scene.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 300 chars | ||
|
| up to 300 chars | ||
|
|
swatch
Holds nothing. Markdown directive: swatch.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| yes | ||
|
| up to 40 chars | yes | |
|
| up to 80 chars | ||
|
| yes | ||
|
|
|
systemStatus
Holds nothing. Markdown directive: systemStatus.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
| up to 2048 chars | ||
|
| `` | yes | |
|
|
| ||
|
| `` | yes | |
|
|
| ||
|
|
|
tab
Holds blocks (required). Markdown directive: tab.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| yes |
table
Holds blocks (required).
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
| |||
|
| 3–200 | ||
|
| |||
|
|
| ||
|
| |||
|
| |||
|
|
| ||
|
| |||
|
|
| ||
|
| |||
|
| |||
|
|
| ||
|
| |||
|
|
|
tableCell
Holds blocks (required).
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
| |||
|
| |||
|
| |||
|
|
tableHeader
Holds blocks (required).
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
| |||
|
| |||
|
|
tableRow
Holds blocks (required).
No attributes of its own.
tabs
Holds blocks (required). Markdown directive: tabs.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
| |||
|
| |||
|
| |||
|
|
| ||
|
|
| ||
|
|
| ||
|
|
| ||
|
| |||
|
|
| ||
|
|
|
testimonials
Holds nothing. Markdown directive: testimonials.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
| 1–4 | ||
|
| 2000–30000 | ||
|
| yes | ||
|
| up to 120 chars | yes | |
|
| |||
|
| |||
|
| |||
|
| up to 2000 chars | yes | |
|
| 1–5 | ||
|
| up to 160 chars | ||
|
|
|
update
Holds blocks (required). Markdown directive: update.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| yes | ||
|
|
updates
Holds blocks (required). Markdown directive: updates.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
|
video
Holds nothing. Markdown directive: video.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
|
| ||
|
| |||
|
| up to 2000 chars | ||
|
| |||
|
| 0–86400 | yes | |
|
| 1–120 chars | yes | |
|
| 0–100 | ||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| yes | ||
|
| up to 200000 chars | ||
|
|
walkthrough
Holds blocks (required). Markdown directive: walkthrough.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 100000 chars | yes | |
|
| up to 40 chars | ||
|
| up to 200 chars |
walkthroughStep
Holds blocks (required). Markdown directive: step.
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| up to 200 chars | yes | |
|
| up to 200 chars |
Attributes every block takes
Path | Type | Values / range | Required | Notes |
|---|---|---|---|---|
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
| |||
|
|
Marks
A mark styles a run of text: {"type": "text", "text": "…", "marks": [{"type": "link", "attrs": {"href": "…"}}]}.
Mark | Attributes |
|---|---|
| — |
| — |
| — |
| — |
| — |
| — |
|
|
| — |
|
|
|
|
| — |
|
|
|
|
| — |
|
|
|
|
|
|
In the API
Every operation below is also reachable from the other surfaces without a dedicated command. forumulate api <Operation> calls it from the CLI, the JavaScript SDK has a typed method for each one (the last column names it; the Python and Go clients are generated from the same spec), and an agent reaches the organization-scoped ones through the MCP call_api tool. Where a CLI command or MCP tool exists too, the last column names it. Operation names link to the API reference.
Icons
Operation | Request | What it does | Shortcuts |
|---|---|---|---|
| List icons |
|