> ## 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.

# Status

> Whether Scene Manager is running and connected to 3ds Max.



## OpenAPI

````yaml /scene-manager-3/api-reference/openapi.json get /health
openapi: 3.1.0
info:
  title: Scene Manager
  version: 3.0.0
  description: >-
    Scene Manager's local API, on the computer it runs on. Every call needs a
    Scene Manager licence on this computer.
servers:
  - url: http://127.0.0.1:45710/api/v1
    description: Scene Manager on this computer
security: []
tags:
  - name: Service
    description: Whether Scene Manager is running and connected to an app.
  - name: Setups
    description: 'Saved states of the scene: list, make, change, activate.'
  - name: Folders
    description: Folders of setups. A folder's values pass down to its setups.
  - name: Modules
    description: The parts of a setup (Camera, Output, Lights…) and the properties in them.
  - name: Rendering
    description: Batch render setups, follow the progress, stop.
  - name: Variations
    description: Sets of options rendered in every combination.
  - name: Comments
    description: Comments pinned on shots of the scene, for people and agents.
  - name: Shots
    description: Viewport and frame buffer captures that comments are pinned on.
  - name: Scene
    description: >-
      The open scene itself: its objects, materials, properties, selection and
      scripts.
  - name: Document
    description: Scene Manager's whole document in the open scene, and 2.x import.
  - name: Settings
    description: This person's settings on this computer.
  - name: HDRI library
    description: The HDRI maps in the library folders and in the scene.
paths:
  /health:
    get:
      tags:
        - Service
      summary: Status
      description: Whether Scene Manager is running and connected to 3ds Max.
      operationId: getHealth
      responses:
        '200':
          description: The service is up
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
components:
  schemas:
    Health:
      type: object
      properties:
        ok:
          type: boolean
        version:
          type: string
        build:
          type: string
          description: >-
            The build number (291 in 3.0.0.291); absent when the service runs
            from a checkout
        connected:
          type: boolean
        licensed:
          type: boolean
          description: >-
            Whether Scene Manager may be used on this computer: without a
            licence every other call answers 402
        pid:
          type: number
          description: >-
            The connected app's process: Scene Manager works with one app at a
            time
        person:
          type: string
          description: Who sits at this machine
        names:
          type: number
          description: >-
            Counts renames, additions and removals in the app: names and what is
            missing are read again when it moves
        busy:
          type: object
          properties:
            what:
              type: string
            label:
              type: string
            since:
              type: string
          required:
            - what
            - label
            - since
          description: >-
            What the app is busy with (a file opening or saving, a merge, an
            import or export, a render): changes are refused until it is done
        generation:
          type: number
          description: >-
            Counts the scenes read: a document written for another (PUT
            /document's X-Scene-Generation) is refused
        helper:
          type: string
          description: >-
            The command an agent runs to wait for the next comment (this
            service's own executable): `<it> --for <name> --seconds <n>`
      required:
        - ok
        - version
        - connected
        - licensed
        - person
        - helper

````

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