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

# Retrieve

> Scene Manager's whole document in the open scene.



## OpenAPI

````yaml /scene-manager-3/api-reference/openapi.json get /document
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:
  /document:
    get:
      tags:
        - Document
      summary: Retrieve
      description: Scene Manager's whole document in the open scene.
      operationId: getDocument
      responses:
        '200':
          description: The open scene's document
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentState'
        '503':
          description: No DCC or CAD app is connected
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    DocumentState:
      type: object
      properties:
        readOnly:
          type: boolean
        document:
          $ref: '#/components/schemas/SceneDocument'
        imported:
          $ref: '#/components/schemas/ImportReport'
        generation:
          type: number
        revision:
          type: number
          description: >-
            Counts the document's changes: PUT /document with If-Match set to it
            is refused (409, conflict) once another write came in between
        unreadable:
          type: string
          description: >-
            Why the scene's document could not be read; while set, the document
            is empty and nothing is written
      required:
        - readOnly
        - document
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
    SceneDocument:
      type: object
      additionalProperties: {}
      description: >-
        The scene's Scene Manager document (format `scenemanager`, integer
        `version`).
    ImportReport:
      type: object
      properties:
        setups:
          type: number
        modules:
          type: array
          items:
            type: string
        skipped:
          type: array
          items:
            type: object
            properties:
              what:
                type: string
              reason:
                type: string
              setups:
                type: array
                items:
                  type: string
            required:
              - what
              - reason
              - setups
        at:
          type: string
      required:
        - setups
        - modules
        - skipped

````

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