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

# Stage scene

> Save an open scene into a reserved job folder. This machine only



## OpenAPI

````yaml /renderflow/api-reference/openapi.json post /jobs/stage-scene
openapi: 3.1.0
info:
  title: RenderFlow API
  version: 2.0.0
  description: Render farm management.
servers:
  - url: http://localhost:44442/api/v1
    description: The service on this machine. Answers without a credential
  - url: http://your-server:44442/api/v1
    description: A farm's server. Needs an API key
  - url: https://your-server:44445/api/v1
    description: A farm's server set up with TLS. Needs an API key
security:
  - bearerAuth: []
paths:
  /jobs/stage-scene:
    post:
      tags:
        - Jobs
      summary: Stage scene
      description: Save an open scene into a reserved job folder. This machine only
      operationId: stageScene
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SceneStage'
      responses:
        '200':
          description: Where the scene is now. Submit the step pointing at `path`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SceneStageResult'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Not permitted for this credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: >-
            This machine has no repository to write into, or the application
            refused
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    SceneStage:
      type: object
      properties:
        job_id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
          description: A reservation from `POST /jobs/reserve`
        port:
          type: integer
          exclusiveMinimum: 0
          description: >-
            The live host holding the scene. The port its RenderFlow plugin
            bound
        file:
          type: string
          minLength: 1
          description: The scene's path on this machine
        save_option:
          type: string
          enum:
            - copy
            - overwrite
            - none
          description: >-
            `copy` writes it into the job's repository folder, `overwrite`
            writes it back where it is, `none` leaves it alone
      required:
        - job_id
        - port
        - file
        - save_option
    SceneStageResult:
      type: object
      properties:
        path:
          type: string
          description: Where the scene is now. Submit the step pointing here
        saved:
          type: boolean
          description: >-
            False when the application reported no unsaved changes, which is not
            a failure
      required:
        - path
        - saved
    ApiError:
      type: object
      properties:
        error:
          type: string
        tag:
          type: string
          description: The catalog entry this failure is, when it is one
        title:
          type: string
          description: The catalog entry's title
        detail:
          type: string
          description: What happened this time, and what to do
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
            required:
              - path
              - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key from Settings, API Keys. A caller on this machine needs none.

````

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