Product documentation · Current desktop UI

Blender API

35 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.

Type to search all API references.

    ← All hosts

    Bundled Python wrappers

    1. activate
    2. armature_names
    3. bake_keyframes
    4. build_control_rig_from_import
    5. camera_names
    6. clean_imported_skeletal_fbx
    7. display_range
    8. entries_from_selection
    9. entries_from_timeline
    10. execute
    11. export_entry
    12. export_fbx
    13. export_fbx_file
    14. frames_per_second
    15. import_fbx
    16. inspect_generalist_asset
    17. install_unreal_publisher
    18. process_meshes_for_transfer
    19. publish_document
    20. read_document
    21. reload_dependencies
    22. render_scene
    23. scene_joints
    24. scene_path
    25. selected_node_names
    26. selection
    27. set_display_range
    28. set_engine_context
    29. set_keyframe
    30. unregister
    31. write_document
    32. register
    33. register
    34. show_sequence_manager
    35. show_sequence_manager

    activate

    api.dcc.blender.activate(...)
    Signature
    activate(**settings)
    Target
    blender_tools.Rigging.surface_spatial_skin_brush.activate
    Source
    blender_tools/Rigging/surface_spatial_skin_brush.py:188
    Name status
    Friendly call available

    Parameters

    • **settings · required

    armature_names

    api.dcc.blender.armature_names(...)
    Signature
    armature_names(*, bpy_module=None) -> list[str]
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.armature_names
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:61
    Name status
    Friendly call available

    Parameters

    • bpy_module · default None

    Related functions

    bake_keyframes

    api.dcc.blender.bake_keyframes(...)
    Signature
    bake_keyframes(start_frame: int, end_frame: int, only_selected: bool = True) -> dict[str, Any]
    Target
    blender_tools.animation.bake_keyframes
    Source
    blender_tools/animation.py:47
    Name status
    Friendly call available

    Parameters

    • start_frame · int · required
    • end_frame · int · required
    • only_selected · bool · default True

    build_control_rig_from_import

    api.dcc.blender.build_control_rig_from_import(...)
    Signature
    build_control_rig_from_import(
    Target
    blender_tools.Rigging.rigging_host_adapter.build_control_rig_from_import
    Source
    blender_tools/Rigging/rigging_host_adapter.py:1125
    Name status
    Friendly call available

    Build editable controls for one imported armature and report the result. The import stage supplies its newly created armature names. Refusing an ambiguous scene keeps a prompt from rigging an unrelated open character.

    Parameters

    • armatures · list[str] | None · default None
    • set_t_pose · bool · default False
    • ik_fk_blend · float · default 0.0

    camera_names

    api.dcc.blender.camera_names(...)
    Signature
    camera_names(*, bpy_module=None) -> list[str]
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.camera_names
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:56
    Name status
    Friendly call available

    Parameters

    • bpy_module · default None

    Related functions

    clean_imported_skeletal_fbx

    api.dcc.blender.clean_imported_skeletal_fbx(...)
    Signature
    clean_imported_skeletal_fbx(objects: list[str], filepath: str) -> dict[str, Any]
    Target
    blender_tools.io.clean_imported_skeletal_fbx
    Source
    blender_tools/io.py:73
    Name status
    Friendly call available

    Re-export an imported character as a skeleton and weighted meshes only. Maya's selected FBX export can follow rig connections into controls and hierarchy nodes. Work only on the objects returned by this import, then replace them after a structural reimport check. The original FBX is kept.

    Parameters

    • objects · list[str] · required
    • filepath · str · required

    Related functions

    display_range

    api.dcc.blender.display_range(...)
    Signature
    display_range(scene=None, *, bpy_module=None) -> tuple[int, int]
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.display_range
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:38
    Name status
    Friendly call available

    Parameters

    • scene · default None
    • bpy_module · default None

    Related functions

    entries_from_selection

    api.dcc.blender.entries_from_selection(...)
    Signature
    entries_from_selection(scene=None, *, bpy_module=None) -> list[dict[str, Any]]
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.entries_from_selection
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:143
    Name status
    Friendly call available

    Parameters

    • scene · default None
    • bpy_module · default None

    Related functions

    entries_from_timeline

    api.dcc.blender.entries_from_timeline(...)
    Signature
    entries_from_timeline(scene=None, *, bpy_module=None) -> list[dict[str, Any]]
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.entries_from_timeline
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:168
    Name status
    Friendly call available

    Create camera and character export rows from Blender timeline markers.

    Parameters

    • scene · default None
    • bpy_module · default None

    Related functions

    execute

    api.dcc.blender.execute(...)
    Signature
    execute(capability: str, payload: dict[str, Any]) -> dict[str, Any]
    Target
    blender_tools.Rigging.rigging_host_adapter.execute
    Source
    blender_tools/Rigging/rigging_host_adapter.py:283
    Name status
    Friendly call available

    Parameters

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

    export_entry

    api.dcc.blender.export_entry(...)
    Signature
    export_entry(entry: Mapping[str, Any], *, default_directory: str = "", bpy_module=None) -> dict[str, Any]
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.export_entry
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:209
    Name status
    Friendly call available

    Parameters

    • entry · Mapping[str, Any] · required
    • default_directory · str · default ''
    • bpy_module · default None

    export_fbx

    api.dcc.blender.export_fbx(...)
    Signature
    export_fbx(
    Target
    blender_tools.io.export_fbx
    Source
    blender_tools/io.py:211
    Name status
    Friendly call available

    Parameters

    • filepath · str · required
    • selected_only · bool · default True
    • apply_unit_scale · bool · default True
    • axis_forward · str · default '-Z'
    • axis_up · str · default 'Y'
    • object_names · list[str] | tuple[str, ...] | None · default None
    • bake_animation · bool · default True
    • add_leaf_bones · bool · default False

    Related functions

    export_fbx_file

    api.dcc.blender.export_fbx_file(...)
    Signature
    export_fbx_file(filepath: str, *, bpy_module=None, **options: Any) -> Path
    Target
    blender_tools.io.export_fbx_file
    Source
    blender_tools/io.py:9
    Name status
    Friendly call available

    Run Blender's FBX operator and verify that it produced a nonempty file.

    Parameters

    • filepath · str · required
    • bpy_module · default None
    • **options · Any · required

    Related functions

    frames_per_second

    api.dcc.blender.frames_per_second(...)
    Signature
    frames_per_second(scene=None, *, bpy_module=None) -> float
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.frames_per_second
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:27
    Name status
    Friendly call available

    Parameters

    • scene · default None
    • bpy_module · default None

    import_fbx

    api.dcc.blender.import_fbx(...)
    Signature
    import_fbx(
    Target
    blender_tools.io.import_fbx
    Source
    blender_tools/io.py:24
    Name status
    Friendly call available

    Parameters

    • filepath · str · required
    • use_image_search · bool · default True
    • animation_offset · float · default 0.0

    Related functions

    inspect_generalist_asset

    api.dcc.blender.inspect_generalist_asset(...)
    Signature
    inspect_generalist_asset(
    Target
    blender_tools.validation.inspect_generalist_asset
    Source
    blender_tools/validation.py:8
    Name status
    Friendly call available

    Parameters

    • object_name · str · required
    • material_name · str · required
    • start_frame · int · default 1
    • end_frame · int · default 24

    install_unreal_publisher

    api.dcc.blender.install_unreal_publisher(...)
    Signature
    install_unreal_publisher(
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.install_unreal_publisher
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:123
    Name status
    Friendly call available

    Install the concrete Tech Connector → Unreal Sequence publisher.

    Parameters

    • destination_path · default '/Game/Animations'
    • mode · default 'gameplay'
    • conflict_policy · default 'update'
    • source_control_policy · default 'auto'
    • unreal_project_path · default ''
    • unreal_command_path · default ''
    • log_file_path · default ''
    • bpy_module · default None

    process_meshes_for_transfer

    api.dcc.blender.process_meshes_for_transfer(...)
    Signature
    process_meshes_for_transfer(
    Target
    blender_tools.pipeline_transfer.process_meshes_for_transfer
    Source
    blender_tools/pipeline_transfer.py:8
    Name status
    Friendly call available

    Prepare Blender meshes for export and report every mutation.

    Parameters

    • objects · list[str] | tuple[str, ...] | None · default None
    • clean_names · bool · default True
    • apply_transforms · bool · default True
    • lod_count · int · default 0
    • ensure_material_slots · bool · default False
    • create_collision · bool · default False
    • bevel_width · float · default 0.0
    • bevel_segments · int · default 2

    publish_document

    api.dcc.blender.publish_document(...)
    Signature
    publish_document(document: Mapping[str, Any], *, bpy_module=None) -> dict[str, Any]
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.publish_document
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:111
    Name status
    Friendly call available

    Publish through a real engine callback installed by Tech Connector.

    Parameters

    • document · Mapping[str, Any] · required
    • bpy_module · default None

    Related functions

    read_document

    api.dcc.blender.read_document(...)
    Signature
    read_document(scene=None, *, bpy_module=None) -> dict[str, Any]
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.read_document
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:66
    Name status
    Friendly call available

    Parameters

    • scene · default None
    • bpy_module · default None

    Related functions

    reload_dependencies

    api.dcc.blender.reload_dependencies(...)
    Signature
    reload_dependencies() -> int
    Target
    blender_tools.Rigging.rigging_host_adapter.reload_dependencies
    Source
    blender_tools/Rigging/rigging_host_adapter.py:32
    Name status
    Friendly call available

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

    Parameters

    None documented.

    render_scene

    api.dcc.blender.render_scene(...)
    Signature
    render_scene(output_path: str = "", animation: bool = False, write_still: bool = True) -> dict[str, Any]
    Target
    blender_tools.render.render_scene
    Source
    blender_tools/render.py:8
    Name status
    Friendly call available

    Parameters

    • output_path · str · default ''
    • animation · bool · default False
    • write_still · bool · default True

    scene_joints

    api.dcc.blender.scene_joints(...)
    Signature
    scene_joints() -> dict[str, Any]
    Target
    blender_tools.Rigging.rigging_host_adapter.scene_joints
    Source
    blender_tools/Rigging/rigging_host_adapter.py:255
    Name status
    Friendly call available

    Parameters

    None documented.

    scene_path

    api.dcc.blender.scene_path(...)
    Signature
    scene_path(*, bpy_module=None) -> str
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.scene_path
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:34
    Name status
    Friendly call available

    Parameters

    • bpy_module · default None

    selected_node_names

    api.dcc.blender.selected_node_names(...)
    Signature
    selected_node_names(*, bpy_module=None) -> list[str]
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.selected_node_names
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:52
    Name status
    Friendly call available

    Parameters

    • bpy_module · default None

    Related functions

    selection

    api.dcc.blender.selection(...)
    Signature
    selection() -> dict[str, Any]
    Target
    blender_tools.Rigging.rigging_host_adapter.selection
    Source
    blender_tools/Rigging/rigging_host_adapter.py:274
    Name status
    Friendly call available

    Parameters

    None documented.

    set_display_range

    api.dcc.blender.set_display_range(...)
    Signature
    set_display_range(start_frame: int, end_frame: int, scene=None, *, bpy_module=None) -> None
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.set_display_range
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:44
    Name status
    Friendly call available

    Parameters

    • start_frame · int · required
    • end_frame · int · required
    • scene · default None
    • bpy_module · default None

    Related functions

    set_engine_context

    api.dcc.blender.set_engine_context(...)
    Signature
    set_engine_context(
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.set_engine_context
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:95
    Name status
    Friendly call available

    Update connection facts supplied by Tech Connector or an engine bridge.

    Parameters

    • status · str · required
    • project · str · default ''
    • known_skeletons · Iterable[str] · default ()
    • message · str · default ''
    • scene · default None
    • bpy_module · default None

    Related functions

    set_keyframe

    api.dcc.blender.set_keyframe(...)
    Signature
    set_keyframe(
    Target
    blender_tools.animation.set_keyframe
    Source
    blender_tools/animation.py:8
    Name status
    Friendly call available

    Parameters

    • object_name · str · required
    • data_path · str · required
    • frame · int · required
    • value · Any · required
    • index · int · default -1

    unregister

    api.dcc.blender.unregister(...)
    Signature
    unregister()
    Target
    blender_tools.Cinematics.SequenceUI.sequence_ui.unregister
    Source
    blender_tools/Cinematics/SequenceUI/sequence_ui.py:489
    Name status
    Friendly call available

    Parameters

    None documented.

    write_document

    api.dcc.blender.write_document(...)
    Signature
    write_document(document: Mapping[str, Any], scene=None, *, bpy_module=None) -> dict[str, Any]
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.write_document
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:82
    Name status
    Friendly call available

    Parameters

    • document · Mapping[str, Any] · required
    • scene · default None
    • bpy_module · default None

    Related functions

    register

    api.dcc.blender.call('blender_tools.Cinematics.SequenceUI.sequence_ui.register', ...)
    Signature
    register()
    Target
    blender_tools.Cinematics.SequenceUI.sequence_ui.register
    Source
    blender_tools/Cinematics/SequenceUI/sequence_ui.py:469
    Name status
    Use the full target path

    Parameters

    None documented.

    register

    api.dcc.blender.call('blender_tools.Rigging.surface_spatial_skin_brush.register', ...)
    Signature
    register()
    Target
    blender_tools.Rigging.surface_spatial_skin_brush.register
    Source
    blender_tools/Rigging/surface_spatial_skin_brush.py:167
    Name status
    Use the full target path

    Parameters

    None documented.

    show_sequence_manager

    api.dcc.blender.call('blender_tools.Cinematics.SequenceUI.sequence_ui.show_sequence_manager', ...)
    Signature
    show_sequence_manager()
    Target
    blender_tools.Cinematics.SequenceUI.sequence_ui.show_sequence_manager
    Source
    blender_tools/Cinematics/SequenceUI/sequence_ui.py:501
    Name status
    Use the full target path

    Parameters

    None documented.

    show_sequence_manager

    api.dcc.blender.call('blender_tools.Cinematics.SequenceUI.sequence_utils.show_sequence_manager', ...)
    Signature
    show_sequence_manager() -> dict[str, Any]
    Target
    blender_tools.Cinematics.SequenceUI.sequence_utils.show_sequence_manager
    Source
    blender_tools/Cinematics/SequenceUI/sequence_utils.py:240
    Name status
    Use the full target path

    Parameters

    None documented.

    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.

    Blender Bake Animation

    animation.bake · host_native · changes project

    Bake animation keyframes for selected objects/rigs in Blender.

    Required inputs: start_frame, end_frame.

    Blender Set Keyframe

    animation.set_key · host_native · changes project

    Set a Blender property value and insert a keyframe.

    Required inputs: object_name, data_path, frame, value.

    Blender API Call

    api.call · host_native · changes project

    Call a Blender bpy function/operator with explicit args/kwargs.

    Required inputs: function.

    Blender Clean Animation

    blender.clean_animation · host_native · changes project

    Clean a Blender mocap/action clip by trimming range, simplifying curves, and preserving root-motion/export metadata.

    Required inputs: none.

    Blender Export Unreal FBX

    blender.export_fbx · host_native · read-only or UI action

    Export a cleaned Blender animation/armature as Unreal-compatible FBX with recorded export settings.

    Required inputs: output_path.

    Blender Scan Animation

    blender.scan_animation · host_native · read-only or UI action

    Read back Blender armatures, actions, selection, frame range, and scene scale before cleanup/export.

    Required inputs: none.

    Blender Open Sequence Workspace

    cinematics.sequence_ui · host_native · read-only or UI action

    Register and expose the native Blender Sequence Workspace for shot and animation export authoring.

    Required inputs: none.

    Blender Clean Imported Skeleton and Mesh FBX

    io.clean_imported_skeletal_fbx · host_native · changes project

    Re-export imported character bones and weighted meshes without Maya rig controls or hierarchy nodes, then reimport and verify.

    Required inputs: objects, filepath.

    Blender Export FBX

    io.export_fbx · host_native · read-only or UI action

    Export current scene or selection as FBX.

    Required inputs: filepath.

    Blender Import FBX

    io.import_fbx · host_native · changes project

    Import an FBX file into the Blender scene.

    Required inputs: filepath.

    Blender Assign Material

    material.assign · host_native · changes project

    Assign a material to named objects or the current Blender selection.

    Required inputs: material_name.

    Blender Create Material

    material.create · host_native · changes project

    Create a Blender material and optionally set its color.

    Required inputs: material_name.

    Blender Set Material Color

    material.set_color · host_native · changes project

    Set a Blender material base color/diffuse color.

    Required inputs: material_name, color.

    Blender Create Primitive

    modeling.create_primitive · host_native · changes project

    Create a basic geometric mesh primitive in Blender.

    Required inputs: primitive_type.

    Blender Frame Selection

    navigation.frame_selection · host_native · read-only or UI action

    Frame the current selection or named objects in the active 3D view.

    Required inputs: none.

    Blender Prepare Meshes for Transfer

    pipeline.process_meshes_for_transfer · host_native · changes project

    Clean mesh names, apply transforms, add an optional angle-limited bevel, generate LOD copies, ensure material slots, and create UCX collision meshes before export.

    Required inputs: none.

    Blender Render Scene

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

    Render the active viewport or camera view in Blender.

    Required inputs: output_path.

    Blender Build Controls for Imported Rig

    rigging.build_control_rig_from_import · host_native · changes project

    Auto-map an imported armature, validate the mapping, and build editable Blender controls.

    Required inputs: none.

    Blender Select Objects

    scene.select · host_native · changes project

    Select one or more Blender objects by name.

    Required inputs: objects.

    Blender Run Script

    script.run · host_native · changes project

    Run explicit Blender Python code through the direct bridge.

    Required inputs: code.

    Blender Inspect Generalist Asset

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

    Read back topology, UV/material assignment, and authored animation range.

    Required inputs: object_name, material_name.

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

    © 2026 The Entire World, LLC. Tech Connector software and original documentation. All rights reserved. Third-party names and marks belong to their respective owners. License options.