Houdini API

19 bundled Tech Connector wrapper functions in the current source catalog. This is not a count of the host application’s native API. A listed function may require its host application and bridge to be available.

Search the API

Type to search all API references.

← All hosts

Bundled Python wrappers

api_call

api.dcc.houdini.api_call(...)

Signature: api_call(function: str, args: list[Any] | None = None, kwargs: dict[str, Any] | None = None) -> Any
Target: houdini_tools.operations.api_call
Source: houdini_tools/operations.py:120
Name status: Friendly call available

Parameters

function · str · required
args · list[Any] | None · default None
kwargs · dict[str, Any] | None · default None

execute

api.dcc.houdini.execute(...)

Signature: execute(capability: str, payload: dict[str, Any]) -> dict[str, Any]
Target: houdini_tools.Rigging.rigging_host_adapter.execute
Source: houdini_tools/Rigging/rigging_host_adapter.py:172
Name status: Friendly call available

Parameters

capability · str · required
payload · dict[str, Any] · required

export

api.dcc.houdini.export(...)

Signature: export(filepath: str, node_path: str = "/obj", frame_range: list[int] | tuple[int, int] | None = None) -> dict[str, Any]
Target: houdini_tools.usd.export
Source: houdini_tools/usd.py:9
Name status: Friendly call available

Parameters

filepath · str · required
node_path · str · default '/obj'
frame_range · list[int] | tuple[int, int] | None · default None

export_file

api.dcc.houdini.export_file(...)

Signature: export_file(node_path: str, filepath: str, frame: int = 1) -> dict[str, Any]
Target: houdini_tools.geometry.export_file
Source: houdini_tools/geometry.py:25
Name status: Friendly call available

Parameters

node_path · str · required
filepath · str · required
frame · int · default 1

Related functions

api.dcc.houdini.import_file(...)

import_file

api.dcc.houdini.import_file(...)

Signature: import_file(filepath: str, parent: str = "/obj", name: str = "ai_import") -> dict[str, Any]
Target: houdini_tools.geometry.import_file
Source: houdini_tools/geometry.py:9
Name status: Friendly call available

Parameters

filepath · str · required
parent · str · default '/obj'
name · str · default 'ai_import'

Related functions

api.dcc.houdini.export_file(...)

inspect_procedural_fx

api.dcc.houdini.inspect_procedural_fx(...)

