OpenKatana · Shot sheet:
OpenKatana_shot_sheet provides access to OpenKatana’s shot-sheet tool, intended to help you review footage as a visual overview rather than repeatedly watching an entire sequence. A shot sheet arranges representative images from shots into a grid, making it easier to compare composition, visual continuity, and the overall progression of an edit. The available tool signatures support a cut-based workflow with configurable sampling position and column count, allowing you to tailor the overview for creative review. This is a review-oriented operation rather than a tool for applying effects or changing the edit; the supplied context does not expose the image-generation implementation, so details such as thumbnail labeling, image dimensions, and file format cannot be confirmed.
OpenKatana · Shot sheet Input Parameters:
project_id
A required STRING that identifies the OpenKatana project associated with the tool call. This value is passed into the node’s argument-preparation step so the operation can be associated with the intended project. Use the identifier supplied by your OpenKatana project workflow rather than substituting a project title or media filename unless your workflow explicitly uses those as identifiers. The supplied interface does not specify a default, length limits, or a list of valid identifiers, and it does not show how project identifiers are validated.
arguments
A required STRING containing the tool arguments in a serialized form; a JSON object is the practical format for expressing the named settings shown by the underlying API. The shot-sheet method accepts source, cuts, fps, start_frame, position, and columns in addition to the project identifier, but these are settings inside this string, not separate node inputs. The method signature declares source as a string with no default, cuts as a list of integers or None with a default of None, fps as a floating-point number or None with a default of None, start_frame as an integer defaulting to 0, position as a floating-point number defaulting to 0.75, and columns as an integer defaulting to 5. These settings identify the source and provide timing, cut, sampling-position, and grid-layout information. For example, {"source":"path/to/your/video.mp4","columns":5,"position":0.75} illustrates the argument structure; replace the source with a location accessible to OpenKatana. The supplied code does not establish accepted source-location formats, cut-boundary conventions, valid numeric ranges, or how omitted cuts and frame rate are resolved. No default value or length limits for the arguments input itself are shown.
after
An optional STRING accepted by the node’s execution method, where its Python default is None. Although this input is available on the interface, the shown implementation does not read it, merge it into the tool arguments, or forward its value to the tool invocation. Consequently, there is no demonstrated effect on shot-sheet content or tool settings. It may be available for connecting workflow branches so an upstream node must execute first, but that connection-order behavior is not established by the supplied implementation. No string default, allowed options, or length limits are shown in the interface; leave it unconnected unless your surrounding workflow requires it.
OpenKatana · Shot sheet Output Parameters:
result_json
A STRING containing the tool response after it has been processed by the shared response helper. The underlying shot-sheet API is annotated as returning a dictionary, while this node exposes the response as JSON text rather than a native ComfyUI image output. This distinction matters when you want to display or reuse the result: inspect the returned text and use an appropriate downstream parser or file-loading step if the response includes an artifact reference. The supplied context does not show the response helper or the dictionary’s contents, so exact field names, output paths, success indicators, and error structure cannot be documented reliably.
OpenKatana · Shot sheet Usage Tips:
- Start with a minimal argument object containing a valid
source, and retain the underlying defaults ofposition=0.75andcolumns=5for your first test. This reduces the number of settings to troubleshoot before you customize the review layout. - Use
columnsto adjust the grid’s horizontal arrangement. A smaller column count generally favors a narrower layout, while a larger count places more thumbnails across each row; confirm the actual output dimensions rather than assuming that changing this setting also changes thumbnail resolution. - Treat
positionas the shot-sampling setting. Its default is0.75; the name and default suggest a relative position within each shot, but the supplied implementation does not confirm the exact calculation or accepted range. Check a short sequence before relying on a changed value for frame-accurate review. - If you supply
cuts, use a JSON array of integers, matching the API’s declared type. Confirm the expected cut-boundary convention before using a long cut list, because the excerpts do not show whether opening or closing boundaries must be included. - Supply
fpsonly when you know the relevant frame rate, and keep your cut timing andstart_frameconsistent with that rate. The API permitsfpsto be omitted, but the provided code does not confirm whether it is then detected from the source or obtained elsewhere. - Inspect
result_jsonbefore wiring the node into a larger automation chain. Build downstream handling around the fields actually returned by your installation rather than assuming that the node directly produces an image or a particular file-path field.
OpenKatana · Shot sheet Common Errors and Solutions:
unexpected inputs: ...
- Explanation: This is the explicit error pattern in the supplied node code. The execution method raises a
TypeErrorwhen additional keyword inputs do not belong to the generated tool’s declared fields. The authoritative interface for this node lists onlyproject_id,arguments, andafter. - Solution: Remove unsupported top-level inputs from custom calls or workflow modifications. Put tool settings such as
sourceandcolumnsinside theargumentsstring rather than adding new sockets or execution keywords.
Invalid or unreadable arguments text — exact message not shown
- Explanation: The node processes
argumentsthrough shared argument helpers before invoking the tool. Incorrectly formatted serialized arguments can prevent that preparation step from succeeding; the helper implementation and its exact error messages are not included. - Solution: Use a valid JSON object with double-quoted property names and string values, and avoid trailing commas. Start with a simple object such as
{"source":"path/to/your/video.mp4"}and add settings one at a time.
Missing source argument — exact message not shown
- Explanation: The underlying shot-sheet method declares
sourcewithout a default. If the prepared tool arguments do not include it, the call cannot satisfy the shown method signature. - Solution: Include a
sourceproperty inargumentsand give it the source location accepted by your OpenKatana setup. Do not assume that providingproject_idalone selects the footage.
Source cannot be accessed or read — exact message not shown
- Explanation: Producing a shot sheet requires readable source media. A location that exists on your own computer may not be accessible to the process running OpenKatana, particularly in a remote or container-based installation. The supplied excerpts do not show the media-opening code or its error wording.
- Solution: Verify that the source is available in the execution environment, check the path spelling and access permissions, and test with a known-readable media file. Do not assume that arbitrary web links or local desktop paths are supported.
Argument type mismatch — exact message not shown
- Explanation: The method signature expects specific data types:
sourceis a string,cutsis a list of integers or null,fpsis numeric or null,start_frameandcolumnsare integers, andpositionis numeric. Incorrect types may fail during argument preparation or later tool execution; the supplied code does not show the validation messages. - Solution: Write numbers as JSON numbers rather than quoted text, provide cuts as an array rather than a comma-separated string, and use JSON
nullrather than PythonNonewhen explicitly supplying a null value.
Missing or incorrect project identifier — exact message not shown
- Explanation:
project_idis required by both the node interface and the underlying API. An omitted value does not satisfy the interface, while an incorrect identifier may prevent the tool from operating in the intended project context. Project validation behavior is not included in the excerpts. - Solution: Supply the identifier from the project you intend to review and verify it against the preceding project-management step in your workflow.
No image available from the output connection
- Explanation: This is an output-type misunderstanding rather than a confirmed tool error. The node returns
result_jsonas a STRING, so connecting it directly to a node that requires an IMAGE does not provide the expected data type. - Solution: Inspect the response text first. If it contains a generated-artifact reference, use a compatible parsing and loading step to open that artifact; the exact steps depend on the actual response fields and your available nodes.
