OpenKatana · Plan edit:
OpenKatana_plan_edit provides access to OpenKatana’s plan_edit tool from a ComfyUI workflow, allowing you to request edit-planning operations through the OpenKatana tool system. It serves as a bridge between your workflow and the underlying tool: it prepares the supplied request, calls the tool, and converts its response into a text result for further inspection or processing. The surrounding OpenKatana code includes facilities for validating reference-edit plans, checking recorded plans against timelines, and organizing frame-based shot boundaries, which can support structured editing workflows. However, the supplied code does not include the implementation or full request specification of plan_edit, so its exact planning behavior, supported operations, and effects on a project cannot be confirmed here. Treat this node as a tool-call interface rather than a confirmed video-rendering or automatic reference-recreation node.
OpenKatana · Plan edit Input Parameters:
project_id
project_id is a required STRING that identifies the OpenKatana project associated with the request. The node passes this value to its argument-preparation helper together with the selected tool and your supplied arguments, so it contributes to establishing the context for the tool call. Use the identifier associated with the project you intend to work on; the supplied code does not show how projects are created, how identifiers are validated, or how conflicts between this value and the argument content are resolved. No default value, permitted identifier format, length limits, minimum, maximum, or selectable options are provided in the authoritative interface.
arguments
arguments is a required STRING containing the request information that the node’s argument-preparation helper processes for plan_edit. It is the interface’s general-purpose place for tool-specific instructions or data, since no additional tool-specific input fields are listed for this node. The node prepares these arguments and passes the resulting request to the OpenKatana tool dispatcher. The supplied excerpts do not reveal the accepted serialization format, required request keys, or the plan_edit argument schema, so do not assume that arbitrary prose or a particular JSON object will be accepted. No default, length limits, minimum, maximum, or predefined options are shown. The reference-plan fields visible elsewhere in the context describe a separate validation function and are not, by themselves, a confirmed schema for this input.
after
after is an optional STRING with a default of None in the execution method. Although the node accepts it, the displayed method does not read it, merge it into the tool arguments, or forward it to the tool dispatcher. Consequently, no direct effect on edit planning, request contents, or the returned result is established by the supplied code. A connected input can establish an upstream dependency in a ComfyUI graph, but this should not be confused with an explicit instruction to the OpenKatana tool. No text default, length limits, minimum, maximum, or selectable options are shown.
OpenKatana · Plan edit Output Parameters:
result_json
result_json is the node’s single STRING output and contains the response produced by passing the underlying OpenKatana tool-call result through the node’s response helper. It is the place to inspect the outcome of your request or pass the returned information to a compatible downstream text-processing step. Its name indicates that it is intended to carry JSON-formatted response text, but the supplied code does not include the response helper or the plan_edit return schema, so specific keys, success indicators, plan fields, or error structures cannot be guaranteed. Inspect the actual response before relying on particular fields, and do not interpret the existence of this string alone as proof that an edit was applied, rendered, or visually verified.
OpenKatana · Plan edit Usage Tips:
- Confirm the
plan_editrequest specification in your installed OpenKatana version before filling inarguments. The provided node interface exposes a general argument string, not a documented set of planning controls. - Use the
project_idassociated with your intended project and check it before submitting an important request. The supplied wrapper does not show a project-confirmation step. - Start with the smallest request supported by the tool’s documented schema, inspect
result_json, and then add optional instructions incrementally. This makes it easier to identify which change causes an unexpected result. - Do not add inputs such as
fps,pace, ormin_shotto this node merely because those names appear in related source excerpts. They are not exposed node inputs, and their acceptance insideargumentsis not established. - If your documented workflow uses the reference-plan validator shown in the context, keep frame counts and timing consistent: that validator accepts an
fpsvalue from 1 to 120, requires a positive integerframesvalue, and requires internal cut positions to be strictly increasing integers. These are reference-plan validation rules, not confirmed top-level settings for this node. - If a later audit reports that a timeline matches a recorded plan, still review the edit visually. The supplied audit code explicitly states that a match does not verify whether the transcription, timings, or effects accurately describe the reference.
- Leave
afterunconnected unless you need an upstream graph dependency. Its contents are not used as planning instructions by the displayed execution method.
OpenKatana · Plan edit Common Errors and Solutions:
unexpected inputs: ...
- Explanation: This is an explicit error raised by the node when extra keyword fields reach its execution method and are not among the tool’s declared typed inputs. The authoritative interface lists only
project_id,arguments, and optionalafter. - Solution: Remove unsupported node-level fields. Put tool-specific information in
argumentsonly when the installedplan_editspecification explicitly supports it.
Request rejected while preparing arguments or calling the tool
- Explanation: The node prepares the argument string and then dispatches a tool call, either of which may reject an invalid request. The supplied code does not show the relevant validation rules or exact error messages, so a specific parsing error or required argument list cannot be stated reliably.
- Solution: Read the returned error or execution log, verify the accepted argument format for your installed version, and check that
project_idrefers to the intended project. Retry with a minimal documented request rather than guessing additional fields.
Reference plan needs a source path
- Explanation: This exact message appears in the supplied reference-plan validator when the plan’s
sourcevalue is not a string. It is relevant only if yourplan_editoperation or a related workflow actually invokes that validator; the node wrapper does not establish that it always does. - Solution: For a workflow using that validator, supply the reference source path as a string in the documented plan structure. Separately check that the path is accessible to the OpenKatana process, since a string-type check does not verify file availability.
cut_frames must list all internal shot boundaries; [] for one shot
- Explanation: The reference-plan validator raises this message when
cut_framesis missing or is not a list. It expects internal shot boundaries to be represented explicitly, including an empty list for a plan containing only one shot. - Solution: If your operation uses this reference-plan format, provide
cut_framesas a list of internal frame positions. Use[]when there are no internal cuts; do not substitute a text description or a single number.
Cut frames must strictly increase
- Explanation: The reference-plan validator raises this exact message when a cut position repeats or is not greater than the preceding cut. Such a sequence cannot describe an ordered set of distinct internal shot boundaries.
- Solution: Remove duplicate positions and place the remaining frame numbers in increasing order. Each position must also be an integer from 1 through the total frame count minus 1.
texts must be an array / fonts must be an array / shots must be an array
- Explanation: These messages come from the reference-plan validator when a supplied
texts,fonts, orshotsvalue is not a list. In that validator, omitted values for these fields default to empty lists, but explicitly providing an incompatible value fails validation. - Solution: In a workflow using this format, represent each supplied field as a list, even if it contains only one entry. Use
[]for a supplied empty collection rather than a string or a single object.
allow_extra_text must be boolean
- Explanation: The reference-plan validator raises this exact message when
allow_extra_textis supplied with a value other than a Boolean. Text such as"false"is not the same as a Boolean false value. - Solution: Use the Boolean value supported by the documented request format. In JSON, write
trueorfalsewithout quotation marks. The shown validator defaults this field toTruewhen it is omitted.
Reference text must preserve the literal transcription
- Explanation: This exact message is raised by the reference-plan validator when a text entry’s
textvalue is not a string. Despite its wording, the shown check does not compare that string with the reference or verify transcription accuracy. - Solution: Supply the text as a string and manually check its wording against the reference. Also check its frame interval: the shown validator requires an integer start frame of at least 0 and an integer end frame greater than the start, with neither extending beyond the permitted plan bounds.
