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

# Save the scene plan

> An entry replaces that scene's plan, null removes it, other scenes are kept. No base version needed. When a planned scene is generated, its prompt gets the heading and, when present is not empty, who is in frame.



## OpenAPI

````yaml https://lavendly.ai/openapi.json put /v1/workflows/{id}/scene-plan
openapi: 3.1.0
info:
  title: Lavendly API
  version: 1.1.0
  description: >-
    The Lavendly v1 API: build a video from shots, price it, generate the
    scenes, render the film, and publish it. Authenticate with a Bearer API key
    (lv_...) from Settings > API. Rate limits are per account per minute: 20
    writes, 60 render polls, 120 other reads; a 429 carries Retry-After and
    retry_after_ms. Errors are { error: { code, message } }; 5xx adds a ref. The
    same API is an MCP server at https://mcp.lavendly.ai/mcp and in the
    @lavendly/mcp npm package.
  contact:
    name: Lavendly
    email: hello@lavendly.ai
servers:
  - url: https://lavendly.ai/api
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Create to publish
    description: The main loop, in order.
  - name: Workflows
  - name: Edit
  - name: Audio
  - name: Assets
  - name: Renders
  - name: Account
  - name: Single clips
paths:
  /v1/workflows/{id}/scene-plan:
    parameters:
      - name: id
        in: path
        required: true
        description: Workflow id
        schema:
          type: string
    put:
      tags:
        - Workflows
      summary: Save the scene plan
      description: >-
        An entry replaces that scene's plan, null removes it, other scenes are
        kept. No base version needed. When a planned scene is generated, its
        prompt gets the heading and, when present is not empty, who is in frame.
      operationId: setScenePlan
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - scenes
              properties:
                scenes:
                  type: object
                  maxProperties: 200
                  additionalProperties:
                    type:
                      - object
                      - 'null'
                    additionalProperties: false
                    properties:
                      heading:
                        type: string
                        maxLength: 80
                        description: Place and time, e.g. cafe, afternoon
                      present:
                        type: array
                        maxItems: 8
                        items:
                          type: string
                          maxLength: 60
                        description: Who or what is in frame
                      hands_off:
                        type: string
                        maxLength: 200
                        description: What the shot hands to the next
      responses:
        '200':
          description: Scene plan
          content:
            application/json:
              schema:
                type: object
                properties:
                  workflow_id:
                    type: string
                  version:
                    type: integer
                  scenes:
                    type: object
                    additionalProperties:
                      type:
                        - object
                        - 'null'
                      additionalProperties: false
                      properties:
                        heading:
                          type: string
                          maxLength: 80
                          description: Place and time, e.g. cafe, afternoon
                        present:
                          type: array
                          maxItems: 8
                          items:
                            type: string
                            maxLength: 60
                          description: Who or what is in frame
                        hands_off:
                          type: string
                          maxLength: 200
                          description: What the shot hands to the next
        '400':
          $ref: '#/components/responses/E400'
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '404':
          $ref: '#/components/responses/E404'
components:
  responses:
    E400:
      description: Bad request (invalid_args, invalid_edits, invalid_split, video_too_long)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_args
              message: ...
    E401:
      description: Missing or revoked key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unauthenticated
              message: ...
    E403:
      description: forbidden, unverified, viewer_read_only
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: viewer_read_only
              message: ...
    E404:
      description: >-
        workflow_not_found, node_not_found, job_not_found, channel_not_found,
        track_not_found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: workflow_not_found
              message: ...
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            ref:
              type: string
              description: '5xx only: quote to support'
            retry_after_ms:
              type: integer
              description: 429 rate_limited only
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key from Settings > API, e.g. lv_...

````

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