Storyboards

Validate storyboard document

Validates a Kaitoi Storyboard Document v1 against the same schema enforced by the backend.

post/api/v1/storyboards/validate

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/storyboards/validate
  • Auth: HTTP bearer

Headers

authorizationstring nullable

Request body

documentobject required

Kaitoi Storyboard Document v1 JSON.

Example request

{
  "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
  }
}

Response

Validated storyboard document and derived summary.

validboolean required

Always true when the request succeeds.

documentobject required

Validated, normalized 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
  },
  "summary": {
    "mediaCount": 0,
    "sceneCount": 1,
    "shotCount": 1
  },
  "valid": true
}

Changes

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