Create an item

POST /boards/{boardId}/items

Updated 16 Sep 20263 min read

POST/boards/{boardId}/itemsTry it

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

Request

curl https://api.mockflow.com/v1/boards/brd_3f9e2a/items \
  -X POST \
  -H "Authorization: Bearer $MOCKFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "sticky_note",
  "position": {
    "x": 120,
    "y": 80
  },
  "data": {
    "text": "Interview 5 users",
    "color": "yellow"
  }
}'

const response = await fetch("https://api.mockflow.com/v1/boards/brd_3f9e2a/items", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MOCKFLOW_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "type": "sticky_note",
  "position": {
    "x": 120,
    "y": 80
  },
  "data": {
    "text": "Interview 5 users",
    "color": "yellow"
  }
})
});

const data = await response.json();

import os, requests

response = requests.post(
    "https://api.mockflow.com/v1/boards/brd_3f9e2a/items",
    headers={"Authorization": f"Bearer {os.environ['MOCKFLOW_API_KEY']}"},
    json={
  "type": "sticky_note",
  "position": {
    "x": 120,
    "y": 80
  },
  "data": {
    "text": "Interview 5 users",
    "color": "yellow"
  }
},
)

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

Response

{
  "id": "itm_k9",
  "type": "string",
  "componentType": "string",
  "boardId": "brd_3f9e2a",
  "sectionId": "string",
  "groupId": "string"
}

{
  "id": "job_7hd2",
  "kind": "item.create",
  "status": "queued",
  "progress": 0,
  "message": "Interview 5 users",
  "result": {
    "itemIds": [
      "string"
    ],
    "updated": [
      "string"
    ],
    "deleted": [
      "string"
    ],
    "creditsUsed": 0,
    "boardTitle": "Q4 Launch Planning",
    "skill": "string"
  }
}

{
  "error": {
    "code": "validation_failed",
    "message": "data.columns[0].cards[0].priority must be one of low, medium, high",
    "details": [
      {
        "path": "data.columns[0].cards[0].priority",
        "expected": [
          "low",
          "medium",
          "high"
        ]
      }
    ]
  },
  "requestId": "req_01j9"
}

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

Any creatable type. type selects the schema for data: a frame's schema is the MCP render tool's own, a primitive's is below. Omit position and the item goes below everything on the board. A connector needs no position; its data names the two items it joins.

The item is drawn by a browser, which mints its id. When the draw has landed within a few seconds the answer is 201 with the item; otherwise 202 with a Job whose result.itemIds carries the id once it appears. A board open in the editor draws it live either way.

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.

Path parameters

boardIdstringpathrequired

Headers

Idempotency-Keystringheader

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

Body

application/json

typeenum<string>required

Item types, generated from the MockFlow component registry. Primitive types are drawn by the editor; frame types are rich components whose data schema is the same one the MCP render_* tool accepts.

positionPoint

Child attributes

xnumberrequired

ynumberrequired

sizeSize

Child attributes

widthnumber

heightnumber

dataItemDatarequired

Selected by the sibling type. One schema per item type, generated from the component registry.

Response

201 · application/json

idstring

typestring

An ItemType, or other for an editor widget the API has no type for.

componentTypestring

The editor's own class name, exact where type is a family.

boardIdstring

sectionIdstring | null

The section the item sits inside, by position.

groupIdstring | null

positionPoint

Child attributes

xnumberrequired

ynumberrequired

sizeSize

Child attributes

widthnumber

heightnumber

rotationnumber

zIndexinteger

lockedboolean

textstring

Plain text extracted from the item, for search and the outline.

readbackenum<string>

One of exact, unwrapped, text, pointer, parts or none.

dataItemData

Selected by the sibling type. One schema per item type, generated from the component registry.

fromstring | null

Connectors only: the item or group: the line starts at.

tostring | null

Connectors only.

directedboolean

Connectors only.

labelstring

Connectors only.

urlstring

Opens the board focused on this item.

Errors

422validation_failed

The body did not match the schema for this item type.

429rate_limited

Too many requests.

Was this page helpful?