Skip to content
MockFlow DevelopersGet an API key

Create a film/video storyboard with scenes and frames for visualizing stories, movie sequences, commercials, and video content.

Updated 9 Nov 20262 min read

Send "type": "storyboard".

Create a film/video storyboard with scenes and frames for visualizing stories, movie sequences, commercials, and video content.

Also available as the MCP tool render_storyboard. The same payload works through either surface.

Fields

data
scenesobject[]required

Array containing one scene with frames

Child attributes
idstringrequired

Scene ID (e.g., "scene_default")

titlestringrequired

Scene title

isDefaultboolean

true for main scene

colorstring

Scene color (e.g., "#e94560")

framesobject[]required

Array of frame objects

settingsobjectrequired

Storyboard settings

Child attributes
boardTitlestring

Storyboard title

themeenum<string>

One of light or dark. Defaults to light.

showMetadataboolean

Defaults to true.

frameSizeenum<string>

One of small, medium or large. Defaults to medium.

storyboardSettingsobject

Example

{
  "type": "storyboard",
  "data": {
    "scenes": [
      {
        "id": "string",
        "title": "Q4 Launch Planning",
        "isDefault": false,
        "color": "string",
        "frames": [
          {
            "id": "string",
            "sequence": 0,
            "title": "Q4 Launch Planning",
            "description": "string",
            "coverType": "string",
            "coverFileID": "string",
            "metadata": {
              "field1": "string",
              "field2": "string",
              "field3": "string",
              "field4": "string"
            },
            "comments": [
              {}
            ],
            "createdAt": "string"
          }
        ]
      }
    ],
    "settings": {
      "boardTitle": "Q4 Launch Planning",
      "theme": "light",
      "showMetadata": true,
      "frameSize": "medium",
      "storyboardSettings": {
        "customFields": [
          {}
        ],
        "frameNumber": {
          "format": "number",
          "prefix": "",
          "startFrom": 1
        },
        "brandGuide": {
          "primaryColor": "#1c7ce2",
          "secondaryColor": "#6c757d",
          "accentColor": "#e94560",
          "bgColor": "#ffffff",
          "artStyle": "string",
          "styleNotes": "string"
        },
        "features": {
          "enableCharacters": true,
          "enableScenes": true
        },
        "characters": [
          {}
        ],
        "customScenes": [
          {}
        ]
      }
    }
  }
}

Add one record

POST /boards/{boardId}/items/{itemId}/records adds one of these to an item already on a board and leaves the rest of it as it is. Send the same key again to update that record instead of adding another.

Record fields

record
titlestringrequired
descriptionstring
scenestring

The scene it goes in; made when the storyboard has none by that name.

keystring

Your own id for this record, like an issue key. Sending the same key again updates and moves that record instead of adding another.

{
  "record": {
    "title": "Q4 Launch Planning",
    "description": "string",
    "scene": "string",
    "key": "string"
  }
}
Was this page helpful?

Sign in to MockFlow

The same account you use in the app and on the API.

Forgot your password?
or
Continue with GoogleContinue with MicrosoftContinue with Apple