API Documentation
Build with StoryboardCanvas
RESTful API for programmatic storyboard generation, project management, and export. Available on Studio and Enterprise plans.
Authentication
All API requests require a Bearer token in the Authorization header. Generate your API key from Settings → API Keys in the dashboard.
// Example request
curl -X POST https://api.storyboardcanvas.ai/v1/generate \
-H "Authorization: Bearer sk_live_..." \
-H "Content-Type: application/json" \
-d '{\"script\": \"INT. ROOFTOP - NIGHT...\"}'
curl -X POST https://api.storyboardcanvas.ai/v1/generate \
-H "Authorization: Bearer sk_live_..." \
-H "Content-Type: application/json" \
-d '{\"script\": \"INT. ROOFTOP - NIGHT...\"}'
Endpoints
POST/v1/generate
Generate storyboard frames from a script or shot description
Parameters
script (string) — Fountain, FDX, or plain text
style_id (string) — locked art style reference
num_frames (int) — target number of frames
characters (array) — character identity references
POST/v1/regenerate
Regenerate a specific frame with optional modifications
Parameters
frame_id (string) — frame to regenerate
prompt (string) — modification instructions
preserve_composition (bool) — keep layout, change details
GET/v1/projects
List all projects for the authenticated user
Parameters
limit (int) — results per page (default 20)
offset (int) — pagination offset
status (string) — filter: active, archived
POST/v1/animatic/render
Render an animatic from approved frames and camera arrows
Parameters
project_id (string) — project with approved frames
format (string) — mp4 or mov
fps (int) — 24, 25, or 30
resolution (string) — 1080p or 4k
GET/v1/export/{project_id}
Export a project in various formats
Parameters
format (string) — pdf, png, csv, mp4, mov
dpi (int) — 72, 150, or 300 for print exports
layout (string) — 2x2, 3x3, or single for PDF
POST/v1/camera-arrows
Add camera movement arrows to a frame
Parameters
frame_id (string)
type (string) — pan, tilt, dolly, truck, crane, zoom, handheld
path (array) — coordinate waypoints
easing (string) — linear, ease_in, ease_out, ease_in_out
duration_ms (int)
Rate Limits
Studio
100 req/min
1,000 req/hour
Enterprise
500 req/min
Unlimited
Burst
200 req/min
With token add-on