> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pulze.io/llms.txt
> Use this file to discover all available pages before exploring further.

# REST API

> What every Scene Manager 3 endpoint has in common: the address, a first workflow, changing values and errors.

The [API reference](https://docs.pulze.io/scene-manager-3/api-reference/introduction.md) describes each endpoint.

## Address

```
http://127.0.0.1:45710/api/v1
```

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

```bash List theme={null}
curl http://127.0.0.1:45710/api/v1/setups
```

```bash Activate theme={null}
curl -X POST http://127.0.0.1:45710/api/v1/setups/<id>/activate \
  -H "Content-Type: application/json" \
  -d '{ "wait": true }'
```

```bash Render theme={null}
curl -X POST http://127.0.0.1:45710/api/v1/render \
  -H "Content-Type: application/json" \
  -d '{ "setups": ["<id>", "<id>"] }'
```

```bash Progress theme={null}
curl http://127.0.0.1:45710/api/v1/render
```

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

```bash theme={null}
curl -X POST http://127.0.0.1:45710/api/v1/values \
  -H "Content-Type: application/json" \
  -d '{ "changes": [ { "owner": "<setup or folder id>", "values": { "output#path": "D:/Renders/{{setup}}_{{camera}}_v{{version:3}}.exr" } } ] }'
```

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

```json theme={null}
{ "error": "no DCC or CAD app is connected" }
```

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

| Status | Meaning |
| - | - |
| 400 | The request is malformed |
| 402 | There is no Scene Manager licence on this computer |
| 403 | The endpoint is reserved for the Scene Manager UI |
| 404 | The setup, folder, module or comment doesn't exist |
| 409 | The scene is read-only, a batch render is running, or 3ds Max is busy. When busy, the answer has `"busy": true`: try again shortly |
| 503 | Scene Manager is running, but 3ds Max isn't connected |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.