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

# Start

> Start a batch render of setups.



## OpenAPI

````yaml /scene-manager-3/api-reference/openapi.json post /render
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:
  /render:
    post:
      tags:
        - Rendering
      summary: Start
      description: Start a batch render of setups.
      operationId: startRender
      requestBody:
        description: The setups to render, in order
        content:
          application/json:
            schema:
              type: object
              properties:
                setups:
                  type: array
                  items:
                    type: string
                  minItems: 1
                quality:
                  type:
                    - string
                    - 'null'
                  description: >-
                    The quality level to render at (id or name), null for none;
                    left out: as the scene is set. Put back after the batch.
                agent:
                  type: boolean
                  description: >-
                    An agent's render: a renderer with no stop condition gets
                    limits (put back after), and a render past 10 min is
                    cancelled
              required:
                - setups
      responses:
        '200':
          description: Started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchRender'
        '404':
          description: No such setup
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: A batch render is already running
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: No DCC or CAD app is connected
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    BatchRender:
      type: object
      properties:
        id:
          type: string
        state:
          type: string
          enum:
            - running
            - done
            - stopped
        agent:
          type: boolean
          description: Started by an agent (MCP)
        started:
          type: string
        finished:
          type: string
        items:
          type: array
          items:
            type: object
            properties:
              setup:
                type: string
                description: The setup it renders; for a variation, its set's id
              set:
                type: string
                description: A variation's set (id)
              row:
                type: array
                items:
                  type: number
                description: 'A variation''s row: one option index per property'
              name:
                type: string
              status:
                type: string
                enum:
                  - queued
                  - applying
                  - rendering
                  - done
                  - failed
                  - stopped
              error:
                type: string
              skipped:
                type: number
              output:
                type: string
                description: The file it renders to, tokens filled in
              capped:
                type: string
                description: >-
                  An agent's render with no stop condition: the limits it
                  rendered with
              started:
                type: string
              finished:
                type: string
            required:
              - setup
              - name
              - status
      required:
        - id
        - state
        - started
        - items
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error

````

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