Blender 5.0 Python API Documentation

Welcome to the Python API documentation for Blender, the free and open source 3D creation suite.

This site can be used offline: Download the full documentation (zipped HTML files)

Documentation

• Quickstart: New to Blender or scripting and want to get your feet wet?

• API Overview: A more complete explanation of Python integration.

• API Reference Usage: Examples of how to use the API reference docs.

• Best Practice: Conventions to follow for writing good scripts.

• Tips and Tricks: Hints to help you while writing scripts for Blender.

• Gotchas: Some of the problems you may encounter when writing scripts.

• Advanced: Topics which may not be required for typical usage.

• Change Log: List of changes since last Blender release

Application Modules

• Context Access (bpy.context)
• Data Access (bpy.data)
• Message Bus (bpy.msgbus)
• Operators (bpy.ops)
• Types (bpy.types)
• Utilities (bpy.utils)
• Path Utilities (bpy.path)
• Application Data (bpy.app)
• Property Definitions (bpy.props)

Standalone Modules

• Audio System (aud)
• Additional Math Functions (bl_math)
• Font Drawing (blf)
• BMesh Module (bmesh)
• Extra Utilities (bpy_extras)
• Freestyle Module (freestyle)
• GPU Module (gpu)
• GPU Utilities (gpu_extras)
• ID Property Access (idprop.types)
• Image Buffer (imbuf)
• Math Types & Utilities (mathutils)

Indices

• Index

• Module Index