OpenKatana · Start render:
OpenKatana_start_render provides a ComfyUI entry point for requesting a render through OpenKatana’s tool interface, allowing you to include rendering in a node-based creative workflow. Its role is to send a render-start request to OpenKatana rather than generate images directly inside the node. The supplied rendering code shows that OpenKatana can render a timeline frame by frame using a browser-based engine, save numbered PNG images, and collect information about the rendering process. This makes the node useful for moving from an edited composition toward rendered visual assets without manually running the rendering code. The supplied context does not include the underlying start-render tool definition, so it does not establish whether this particular request waits for rendering to finish or starts a background task.
OpenKatana · Start render Input Parameters:
project_id
A required STRING that identifies the OpenKatana project associated with the request. The node passes this value to the argument-preparation helper before invoking the tool, so you should use the identifier associated with the project you intend to render. The supplied code does not show how project identifiers are created, validated, or resolved, and it does not establish that a project folder path or project display name can be used instead. No default value, list of valid options, length limit, or minimum or maximum value is specified in the supplied interface.
arguments
A required STRING containing the arguments that OpenKatana’s start-render tool expects. The node sends this text through argument-preparation helpers before dispatching the tool call; this is where tool-specific rendering instructions would be supplied if the underlying tool supports them. However, the start-render argument schema and the helper implementations are not included, so the accepted text format, required fields, available render settings, and handling of an empty string cannot be confirmed. Use the argument format documented by your installed OpenKatana tool rather than assuming that settings such as resolution, frame count, or output location are accepted here. No default value, minimum or maximum length, or predefined options are specified in the supplied interface.
after
An optional STRING accepted by the execution method, with a Python default of None when it is omitted. In the supplied implementation, this value is not read, added to the prepared arguments, or passed to the tool invocation, so there is no demonstrated effect on rendering settings or the backend request. Connecting it to an upstream string output can establish a graph connection, but the code does not show any interpretation of its contents as a job identifier, delay, or completion condition. Leave it unconnected unless your workflow needs that connection for execution ordering; no valid-value options or minimum or maximum values are specified.
OpenKatana · Start render Output Parameters:
result_json
A STRING containing the tool response as returned through the node’s response-formatting helper. This is the node’s only output: it does not directly expose a ComfyUI image batch or video output. You can inspect this text to understand what OpenKatana reports about the request and use its documented contents in later workflow steps. Although its name indicates a JSON response, neither the response helper nor the start-render return schema is included in the supplied context, so specific keys, status values, file paths, job identifiers, and error structures cannot be guaranteed. In particular, do not treat receipt of this output alone as proof that all rendering has finished unless the returned response or the installed tool documentation confirms that behavior.
OpenKatana · Start render Usage Tips:
- Use the identifier of the intended OpenKatana project for
project_id. Do not substitute a timeline filename or folder path unless your installed tool explicitly supports that format. - Check the installed start-render tool’s argument specification before filling in
arguments. The supplied interface exposes no separate width, height, frame-count, or quality controls, and the provided code does not establish valid argument keys for those settings. - Test with a short timeline before requesting a large render. The supplied renderer processes every frame defined by the timeline’s canvas, so fewer frames reduce the amount of rendering work when that renderer is used.
- Verify your project’s assets and any custom drawing hooks before starting a full render. The supplied renderer supports hook-provided assets, and missing or incorrectly referenced resources can interrupt rendering.
- Inspect
result_jsonbefore connecting downstream steps that depend on finished files. Confirm the response’s meaning using the installed tool’s documented schema rather than assuming the render-start request is synchronous. - Use
afteronly as a workflow connection when appropriate. Its contents are ignored by the shown method, so it cannot itself instruct OpenKatana to wait for a particular render job to finish.
OpenKatana · Start render Common Errors and Solutions:
unexpected inputs: …
- Explanation: This is an explicit error raised by the node when it receives additional execution fields that are not declared in its tool-specific input definitions. It indicates an interface mismatch rather than a problem with the visual content of your project.
- Solution: Use the listed inputs and remove unsupported fields from API-generated workflows or custom integrations. If a saved workflow was created with another OpenKatana version, reload the installed node definition and update the workflow to match it.
Render setup failed: …
- Explanation: The supplied renderer uses this prefix when the browser-based engine fails while initializing the edit. The text after the prefix contains the underlying error and is the most useful part for diagnosis. This message applies if the start-render request reaches that rendering implementation.
- Solution: Read the complete message, check that the project or timeline is valid, and verify resources mentioned in the error. Try a small, known-working project to distinguish a project-specific issue from a rendering-environment problem.
Render failed at frame N: …
- Explanation: The supplied renderer reports this message when rendering a particular frame fails, replacing
Nwith the frame number. Its frame loop starts at zero, so frame0is the first frame. The remaining message describes the underlying failure. - Solution: Inspect the content active at that frame, including assets, transitions, and custom hooks if present. Simplify or temporarily disable the affected elements, test a shorter render, and use the detailed error text to identify the failing resource or drawing operation.
Argument preparation or tool-call failure; exact message not supplied
- Explanation: The node prepares
project_idandargumentsbefore invoking the tool, but the helper implementations and their error messages are not included. Incorrectly formatted arguments or an unusable project identifier are therefore troubleshooting possibilities, not confirmed error strings. - Solution: Compare your values with the installed tool’s specification, verify that the project identifier is correct, and retry with the smallest documented valid request. Avoid guessing argument field names or assuming that an empty string is valid.
Missing or unusable result details; exact message not supplied
- Explanation: The provided source does not define the start-render response schema or guarantee that it contains completed output files. A response that lacks the file information you expected does not, by itself, establish that rendering failed.
- Solution: Inspect the full
result_jsontext and consult the installed tool’s return specification. If the response documents a separate status-check or result-retrieval step, follow that procedure before attempting to load rendered files.
