Create a board

POST /boards

Updated 16 Sep 20263 min read

POST/boardsTry it

Basehttps://api.mockflow.com/v1Scopesboards:write

Request

curl https://api.mockflow.com/v1/boards \
  -X POST \
  -H "Authorization: Bearer $MOCKFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Q4 launch",
  "prompt": "Plan the launch of our mobile app with a timeline, a kanban and a risk mind map."
}'

const response = await fetch("https://api.mockflow.com/v1/boards", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MOCKFLOW_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "title": "Q4 launch",
  "prompt": "Plan the launch of our mobile app with a timeline, a kanban and a risk mind map."
})
});

const data = await response.json();

import os, requests

response = requests.post(
    "https://api.mockflow.com/v1/boards",
    headers={"Authorization": f"Bearer {os.environ['MOCKFLOW_API_KEY']}"},
    json={
  "title": "Q4 launch",
  "prompt": "Plan the launch of our mobile app with a timeline, a kanban and a risk mind map."
},
)

response.raise_for_status()
data = response.json()

Response

{
  "id": "brd_3f9e2a",
  "title": "Q4 Launch Planning",
  "spaceId": "spc_92kd",
  "url": "https://app.mockflow.com/board/3f9e2a",
  "publicUrl": "https://app.mockflow.com/board/brd_3f9e2a",
  "role": "owner"
}

{
  "error": {
    "code": "plan_limit",
    "message": "AI credits exhausted. 0 of 2000 remaining this month.",
    "upgradeUrl": "https://mockflow.com/pricing"
  },
  "requestId": "req_01ja"
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests.",
    "docsUrl": "https://mockflow.com/developers/concepts/errors#rate_limited"
  },
  "requestId": "req_45d49816999bac40"
}

A new board in a space, or in the default space when spaceId is omitted. Basic makes three boards, trashed ones included; the cap answers 402. With prompt, Mida fills the new board in the background and the response carries the Job to poll.

Authorization

Authorizationstringheaderrequired

Bearer <key>. The key needs boards:write scope. Create and manage keys in the developer console; what each scope unlocks is on the scopes page.

Headers

Idempotency-Keystringheader

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

Body

application/json

titlestringrequired

spaceIdstring

Omit for the default space.

promptstring

Have Mida build the board from this. Needs the ai:generate scope and a Plus or Max plan.

outputTypesenum<string>[]

skillstring

A skill id from GET /skills to apply to the prompt.

withImagesboolean

Response

201 · application/json

idstring

titlestring

spaceIdstring | null

The design space, or null for the default space.

urlstring

Opens the board in the editor.

publicUrlstring | null

The public viewer link, when the public link is on.

roleenum<string>

The product's roles. Owner is the workspace that holds the board or space and cannot be granted or transferred. Admin can rename and share, editor can edit, reviewer can view, export and add comment items. There is no viewer role and no pending state. One of owner, admin, editor or reviewer.

lockedboolean

Locked boards are read only for everyone.

positioninteger | null

Manual order inside the space, lowest first.

createdBystring

createdAtstring

updatedAtstring

deletedAtstring | null

Set while the board is in the trash.

jobJob

Child attributes

idstring

kindenum<string>

One of item.create, item.update, item.delete, item.batch, ai.generate, ai.modify or skill.apply.

statusenum<string>

One of queued, running, succeeded or failed.

progressinteger

messagestring

Human readable progress, for example "Placing kanban".

resultobject | null

errorerror

createdAtstring

finishedAtstring | null

Errors

402plan_limit

The workspace plan does not allow this, or AI credits are exhausted.

429rate_limited

Too many requests.

Was this page helpful?