OpenKatana · Get project:
OpenKatana_get_project calls OpenKatana’s local get_project tool from a ComfyUI workflow, allowing you to request information about a project without switching to the command line or another interface. It is useful as a project-checking step when you want to inspect a project before continuing your creative workflow or review its current information after another operation. The node uses the same tool-calling system as OpenKatana’s CLI and MCP integrations, helping you work with a project shared across ComfyUI and OpenKatana Studio. It runs locally rather than through paid or cloud execution. The supplied source does not include the underlying get_project implementation, so the exact project details returned cannot be specified from this context.
OpenKatana · Get project Input Parameters:
project_id
A required STRING identifying the OpenKatana project you want to query. The inherited default is my-film. Use the same identifier used when creating or opening your project so that the request targets the intended workspace; this is a project identifier, not a descriptive project title or a media file path. The supplied node interface does not define a minimum length, maximum length, or list of selectable options. OpenKatana’s hosted project-selection code separately validates identifiers as 1–80 characters, starting with a letter or digit and containing only letters, digits, underscores, or hyphens; however, the supplied code does not establish whether the local get_project tool applies that same validation.
arguments
A required STRING containing tool arguments in JSON form. The inherited default is {}, which represents an empty JSON object and is the appropriate starting point when you only need to specify the project through project_id. The node passes this text through OpenKatana’s argument-preparation helpers before calling the tool, using the same JSON contract as the CLI and MCP interfaces. This field supports multiline text, which can make longer JSON easier to read. No text-length limits or additional supported argument keys are documented in the supplied interface, and the underlying get_project argument schema is not shown. Keep the default unless you have verified that additional arguments are supported; do not assume that settings from other OpenKatana tools apply here.
after
An optional STRING connection intended to establish execution order within your ComfyUI graph. The inherited interface marks this as a connection-only input with forceInput enabled, so you connect another node’s compatible output rather than entering ordinary text into a widget. For example, connecting the result of a project-creation step can make this request wait until that step has executed. The execution method accepts after but does not read its contents or forward them to the OpenKatana tool, so it does not select a project, add arguments, or filter the returned information. No default value, text-length limits, or selectable options are specified.
OpenKatana · Get project Output Parameters:
result_json
A STRING containing the OpenKatana tool response as prepared by the bridge’s response helper. This is the node’s only output and is intended to carry the result in JSON text form, making it useful for displaying the response or passing it to a downstream text-processing or JSON-processing step. Read it as the tool’s response to your project-information request, rather than as an image, video, or rendered preview. The supplied context does not show the get_project return schema or the response helper’s implementation, so specific field names, project properties, and error-envelope formats cannot be guaranteed. Inspect an actual response before configuring downstream processing around particular JSON fields.
OpenKatana · Get project Usage Tips:
- Start with the correct
project_idand leaveargumentsset to{}. This provides a simple baseline without introducing undocumented arguments. - Use the same project identifier across your OpenKatana nodes and Studio workflow. The inherited
my-filmvalue is only a default; change it if your project was created under another identifier. - Connect a preceding project-creation or project-editing node’s compatible STRING output to
afterwhen you need this query to run afterward. The connection controls workflow ordering; its text is not used as project data. - Connect
result_jsonto a text display or inspection node before building further automation. Confirm the actual response structure rather than assuming that it contains particular asset, timeline, or settings fields. - Keep JSON valid if you edit
arguments: use double quotes for property names and text values, and avoid comments or trailing commas. An empty object,{}, is sufficient when no extra arguments are needed. - Expect the node to request fresh information when executed. Its inherited change-checking method deliberately prevents ordinary cached reuse because project state can also change through Studio, CLI, or MCP.
OpenKatana · Get project Common Errors and Solutions:
Project not found
- Explanation: This exact message appears in the supplied hosted project-selection code when the requested project’s
project.jsonfile is missing. The localget_projectimplementation is not shown, so it may report a missing project differently. - Solution: Check the spelling of
project_idand confirm that the project exists in the OpenKatana workspace being used. Create or reopen the intended project with the workspace node if necessary, and useafterto ensure creation finishes before this request runs.
Invalid project ID
- Explanation: This exact message appears in the supplied hosted project-selection code for an identifier that fails its naming rules. The context does not confirm that the local
get_projecttool uses the same check. - Solution: Use a simple identifier such as
my-filmorfilm_01rather than a folder path or a title containing spaces. For compatibility with the shown hosted validation, use 1–80 characters, begin with a letter or digit, and use only letters, digits, underscores, or hyphens.
Invalid JSON in arguments — exact message may vary
- Explanation: The bridge expects
argumentsto follow the tool’s JSON contract. Broken JSON, such as unquoted property names or a trailing comma, can prevent argument preparation or tool execution. The supplied source does not show the exact parsing-error text. - Solution: Reset
argumentsto{}and try again. If you need additional documented arguments, add them carefully using valid JSON with double-quoted property names and text values.
unexpected inputs: …
- Explanation: The node explicitly raises a
TypeErrorbeginning with this text if execution receives extra named fields outside its registered tool inputs. This can occur with an outdated workflow or an external caller sending fields that do not belong to the loaded node. - Solution: Use only the displayed inputs:
project_id,arguments, and optionalafter. If an older workflow exposes additional inputs, recreate the node from the currently installed version and reconnect it.
Downstream JSON field missing — exact message depends on the receiving node
- Explanation: A later processing step may fail if it expects a property that is not present in
result_json. The supplied context does not document the returned project schema, so assumed field names may be incorrect. - Solution: Display the complete
result_jsonfirst, verify that the project request succeeded, and update your downstream field selection to match the actual response. If execution itself fails, resolve that error before attempting to extract project properties.
