Boards

Export as an image

With format: mp4, a video_maker item is rendered on the server as an H.264 MP4 (up to 10 minutes, up to 3840 x 2160) and the finished job's result carries videoUrl, width, height, fps, duration and bytes. Server video renders are on paid plans.

A PNG of the whole board, one frame with everything inside it, or one item on its own, drawn by the same renderer as the editor's Export. Drawing takes a browser, so this answers 202 with a Job; poll it, and the finished job's result carries imageUrl, width and height.

  • board is every item except comment pins, cropped to what they cover.
  • frame is a frame (a section, design frame, diagram frame, mood board and the like) and the items fully inside it. A design frame is cropped to its canvas, under its title bar.
  • item is one item alone, with nothing behind it.

The background is transparent. The image is published at an unguessable address: anyone with the URL can open it, so treat the URL like the board content it shows. Very large areas are refused before rendering: 20,000 x 20,000 pixels at scale 1, 10,000 x 10,000 at scale 2.

post/boards/{boardId}/export

Request

  • Base URL
    https://api.mockflow.com/v1
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

A unique key per logical request. Replays within 24 hours return the original response.

Request body

callbackUrlstring uri

Optional. When the job this request starts finishes or fails, a short body is POSTed here once: { eventId, status, boardId, boardUrl, imageUrl }, where status is succeeded or failed and imageUrl is a picture of what the job drew, or null. Signed with the workspace's callback secret (GET /webhooks/callback-secret). https to a public host. The full job is on GET /jobs/{jobId}.

target'board' | 'frame' | 'item'

What to draw.

itemIdstring

The frame or item to draw. Required unless target is board.

scale1 | 2

2 doubles the pixels, for retina screens and print.

format'png' | 'mp4'

mp4 renders a video_maker item as a video. Needs target item; not on the Basic plan.

quality480 | 720 | 1080 | 1440 | 2160

mp4 only. The video's short side in pixels, fitted inside 3840 x 2160.

fps24 | 25 | 30 | 60

mp4 only. Frames per second. Defaults to the video's own setting, else 30.

Example request

{
  "callbackUrl": "https://hooks.zapier.com/hooks/standard/123/abc"
}

Response

Export started. Poll the job; its result has the image, or the video for mp4.

idstring
kind'item.create' | 'item.update' | 'item.delete' | 'item.batch' | 'item.record' | 'ai.generate' | 'ai.modify' | 'skill.apply' | 'board.export'
status'queued' | 'running' | 'succeeded' | 'failed'
progressinteger
messagestring

Human readable progress, for example "Placing kanban".

errorError (unresolved $ref)
createdAtstring date-time
finishedAtstring date-time nullable
callbackUrlstring nullable

Where the job's result is POSTed

Changes

No recorded changes to this operation across all 1 revision of this API.