Connecting
connect() finds Scene Manager on this computer. Each request times out after 120 seconds; pass timeout to change that.
Finding a method
Each endpoint in the API reference is a method. Methods are grouped by the first part of the path and named after the operation, in snake case:
Path parameters are positional, query parameters are keyword arguments, and a request body goes in
body=. Results support dot access, and to_dict() returns the raw data. Images such as thumbnails and shots come back as bytes.
The package ships models.pyi, so your editor and type checker know every result’s fields.
Activating and rendering
scene.render.wait() checks the render every two seconds. Pass timeout in seconds to stop waiting with a TimeoutError.
Running a script
language is maxscript (the default) or python. In Python, set a variable named result to return a value.
Errors
ApiError has the HTTP status, the response body, and Scene Manager’s message. Without a licence, every call except scene.health.get_health() raises it with status 402. If Scene Manager isn’t running, status is 0.