Get Python API Documentation
get_python_apiRetrieve documentation for any TouchDesigner Python class, with optional version filtering to show only API available in a specific TD version.
Instructions
Get documentation for a TouchDesigner Python class. Optionally filter to show only API available in a specific TD version.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"class_name": "<class_name>"
},
"name": "get_python_api"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| version | No | Filter to show only methods/members available in a specific TD version (e.g. '2023', '2022', '2021', '2020', '2019', '099'). Methods added after this version are marked or excluded. | |
| class_name | Yes | Python class name (e.g., 'CHOP', 'Channel', 'App') | |
| show_members | No | Show class members/properties | |
| show_methods | No | Show class methods | |
| show_inherited | No | Show inherited members and methods |