Storyboards

Get project storyboard

Returns the project's current storyboard as a Kaitoi Storyboard Document v1. This is a read-only export of storyboard state.

get/api/v1/projects/{project_id}/storyboard

Request

  • Base URL: https://api.studio.kaitoi.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.studio.kaitoi.io/api/v1/projects/{project_id}/storyboard
  • Auth: HTTP bearer

Path parameters

project_idstring required

Headers

authorizationstring nullable

Response

Project storyboard document.

projectIdstring required

Stable project identifier.

versioninteger required

Optimistic concurrency version for the project.

documentobject required

Project storyboard exported as Kaitoi Storyboard Document v1.

Example response

{
  "document": {
    "kaitoiType": "storyboard",
    "name": "Storyboard",
    "sequences": [
      {
        "id": "scene-1",
        "name": "Scene 1",
        "order": 0,
        "shots": [
          {
            "description": "A quiet establishing shot.",
            "durationSeconds": 3,
            "id": "frame-1",
            "order": 0,
            "transition": "cut"
          }
        ]
      }
    ],
    "settings": {
      "aspectRatio": "16:9",
      "defaultFrameDuration": 3
    },
    "version": 1
  },
  "projectId": "proj_123",
  "summary": {
    "mediaCount": 0,
    "sceneCount": 1,
    "shotCount": 1
  },
  "version": 7
}

Changes

No recorded changes to this operation across all 1 revision of this API.