Signature: inspect_procedural_fx(
Target: houdini_tools.validation.inspect_procedural_fx
Source: houdini_tools/validation.py:9
Name status: Friendly call available

Parameters

source_node · str · required
transform_node · str · required
dop_network_path · str · required
usd_path · str · required
start_frame · int · default 1
end_frame · int · default 24

material_assign

api.dcc.houdini.material_assign(...)

Signature: material_assign(
Target: houdini_tools.operations.material_assign
Source: houdini_tools/operations.py:100
Name status: Friendly call available

Parameters

material_path · str · required
node_path · str · default ''
nodes · Iterable[str] | None · default None

Related functions

api.dcc.houdini.material_create(...)

material_create

api.dcc.houdini.material_create(...)

Signature: material_create(
Target: houdini_tools.operations.material_create
Source: houdini_tools/operations.py:81
Name status: Friendly call available

Parameters

material_name · str · required
network · str · default '/mat'
shader_type · str · default 'principledshader::2.0'
color · Iterable[float] | None · default None

Related functions

node_connect

api.dcc.houdini.node_connect(...)

Signature: node_connect(
Target: houdini_tools.operations.node_connect
Source: houdini_tools/operations.py:60
Name status: Friendly call available

Parameters

source_path · str · required
destination_path · str · required
output_index · int · default 0
input_index · int · default 0

Related functions

node_create

api.dcc.houdini.node_create(...)

Signature: node_create(node_type: str, parent: str = "/obj", name: str = "") -> dict[str, Any]
Target: houdini_tools.operations.node_create
Source: houdini_tools/operations.py:45
Name status: Friendly call available

Parameters

node_type · str · required
parent · str · default '/obj'
name · str · default ''

Related functions

node_set_parm

api.dcc.houdini.node_set_parm(...)

Signature: node_set_parm(node_path: str, parm_name: str, value: Any) -> dict[str, Any]
Target: houdini_tools.operations.node_set_parm
Source: houdini_tools/operations.py:51
Name status: Friendly call available

Parameters

node_path · str · required
parm_name · str · required
value · Any · required

Related functions

reload_dependencies

api.dcc.houdini.reload_dependencies(...)

Signature: reload_dependencies() -> int
Target: houdini_tools.Rigging.rigging_host_adapter.reload_dependencies
Source: houdini_tools/Rigging/rigging_host_adapter.py:116
Name status: Friendly call available

Refresh the shared portable contract used by this live Houdini host.

Parameters

None documented.

run

api.dcc.houdini.run(...)

Signature: run(dop_network_path: str, start_frame: int = 1, end_frame: int = 100, substeps: int = 1) -> dict[str, Any]
Target: houdini_tools.simulation.run
Source: houdini_tools/simulation.py:8
Name status: Friendly call available

Parameters

dop_network_path · str · required
start_frame · int · default 1
end_frame · int · default 100
substeps · int · default 1

scene_joints

api.dcc.houdini.scene_joints(...)

Signature: scene_joints() -> dict[str, Any]
Target: houdini_tools.Rigging.rigging_host_adapter.scene_joints
Source: houdini_tools/Rigging/rigging_host_adapter.py:132
Name status: Friendly call available

Parameters

None documented.

scene_list

api.dcc.houdini.scene_list(...)

Signature: scene_list(network: str = "/obj", recursive: bool = True, limit: int = 500) -> dict[str, Any]
Target: houdini_tools.operations.scene_list
Source: houdini_tools/operations.py:35
Name status: Friendly call available

Parameters

network · str · default '/obj'
recursive · bool · default True
limit · int · default 500

Related functions

api.dcc.houdini.scene_select(...)

scene_select

api.dcc.houdini.scene_select(...)

Signature: scene_select(nodes: Iterable[str], replace: bool = True) -> dict[str, Any]
Target: houdini_tools.operations.scene_select
Source: houdini_tools/operations.py:22
Name status: Friendly call available

Parameters

nodes · Iterable[str] · required
replace · bool · default True

Related functions

api.dcc.houdini.scene_list(...)

script_run

api.dcc.houdini.script_run(...)

Signature: script_run(code: str) -> Any
Target: houdini_tools.operations.script_run
Source: houdini_tools/operations.py:129
Name status: Friendly call available

Parameters

code · str · required

selection

api.dcc.houdini.selection(...)

Signature: selection() -> dict[str, Any]
Target: houdini_tools.Rigging.rigging_host_adapter.selection
Source: houdini_tools/Rigging/rigging_host_adapter.py:168
Name status: Friendly call available

Parameters

None documented.

submit

api.dcc.houdini.submit(...)

Signature: submit(rop_path: str, start_frame: int = 1, end_frame: int = 100, step: int = 1) -> dict[str, Any]
Target: houdini_tools.render.submit
Source: houdini_tools/render.py:8
Name status: Friendly call available

Parameters

rop_path · str · required
start_frame · int · default 1
end_frame · int · default 100
step · int · default 1

Registered host operations

These are planner and bridge operations, not individual Python wrapper methods. Availability depends on a connected host, its bridge, required inputs, and the operation’s execution mode.

Houdini API Call

api.call · host_native · changes project

Call a Houdini Python hou API function with explicit args/kwargs.

Required inputs: function.

Houdini Export Geometry

geometry.export · host_native · read-only or UI action

Export geometry from a Houdini SOP node to a file.

Required inputs: node_path, filepath.

Houdini Import Geometry

geometry.import · host_native · changes project

Import a geometry file (OBJ, FBX, USD) into the Houdini scene.

Required inputs: filepath.

Houdini Assign Material

material.assign · host_native · changes project

Assign a material to a Houdini geometry node.

Required inputs: node_path, material_path.

Houdini Create Material

material.create · host_native · changes project

Create a material in the Houdini /mat network.

Required inputs: material_name.

Houdini Connect Nodes

node.connect · host_native · changes project

Connect the output of one Houdini node to the input of another.

Required inputs: source_path, destination_path.

Houdini Create Node

node.create · host_native · changes project

Create a Houdini node of a given type inside a network.

Required inputs: node_type.

Houdini Set Parameter

node.set_parm · host_native · changes project

Set a parameter value on a Houdini node.

Required inputs: node_path, parm_name, value.

Houdini Render Submit

render.submit · host_native · read-only or UI action

Submit a render through a Houdini ROP node.

Required inputs: rop_path.

Houdini List Scene

scene.list · host_native · read-only or UI action

List nodes in the Houdini scene under a given network path.

Required inputs: none.

Houdini Select Nodes

scene.select · host_native · changes project

Select one or more nodes in the Houdini scene by name or path.

Required inputs: nodes.

Houdini Run Script

script.run · host_native · changes project

Run explicit Houdini Python code (hou module) through the direct bridge.

Required inputs: code.

Houdini Run Simulation

simulation.run · host_native · changes project

Run a DOP simulation in Houdini for the specified frame range.

Required inputs: dop_network_path.

Houdini USD Export

usd.export · host_native · read-only or UI action

Export the Houdini scene or selected network as a USD file.

Required inputs: filepath.

Houdini Inspect Procedural FX Workflow

workflow.inspect_procedural_fx · host_native · read-only or UI action

Read back SOP topology, simulation range, bounds, and exported USD composition.

Required inputs: source_node, transform_node, dop_network_path, usd_path.

Screenshots show actual Tech Connector widgets with sample labels. A screenshot or saved graph does not prove a live DCC run.