---
title: "Get project storyboard"
method: GET
path: "/api/v1/projects/{project_id}/storyboard"
tags: ["Storyboards"]
---

# Get project storyboard

`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

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

## Path parameters

- `project_id` string, required

## Headers

- `authorization` string, nullable

## Response `200`

Project storyboard document.

- PublicProjectStoryboard
  - `projectId` string, required: Stable project identifier.
  - `version` integer, required: Optimistic concurrency version for the project.
  - `document` object, required: Project storyboard exported as Kaitoi Storyboard Document v1.
  - `summary` PublicStoryboardSummary, required
    - `sceneCount` integer, required: Number of sequences/scenes in the storyboard.
    - `shotCount` integer, required: Number of shots/frames in the storyboard.
    - `mediaCount` integer, required: Number of panel and audio media references.

## Other responses

- `401`: Missing, malformed, expired, or revoked bearer token.
- `403`: The API key lacks the required scope or account capability.
- `404`: Project not found.
- `422`: Validation Error
- `429`: The client or API key exceeded the REST API rate limit.
- `503`: The shared REST API rate limiter is temporarily unavailable.

---

[API](https://skmtc.dev/kaitoi/apis/kaitoi-rest-api.md) · [All operations](https://skmtc.dev/kaitoi/apis/kaitoi-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kaitoi/apis/kaitoi-rest-api/revisions/239a74aa2c64?raw)