Endpoints for live links (publish, update, stop sharing), the link-preview picture, and moving whole boards as ZIP archives. Live links are hosted in your own Cloudflare account, so publishing needs the sharing setup first; see Cloudflare Account Setup.
Share status
GET /api/moodboards/{id}/share
Returns:
{
"is_shared": true,
"share_id": "…",
"share_url": "https://…/view/…",
"og_image": null,
"og_image_effective": "/media/…"
}
og_image_effective is the picture link previews show: the one you set, or the board’s first image.
Publish a live link
POST /api/moodboards/{id}/share
{ "password": null, "expires_in": null }
Builds the board’s page, uploads it and its media to your sharing storage, and returns the same fields as the status call, plus failed and missing lists for files that could not be sent. Both body fields are optional: password protects the page, and expires_in is "1d", "7d" or "30d".
Without the sharing setup it returns 400: “Sharing storage is not set up. Open Share → Set Up to create it in your own Cloudflare account.”
Update a live link
POST /api/moodboards/{id}/share/update
Publishes the board’s current state to the same URL and keeps its comments. Only files that changed are sent. The answer adds incremental, uploaded, unchanged, removed and failed. See Updating a Shared Board.
Set the link-preview picture
POST /api/moodboards/{id}/share/og-image
{ "og_image": "/media/…" }
Sets the picture that chat apps and social sites show for the link: a /media/… path, an outside URL, or null to go back to the default. If the board is shared, only the page is published again; the media is not re-sent.
Stop sharing
DELETE /api/moodboards/{id}/share
DELETE /api/moodboards/{id}/share?local_only=true
Deletes the page and its media from the host that serves it, then forgets the link. The board keeps its link until the page is really gone. local_only=true only forgets the link on this board, for a page this computer cannot remove; the page stays online.
Export a board as a ZIP
GET /api/moodboards/{id}/export
Downloads the board and all its sub-boards as one ZIP: the cards, the media, the video and mockup projects, the custom templates, transitions and effects its video projects use, and a standalone HTML page that opens in any browser. This is the Share window’s Download ZIP.
Import a ZIP
POST /api/moodboards/{id}/import?mode=replace
Upload the archive as the multipart field file. It lands in the board {id}:
mode=replaceoverwrites the board with the archive’s content.mode=appendadds the archive’s content to the board, with fresh ids.
Custom templates, transitions and effects inside the ZIP are not installed. See Importing and Exporting Boards.
Where to go next
- Sharing — live links and exports from the Share window.
- Cloudflare Account Setup — set up the hosting once.
- API Reference — base URL, authentication and the other endpoint groups.
Leave a Reply
You must be logged in to post a comment.