API reference
Every endpoint of the MockFlow Boards API, generated from the OpenAPI contract.
62 operations across 10 groups, on version 2026-10-01 of the contract. Every page here is generated from the OpenAPI document the API serves, so it cannot disagree with the running API.
Authentication
AuthorizationstringheaderrequiredBearer <key> on every request. Create a key in the developer console: it acts as you, with the scopes you choose, and is shown once. Keep it out of client side code.
Base URLhttps://api.mockflow.com/v1. Every path below is relative to it.
OpenAPIhttps://api.mockflow.com/v1/openapi.json. The machine readable contract, for generating a client or importing into a tool.
ScopesEach operation lists the scope it needs. See scopes, and errors, pagination, rate limits, idempotency and versioning for the rules every call shares.
Endpoints
Me
The person behind the token, the workspace they belong to, and its plan.
The AI credit wallet and the Mida message quota, both metered per workspace and reset monthly.
What the workspace plan allows before you try.
Whether the workspace receives notification emails.
The notification stream the product emails from, newest first: comments and updates on boards shared with you.
The connectors (Jira, Trello, Slack, Notion and the rest) Mida can pull from in the editor, and which ones this person has connected.
Spaces
Every space the token can see, in dashboard order: the workspace's own, the ones shared with the person, and the two built-in spaces default (boards in no space) and trash.
Basic accounts have one space; the cap answers 402.
Rename is open to a shared admin or editor.
The space and every board in it go to the trash for 30 days, as in the app.
Sharing happens on the space.
Adds or updates the person's role.
Brings the space and the boards that went with it back.
Boards
Boards the token can read: the workspace's own, boards shared with the person, and boards in spaces shared with them.
A new board in a space, or in the default space when spaceId is omitted.
The dashboard's Recent strip, the ten most recently updated boards across everything the token can see.
Rename and lock need admin.
On Plus and Max the board goes to the trash for 30 days.
The same rows the Activity panel shows, newest first.
A copy titled "Copy_" plus the title, in the same space, with its pages, uploaded images, fonts, prototypes and artifacts.
The board the way the product's own board scan reads it: sections with the items inside them in reading order, standalone items, and the connections between items.
Plus and Max only.
The machine view behind the outline.
Items
Every item on the board in z-order, flat: sections contain items by position, which sectionId reports.
Any creatable type.
Geometry, where it sits, and data decoded per the type's readback.
position and size move and resize any item.
Deleting a comment pin is how a comment is resolved, as in the app.
Mida rebuilds the item's content as the target type and, once the new item has landed, deletes the source unless keepSource is true.
The whole content of one item, paged by line, the way the product's own read tool hands it to an agent.
Up to 100 operations, validated together before anything is drawn, then drawn as one action.
Every item type, generated from the component registry.
The JSON schema for that type's data, exactly what POST /boards/{boardId}/items validates against, plus an example payload and the types it can be converted to.
Runs the same validation a create would, and answers 422 with the field that is wrong, or 200.
Members
The effective members: the owner, people the space is shared with (inheritedFrom is the space), and people the board itself was shared with from the editor.
Admin and above.
AI
Answers from the board's own content, the same text the outline shows, and cites the items it used.
Mida turns a prompt into one or more items on the board.
Mida rewrites a frame in place, as the component's own "modify with AI" does.
The planner's proposal for a prompt, the same one the editor shows for approval before it generates.
Feedback on the board's content, scored per aspect and overall, in the shape the editor's AI review uses.
Skills
Runs a generation with the skill's instructions appended to the prompt and its output type forced, as the editor does when a skill is active.
scope=public (default) is the curated library.
Plus and Max only.
Returns a draft (name, description, system prompt, placeholder, tags) for a description and an output type.
Collaboration
The board's team chat, oldest first within a page.
Posts as the token's owner.
Jobs
Search
Two searches in one.
Item types
Every type an item can have, its data schema and the MCP tool that renders the same payload.