What you can build

The MockFlow API lets your own code do what you do in MockFlow by hand: make boards, put things on them, read them, share them and ask Mida, the AI assistant, to build them. Your code can be a script, a server, an internal tool or an AI agent.

Ideas at a glance

• Show data from other tools as boards: your tasks, numbers or plans, drawn as a kanban, chart, table or timeline.

• Let Mida build boards for you: describe a board in a sentence and get it built.

• Use board content in other places: a board as text for an AI agent, or as an image for a report.

• Get told when boards change: your server hears when a board is created, shared or trashed.

• Set up spaces and sharing automatically: a space for each new client, class or project, with the right people in it.

• Build an app other people connect: your app works on their boards, with their permission.

Keys, OAuth apps and webhooks

Every idea below calls the API with an API key, or with an OAuth app's token when other people's accounts are involved, and some add a webhook to hear about changes. API keys, OAuth apps and webhooks explains what each one is and when to use it.

Show data from other tools as boards

Example: every Monday, a script reads the open tasks from your issue tracker and builds a sprint board, with one kanban column per team.

1. Create the board with POST /boards.

2. Add a kanban with the tasks with POST /boards/{boardId}/items. To add many items in one go, send them as a batch with POST /boards/{boardId}/items:batch.

3. Share the board's url from the response with the team.

The same pattern draws this week's sales as charts, a course plan as a timeline, or an event schedule as a Gantt chart. Each item type page shows the data it takes.

You need: an API key with the scope boards:write. Every plan can do this; Basic allows three boards.

Let Mida build boards for you

Example: when a client fills in a brief on your website, a first workshop board is ready for your team a minute later.

1. Create the board with POST /boards and a prompt that describes it, for example "A launch plan with a timeline, a task kanban and a mind map of risks".

2. Mida builds the board in the background. The response includes a job.

3. Check the job with GET /jobs/{jobId} until it says succeeded, or add a callbackUrl and MockFlow tells your server when it is done.

To get the same kind of board every time, apply a skill: saved instructions Mida follows. Mida can also review a board you already have with POST /boards/{boardId}/ai/review, scoring it against what you ask for, such as "completeness of the launch plan".

You need: an API key with boards:write, plus ai:generate for reviews and skills. Plus or Max, and generation uses the workspace's AI credits.

Use board content in other places

Example: an internal assistant answers "what did we decide for the Q3 launch?" by reading the team's planning board.

1. Find the board by its title with GET /search.

2. Read it as text with GET /boards/{boardId}/outline: sections, the items in them in reading order, and how items connect.

3. Hand that text to your AI agent, search index or summary.

To show a board somewhere else, export it as an image with POST /boards/{boardId}/export: a PNG of the whole board, one frame or one item, ready for a status page, a report or a slide.

You need: an API key with boards:read. Every plan.

Get told when boards change

Example: each new board in the marketing space appears as a row in your project tracker, and as a message in your team channel when it is shared.

1. Add a webhook in the developer console, with your server's address and the events you want, such as board.created and member.added.

2. MockFlow sends a signed POST to your server each time one happens.

3. Your server checks the signature and does its work.

Webhooks cover boards being created, renamed, locked, moved, trashed and restored, people gaining or losing access, and jobs you started finishing. They do not fire for each edit to the items on a board.

You need: an API key with boards:read to manage webhooks. Every plan.

Set up spaces and sharing automatically

Example: when a new client signs, a script creates a space named after them and shares it with the account team as editors and the client as reviewers.

1. Create the space with POST /spaces.

2. Share it with each person by email and role with POST /spaces/{spaceId}/members.

3. Create the client's first boards in it with POST /boards and its spaceId.

You need: an API key with boards:write and members:write. Basic has one space, so this suits Plus and Max.

Build an app other people connect

Example: a planning tool where each customer clicks "Connect MockFlow" and your tool then creates boards in their own account.

1. Register an OAuth app in the developer console.

2. Each person signs in to MockFlow and approves your app.

3. Your app gets a token that works on that person's boards, with the scopes they approved, and calls the same endpoints as above.

You need: an OAuth app instead of an API key, because an API key only acts as you.

Where to start

Follow the Quickstart to create a key and your first board in a few minutes. For complete projects you can download and run, see the API examples and the OAuth app examples. Every endpoint is in the API reference.