Microboard.Developers
ApiFrames

Create a frame

POST
/developers/boards/{boardId}/frames

Authorization

apiKey<token>

In: query

Request Body

application/jsonRequired
type
Required
string
Value in: "Frame"
shapeTypestring
Default: "Custom"Value in: "Custom" | "Frame16x9" | "Frame4x3" | "A4" | "Letter" | "Frame1x1"
transformationobject
borderColorstring
Default: "#1a1a1a"
borderStylestring
Default: "solid"Value in: "solid" | "dot" | "dash"
borderWidthnumber
Default: 1
borderOpacitynumber
Default: 1
backgroundColorstring
Default: "#ffffff"
backgroundOpacitynumber
Default: 1
widthnumber
heightnumber
itemsarray<string>

Path Parameters

boardId
Required
string
curl -X POST "https://api.microboard.com/api/v1/developers/boards/string/frames" \
  -H "apiKey: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "Frame",
    "shapeType": "Frame16x9",
    "width": 960,
    "height": 540
  }'

Frame created successfully

{
  "id": "frame-123",
  "itemType": "Frame",
  "shapeType": "Frame16x9",
  "transformation": {
    "rotate": 0,
    "scaleX": 9.6,
    "scaleY": 5.4,
    "translateX": 400,
    "translateY": 400
  },
  "borderColor": "#1a1a1a",
  "borderStyle": "solid",
  "borderWidth": 1,
  "borderOpacity": 1,
  "backgroundColor": "#ffffff",
  "backgroundOpacity": 1,
  "canChangeRatio": true,
  "children": [
    "item-1",
    "item-2"
  ]
}

Previous

Update a frame PATCH

Next

Delete an item DELETE