Skip to main content
The API reference describes each endpoint.

Address

The Scene Manager service only accepts connections from the same computer, so there is no API key. Open Scene Manager in 3ds Max to start it. Every call needs a Scene Manager licence on the computer, except GET /health. That one always answers: it tells you whether 3ds Max is connected (connected), whether there is a licence (licensed), and whether 3ds Max is busy (busy).

Activate and render setups

  1. GET /setups returns the setups in the order of the list, with their id, name, folder, tags and color.
  2. POST /setups/{id}/activate writes a setup into the scene and tells you what was applied and what was skipped, and why. With "wait": true it returns after the viewport has redrawn.
  3. POST /render renders the setups you list, in that order. Add quality to render at one of the scene’s quality levels.
  4. GET /render shows the batch’s state (running, done or stopped) and each setup’s status and output file. POST /render/stop stops it.

Changing values

A value’s key is <target>#<property>. To see a setup’s keys and values, call GET /setups/{id}/state. Values set on a folder apply to every setup in it. modulesOn and modulesOff turn modules on or off in the same call. When no endpoint does what you need, POST /scene/script runs MaxScript or Python in 3ds Max and returns the result.

Errors

error is a single sentence you can show to a user.