{ "openapi": "3.1.1", "info": { "title": "Comic Book & Booklet Planner API", "version": "1.0.0", "summary": "Plan a multi-page comic, contact sheet and folded booklet order.", "description": "Every endpoint performs the same calculation as the human page and returns inputs, result, units, assumptions, sources, warnings and computedAt. MCP endpoint: /mcp." }, "servers": [ { "url": "https://panelcraftbookplan.usefulweb.site" } ], "paths": { "/api/v1/calculate": { "post": { "operationId": "calculate", "summary": "Plan a multi-page comic, contact sheet and folded booklet order.", "description": "Create an editable Panelcraft comic book with ordered pages and panel grids. Export a clean SVG contact sheet, complete lettering CSV and book project, plus a deterministic sheet-front and sheet-back imposition plan for a folded booklet.\n\nMethodology:\n- Create 1–12 pages using the same bounded Comic Desk page parser as the interactive workspace. Each page has 1–12 rectangular panels; page dimensions are 1000 × 1400 px at 150 DPI.\n- A contact sheet uses 360 px thumbnails, up to four columns, unique SVG definition IDs and a maximum area of 8 megapixels. It is an overview, not a print-size page export.\n- Booklet page count rounds up to a multiple of four. Sheet fronts pair the last and first remaining pages; backs pair the second and penultimate. Pages beyond the source count are blanks. Right-to-left binding reverses each pair. Consult the printer manual for duplex orientation.\n\nImposition is a page-order plan for manually arranging a folded booklet. It does not rescale pages to a printer sheet or set printer-specific duplex options.", "tags": [ "apps" ], "x-mcp-tool": "panelcraft_book_plan", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PanelcraftBookPlanInput" }, "examples": { "example1": { "summary": "An eight-page pocket comic", "value": {} }, "example2": { "summary": "A six-page right-to-left draft", "value": { "pages": 6, "reading": "rtl", "rows": 1, "columns": 2 } } } } } }, "responses": { "200": { "description": "Calculation result envelope.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PanelcraftBookPlanResult" } } } }, "400": { "description": "Malformed JSON body.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "422": { "description": "Invalid input (see errors[]).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } }, "429": { "description": "Rate limit exceeded (see Retry-After).", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/Problem" } } } } } } }, "/api/v1/tool": { "get": { "operationId": "getToolDefinition", "summary": "Inputs, output schema and examples for this tool", "responses": { "200": { "description": "Tool definition.", "content": { "application/json": { "schema": { "type": "object" } } } } } } } }, "components": { "schemas": { "Problem": { "type": "object", "description": "RFC 9457 problem details. 422 responses include per-field `errors`.", "required": [ "type", "title", "status", "detail" ], "properties": { "type": { "type": "string" }, "title": { "type": "string" }, "status": { "type": "integer" }, "detail": { "type": "string" }, "code": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "field", "message" ], "properties": { "field": { "type": "string" }, "message": { "type": "string" } } } } } }, "PanelcraftBookPlanInput": { "type": "object", "additionalProperties": false, "properties": { "name": { "title": "Book title", "type": "string", "maxLength": 120, "default": "A small adventure" }, "author": { "title": "Author or credit", "type": "string", "maxLength": 120, "default": "" }, "pages": { "title": "Book pages", "type": "integer", "minimum": 1, "maximum": 12, "default": 8 }, "rows": { "title": "Panel rows", "type": "integer", "minimum": 1, "maximum": 12, "default": 2 }, "columns": { "title": "Panel columns", "type": "integer", "minimum": 1, "maximum": 12, "default": 2 }, "reading": { "title": "Reading and binding direction", "type": "string", "enum": [ "ltr", "rtl" ], "default": "ltr" }, "sheetColumns": { "title": "Contact-sheet columns", "type": "integer", "minimum": 1, "maximum": 4, "default": 3 } }, "required": [] }, "PanelcraftBookPlanResult": { "type": "object", "additionalProperties": false, "required": [ "schemaVersion", "tool", "computedAt", "inputs", "summary", "result", "units", "assumptions", "sources", "warnings", "presentation", "links" ], "properties": { "schemaVersion": { "type": "string", "const": "1.0" }, "tool": { "type": "object", "additionalProperties": false, "required": [ "id", "name", "version" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "version": { "type": "string" } } }, "computedAt": { "type": "string", "format": "date-time" }, "inputs": { "type": "object", "description": "Normalised inputs actually used, including applied defaults." }, "summary": { "type": "string" }, "result": { "type": "object", "additionalProperties": false, "required": [ "project", "report", "imposition", "contactSheet", "projectFile", "letteringCsv", "openInApp" ], "properties": { "project": { "type": "object", "additionalProperties": false, "required": [ "format", "version", "name", "author", "reading", "pages" ], "properties": { "format": { "const": "panelcraft-book" }, "version": { "const": 1 }, "name": { "type": "string", "maxLength": 120 }, "author": { "type": "string", "maxLength": 120 }, "reading": { "enum": [ "ltr", "rtl" ] }, "pages": { "type": "array", "minItems": 1, "maxItems": 12, "items": { "type": "object", "additionalProperties": false, "required": [ "id", "notes", "comic" ], "properties": { "id": { "type": "string", "pattern": "^[-a-zA-Z0-9_]{1,64}$" }, "notes": { "type": "string", "maxLength": 2000 }, "comic": { "type": "object", "additionalProperties": false, "required": [ "format", "version", "name", "width", "height", "dpi", "margin", "gutter", "border", "paper", "reading", "panels", "balloons", "artwork" ], "properties": { "format": { "const": "flipline-comic" }, "version": { "const": 1 }, "name": { "type": "string", "maxLength": 120 }, "width": { "type": "integer", "minimum": 400, "maximum": 2400 }, "height": { "type": "integer", "minimum": 400, "maximum": 4000 }, "dpi": { "type": "integer", "minimum": 72, "maximum": 600 }, "margin": { "type": "number" }, "gutter": { "type": "number" }, "border": { "type": "number" }, "paper": { "type": "string" }, "reading": { "enum": [ "ltr", "rtl" ] }, "panels": { "type": "array", "minItems": 1, "maxItems": 12, "items": { "type": "object", "additionalProperties": false, "required": [ "id", "name", "x", "y", "width", "height", "paper", "fit", "zoom", "panX", "panY", "sourceWidth", "sourceHeight", "tone" ], "properties": { "id": { "type": "string", "maxLength": 64 }, "name": { "type": "string", "maxLength": 80 }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "paper": { "type": "string" }, "fit": { "enum": [ "contain", "cover" ] }, "zoom": { "type": "number" }, "panX": { "type": "number" }, "panY": { "type": "number" }, "sourceWidth": { "type": "integer" }, "sourceHeight": { "type": "integer" }, "tone": { "type": "object", "additionalProperties": false, "required": [ "kind", "pitch", "coverage", "angle", "ink", "over" ], "properties": { "kind": { "enum": [ "none", "dots", "lines", "crosshatch" ] }, "pitch": { "type": "number", "minimum": 4, "maximum": 80 }, "coverage": { "type": "number", "minimum": 0.05, "maximum": 0.75 }, "angle": { "type": "number", "minimum": -90, "maximum": 90 }, "ink": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" }, "over": { "type": "boolean" } } } } } }, "balloons": { "type": "array", "maxItems": 36, "items": { "type": "object", "additionalProperties": false, "required": [ "id", "panel", "kind", "x", "y", "width", "height", "tailX", "tailY", "text", "fontSize", "ink", "paper" ], "properties": { "id": { "type": "string", "maxLength": 64 }, "panel": { "type": "string", "maxLength": 64 }, "kind": { "enum": [ "speech", "thought", "caption" ] }, "x": { "type": "number" }, "y": { "type": "number" }, "width": { "type": "number" }, "height": { "type": "number" }, "tailX": { "type": "number" }, "tailY": { "type": "number" }, "text": { "type": "string", "maxLength": 600 }, "fontSize": { "type": "number" }, "ink": { "type": "string" }, "paper": { "type": "string" } } } }, "artwork": { "type": "object", "additionalProperties": false, "required": [ "format", "version", "name", "width", "height", "fps", "paper", "boards" ], "properties": { "format": { "const": "flipline-story" }, "version": { "const": 1 }, "name": { "type": "string", "maxLength": 120 }, "width": { "type": "integer", "minimum": 32, "maximum": 1600 }, "height": { "type": "integer", "minimum": 32, "maximum": 1600 }, "fps": { "type": "integer", "minimum": 1, "maximum": 30 }, "paper": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" }, "boards": { "type": "array", "minItems": 1, "maxItems": 48, "items": { "type": "object", "additionalProperties": false, "required": [ "id", "title", "scene", "shot", "camera", "frames", "action", "dialogue", "notes", "locked", "marks", "reference" ], "properties": { "id": { "type": "string", "pattern": "^[-a-zA-Z0-9_]{1,80}$" }, "title": { "type": "string", "maxLength": 80 }, "scene": { "type": "string", "maxLength": 80 }, "shot": { "enum": [ "wide", "medium", "close", "detail", "over-shoulder" ] }, "camera": { "enum": [ "static", "pan-left", "pan-right", "tilt-up", "tilt-down", "push-in", "pull-out", "handheld" ] }, "frames": { "type": "integer", "minimum": 1, "maximum": 3600 }, "action": { "type": "string", "maxLength": 1200 }, "dialogue": { "type": "string", "maxLength": 1200 }, "notes": { "type": "string", "maxLength": 1200 }, "locked": { "type": "boolean" }, "marks": { "type": "array", "maxItems": 500, "items": { "type": "object", "additionalProperties": false, "required": [ "id", "kind", "points", "color", "size", "fill" ], "properties": { "brush": { "type": "object", "additionalProperties": false, "required": [ "kind", "opacity", "flow", "spacing", "texture", "pressure", "seed" ], "properties": { "kind": { "enum": [ "ink", "pencil", "marker", "wash", "airbrush" ] }, "opacity": { "type": "number", "minimum": 0, "maximum": 1 }, "flow": { "type": "number", "minimum": 0, "maximum": 1 }, "spacing": { "type": "number", "minimum": 0.08, "maximum": 1 }, "texture": { "type": "number", "minimum": 0, "maximum": 1 }, "pressure": { "type": "boolean" }, "seed": { "type": "integer", "minimum": 0, "maximum": 4294967295 } } }, "pressures": { "type": "array", "minItems": 1, "maxItems": 4096, "items": { "type": "number", "minimum": 0, "maximum": 1 } }, "id": { "type": "string", "minLength": 1, "maxLength": 80 }, "kind": { "enum": [ "pen", "eraser", "line", "rect", "ellipse", "image" ] }, "points": { "type": "array", "minItems": 1, "maxItems": 4096, "items": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": "number", "minimum": 0, "maximum": 1 } } }, "color": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" }, "size": { "type": "number", "minimum": 1, "maximum": 100 }, "fill": { "type": "boolean" }, "source": { "type": "string", "pattern": "^data:image/(png|jpeg|webp);base64,[A-Za-z0-9+/=]+$" }, "angle": { "type": "number", "minimum": -360, "maximum": 360, "description": "Clockwise rotation in degrees around the center of the mark bounds (normalized to -180…180)." }, "flipX": { "type": "boolean", "description": "Mirror horizontally around the mark center." }, "flipY": { "type": "boolean", "description": "Mirror vertically around the mark center." } } } }, "reference": { "type": [ "object", "null" ], "additionalProperties": false, "required": [ "source", "opacity", "visible" ], "properties": { "source": { "type": "string", "pattern": "^data:image/(png|jpeg|webp);base64,[A-Za-z0-9+/=]+$" }, "opacity": { "type": "number", "minimum": 0, "maximum": 1 }, "visible": { "type": "boolean" } } } } } } }, "description": "Story Desk. Frame-based board durations, half-open timeline intervals and non-drop-frame timecodes. Up to 600 seconds total and 120 seconds per board at the chosen FPS. Canvas up to 2 MP, 50000 points, 2000 marks and 6 million source-image characters across all boards. Ink erasers affect preceding ink only; the independent reference is preserved. Camera moves are planning labels, not animated camera paths." } }, "description": "Comic Desk page. At most 6 MP, 12 panels and 36 balloons. Panel/artwork board IDs align by index. Shared Story Desk mark budgets apply; image marks are disallowed. PNG references match declared dimensions, at most 2 MP each and 8 MP total. All embedded references together fit 6 million characters. Text overflow is reported, never silently exported by the workspace." } } } } }, "description": "Panelcraft 1.0 comic book, 1–12 ordered pages. Each comic follows the Flipline Comic Desk schema. Aggregate normalized page JSON must fit 24 million characters. Page IDs are unique. Per-page art and image limits apply. Reading sets booklet binding; each page retains its own panel reading direction." }, "report": { "type": "object", "additionalProperties": false, "required": [ "pages", "panels", "balloons", "overflow", "embeddedCharacters" ], "properties": { "pages": { "type": "integer" }, "panels": { "type": "integer" }, "balloons": { "type": "integer" }, "overflow": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "page", "id" ], "properties": { "page": { "type": "integer" }, "id": { "type": "string" } } } }, "embeddedCharacters": { "type": "integer" } } }, "imposition": { "type": "object", "additionalProperties": false, "required": [ "pages", "paddedPages", "blankPages", "sheets" ], "properties": { "pages": { "type": "integer" }, "paddedPages": { "type": "integer" }, "blankPages": { "type": "integer" }, "sheets": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "sheet", "front", "back" ], "properties": { "sheet": { "type": "integer" }, "front": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": [ "integer", "null" ] } }, "back": { "type": "array", "minItems": 2, "maxItems": 2, "items": { "type": [ "integer", "null" ] } } } } } } }, "contactSheet": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "filename", "mime", "bytes", "sha256", "path" ], "properties": { "artifactId": { "type": "string" }, "filename": { "type": "string" }, "mime": { "type": "string" }, "bytes": { "type": "integer" }, "sha256": { "type": "string" }, "path": { "type": "string", "description": "Download path on the same site (valid for about 2 hours)." } } }, "projectFile": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "filename", "mime", "bytes", "sha256", "path" ], "properties": { "artifactId": { "type": "string" }, "filename": { "type": "string" }, "mime": { "type": "string" }, "bytes": { "type": "integer" }, "sha256": { "type": "string" }, "path": { "type": "string", "description": "Download path on the same site (valid for about 2 hours)." } } }, "letteringCsv": { "type": "object", "additionalProperties": false, "required": [ "artifactId", "filename", "mime", "bytes", "sha256", "path" ], "properties": { "artifactId": { "type": "string" }, "filename": { "type": "string" }, "mime": { "type": "string" }, "bytes": { "type": "integer" }, "sha256": { "type": "string" }, "path": { "type": "string", "description": "Download path on the same site (valid for about 2 hours)." } } }, "openInApp": { "type": [ "string", "null" ] } } }, "units": { "type": "object", "additionalProperties": { "type": "string" } }, "assumptions": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": [ "title" ], "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "publisher": { "type": "string" }, "retrievedAt": { "type": "string" }, "note": { "type": "string" } } } }, "warnings": { "type": "array", "items": { "type": "string" } }, "presentation": { "type": "array", "items": { "type": "object" }, "description": "Display blocks used by the human page (same data)." }, "links": { "type": "object", "additionalProperties": false, "required": [ "human", "api", "openapi", "methodology" ], "properties": { "human": { "type": "string", "format": "uri" }, "api": { "type": "string", "format": "uri" }, "openapi": { "type": "string", "format": "uri" }, "methodology": { "type": "string", "format": "uri" } } } } } } } }