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

# Edit a finished video

> Change a `ready` (or `failed`) video and make it again, the way the dashboard's Generate step does with "Apply changes": change, remove or regenerate scenes by `id` (from `GET /v1/videos/{id}`), replace the whole script, change the narrator, or restyle the burned-in captions. Only what the edit makes stale is made again (a scene's shot, its narration, the render) and only that is charged; everything else is kept. A captions-only edit is redrawn in seconds and is free. What a template can change: scene templates (`ai_videographer`, `remotion`, `freeform_ai`) their scenes, narrator and captions; `site_demo` its scenes' narration, narrator and captions; `talking_avatar` its script and captions; `phone_mockup` its script, narrator and captions; `real_footage` its on-screen caption (and, narrated, its script and narrator). Posts, imported videos and interviews cannot be edited here: change a post's text with `PATCH /v1/videos/{id}`. Set `max_price_cents` to refuse, with 400, an edit that would cost more. The video goes back to `rendering`; poll `GET /v1/videos/{id}` until it is `ready` again. On the API & MCP plan and the Growth Marketing Manager hire the edit is charged at cost plus 20%; on Revenue Engine and Custom it is free; other plans get `403 plan_not_included`.



## OpenAPI

````yaml /openapi.json post /v1/videos/{id}/edit
openapi: 3.1.0
info:
  title: LumisReach v1 API
  version: 1.0.0
  description: >-
    Programmatic access to the LumisReach voice platform — calls, numbers,
    caller trust, and brands.
  contact:
    name: LumisReach
    email: founders@lumisreach.com
servers:
  - url: https://api.lumisreach.com/api
security:
  - bearerAuth: []
tags:
  - name: Contacts
  - name: Calls
  - name: Messages
  - name: Emails
  - name: Phone Numbers
  - name: Caller IDs
  - name: Enterprise Registration
  - name: Branded Calling
  - name: Dialer Calls
  - name: SMS
  - name: WebRTC
  - name: Reputation
  - name: Usage
  - name: Account
  - name: Billing
  - name: Documents
  - name: Lincoln AI
  - name: Optimized posts
  - name: Predictions
  - name: Quick Agent Actions
  - name: Sub-entities
  - name: Video schedules
  - name: Videos
paths:
  /v1/videos/{id}/edit:
    post:
      tags:
        - Videos
      summary: Edit a finished video
      description: >-
        Change a `ready` (or `failed`) video and make it again, the way the
        dashboard's Generate step does with "Apply changes": change, remove or
        regenerate scenes by `id` (from `GET /v1/videos/{id}`), replace the
        whole script, change the narrator, or restyle the burned-in captions.
        Only what the edit makes stale is made again (a scene's shot, its
        narration, the render) and only that is charged; everything else is
        kept. A captions-only edit is redrawn in seconds and is free. What a
        template can change: scene templates (`ai_videographer`, `remotion`,
        `freeform_ai`) their scenes, narrator and captions; `site_demo` its
        scenes' narration, narrator and captions; `talking_avatar` its script
        and captions; `phone_mockup` its script, narrator and captions;
        `real_footage` its on-screen caption (and, narrated, its script and
        narrator). Posts, imported videos and interviews cannot be edited here:
        change a post's text with `PATCH /v1/videos/{id}`. Set `max_price_cents`
        to refuse, with 400, an edit that would cost more. The video goes back
        to `rendering`; poll `GET /v1/videos/{id}` until it is `ready` again. On
        the API & MCP plan and the Growth Marketing Manager hire the edit is
        charged at cost plus 20%; on Revenue Engine and Custom it is free; other
        plans get `403 plan_not_included`.
      operationId: v1_videos_id_edit_post
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            A UUID. When present, deduplicates repeat submissions. See
            /api-reference/idempotency.
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: http://json-schema.org/draft-07/schema#
              type: object
              properties:
                scenes:
                  description: >-
                    Scene templates (`ai_videographer`, `remotion`,
                    `freeform_ai`, `site_demo`): edits by scene id. Scenes you
                    leave out keep what they have.
                  minItems: 1
                  maxItems: 30
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                        minLength: 1
                        maxLength: 64
                        description: The scene's `id`, from `GET /v1/videos/{id}`
                      remove:
                        description: Take the scene out of the video
                        type: boolean
                      regenerate:
                        description: >-
                          Make the scene's shot again from the same prompt (a
                          generated or B-roll shot)
                        type: boolean
                      voiceover:
                        description: What is said over the scene
                        type: string
                        maxLength: 1500
                      caption:
                        description: The words on screen; null removes them
                        anyOf:
                          - type: string
                            maxLength: 90
                          - type: 'null'
                      prompt:
                        description: >-
                          `freeform_ai`: the text-to-video prompt. A new prompt
                          makes the shot again.
                        type: string
                        maxLength: 1200
                      visual:
                        description: 'A fully custom motion-graphics scene: what it shows'
                        type: string
                        maxLength: 700
                      transition:
                        description: >-
                          A fully custom motion-graphics scene: how it gives way
                          to the next
                        anyOf:
                          - type: string
                            maxLength: 240
                          - type: 'null'
                    required:
                      - id
                    additionalProperties: false
                script:
                  description: >-
                    A template that speaks one script (`talking_avatar`,
                    `phone_mockup`, a narrated `real_footage`): the whole new
                    script, spoken again
                  type: string
                  minLength: 1
                  maxLength: 6000
                sections:
                  description: 'A scrolling background: one text per section, in order'
                  minItems: 1
                  maxItems: 10
                  type: array
                  items:
                    type: string
                    maxLength: 1500
                on_screen_caption:
                  description: >-
                    `real_footage`: the caption over the clip, or several
                    separated by a blank line
                  type: string
                  minLength: 1
                  maxLength: 454
                voice_id:
                  description: >-
                    A new narrator, as for `voice_id` on `POST /v1/videos`.
                    Everything spoken is said again.
                  type: string
                  minLength: 1
                  maxLength: 100
                voice_model:
                  description: 'With an ElevenLabs narrator: the speech model'
                  anyOf:
                    - type: string
                      maxLength: 100
                    - type: 'null'
                subtitle_style:
                  description: >-
                    Burned-in captions in another style, or `none` to take them
                    off. A captions-only edit is free.
                  type: string
                  enum:
                    - none
                    - classic
                    - boxed
                    - bold_words
                    - dynamic
                    - dynamic_highlight
                    - emphasis
                    - enlarge
                    - one_word
                    - comic
                    - highlight
                subtitle_emojis:
                  type: boolean
                subtitle_highlight_color:
                  description: >-
                    The accent colour of the highlighting caption styles, as
                    `#rrggbb`; null is the default
                  anyOf:
                    - type: string
                      pattern: ^#[0-9a-fA-F]{6}$
                    - type: 'null'
                max_price_cents:
                  description: >-
                    A spending cap: an edit priced above it is refused with 400
                    and nothing changes
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
              additionalProperties: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: http://json-schema.org/draft-07/schema#
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      changed:
                        type: boolean
                        description: >-
                          False when the edit matched what the video already
                          had: nothing was done
                      price_cents:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                        description: >-
                          What the edit was charged: only the work it made stale
                          is redone
                      video:
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                            pattern: >-
                              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                          title:
                            type: string
                          status:
                            type: string
                            enum:
                              - unsubmitted
                              - queued
                              - researching
                              - script_review
                              - rendering
                              - compositing
                              - ready
                              - failed
                            description: >-
                              `queued` → `researching` → `script_review`
                              (waiting for approval) → `rendering` →
                              `compositing` → `ready`, or `failed`.
                              `unsubmitted` is a draft saved in the dashboard.
                          template:
                            type: string
                            enum:
                              - ai_videographer
                              - talking_avatar
                              - remotion
                              - site_demo
                              - freeform_ai
                              - meme_hook
                              - interview
                              - phone_mockup
                              - slideshow
                              - real_footage
                              - video_edit
                          preset:
                            type:
                              - string
                              - 'null'
                          format:
                            type: string
                            enum:
                              - vertical
                              - horizontal
                          duration_seconds:
                            type:
                              - number
                              - 'null'
                          video_url:
                            anyOf:
                              - type: string
                                format: uri
                              - type: 'null'
                            description: >-
                              The finished MP4, once `ready`. A signed link that
                              needs no API key, safe to hand to other services.
                          thumbnail_url:
                            anyOf:
                              - type: string
                                format: uri
                              - type: 'null'
                          billed_cents:
                            anyOf:
                              - type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              - type: 'null'
                            description: >-
                              What the video was charged, once, when it was
                              released to render. Null until then.
                          error:
                            description: >-
                              Why it failed, or (in `script_review`) why an
                              automatic approval was held back
                            type:
                              - string
                              - 'null'
                          created_at:
                            type: string
                            format: date-time
                            pattern: >-
                              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                          updated_at:
                            type: string
                            format: date-time
                            pattern: >-
                              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                          posts:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  format: uuid
                                  pattern: >-
                                    ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                                provider:
                                  type: string
                                  enum:
                                    - tiktok
                                    - instagram
                                    - facebook
                                    - x
                                    - linkedin
                                    - youtube
                                status:
                                  type: string
                                  enum:
                                    - scheduled
                                    - pending
                                    - publishing
                                    - published
                                    - failed
                                    - canceled
                                    - deleted
                                media_type:
                                  type: string
                                  enum:
                                    - video
                                    - carousel
                                    - image
                                    - text
                                permalink:
                                  type:
                                    - string
                                    - 'null'
                                scheduled_for:
                                  anyOf:
                                    - type: string
                                      format: date-time
                                      pattern: >-
                                        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                                    - type: 'null'
                                published_at:
                                  anyOf:
                                    - type: string
                                      format: date-time
                                      pattern: >-
                                        ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                                    - type: 'null'
                                error:
                                  type:
                                    - string
                                    - 'null'
                              required:
                                - id
                                - provider
                                - status
                                - media_type
                                - permalink
                                - scheduled_for
                                - published_at
                                - error
                              additionalProperties: false
                          price_cents:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                            description: >-
                              What the video costs: the amount charged once
                              released, otherwise the quote for the script (or,
                              before it is written, the estimate).
                          price_estimated:
                            type: boolean
                            description: >-
                              True while the price is an estimate from the
                              length asked for
                          script_approved:
                            type: boolean
                          user_script:
                            type: boolean
                            description: True when you supplied the script
                          script:
                            description: The spoken words, once written
                            type:
                              - string
                              - 'null'
                          script_sections:
                            anyOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    label:
                                      type: string
                                    text:
                                      type: string
                                  required:
                                    - label
                                    - text
                                  additionalProperties: false
                              - type: 'null'
                            description: >-
                              A scrolling background's script, one part per
                              section
                          scenes:
                            anyOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                    label:
                                      type: string
                                    duration_seconds:
                                      type: number
                                    voiceover:
                                      type: string
                                    caption:
                                      type:
                                        - string
                                        - 'null'
                                    prompt:
                                      type:
                                        - string
                                        - 'null'
                                  required:
                                    - id
                                    - label
                                    - duration_seconds
                                    - voiceover
                                    - caption
                                    - prompt
                                  additionalProperties: false
                              - type: 'null'
                            description: A scene template's shot list, once planned
                          slides:
                            anyOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                    role:
                                      type: string
                                    headline:
                                      type: string
                                    body:
                                      type:
                                        - string
                                        - 'null'
                                    position:
                                      type: string
                                    prompt:
                                      type:
                                        - string
                                        - 'null'
                                    image_url:
                                      anyOf:
                                        - type: string
                                          format: uri
                                        - type: 'null'
                                  required:
                                    - id
                                    - role
                                    - headline
                                    - body
                                    - position
                                    - prompt
                                    - image_url
                                  additionalProperties: false
                              - type: 'null'
                            description: >-
                              A slideshow's slides, once planned; `image_url`
                              once rendered
                          interview:
                            anyOf:
                              - type: object
                                properties:
                                  speakers:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: string
                                        role:
                                          type: string
                                        face_name:
                                          type: string
                                      required:
                                        - id
                                        - role
                                        - face_name
                                      additionalProperties: false
                                  turns:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: string
                                        speaker_id:
                                          type: string
                                        text:
                                          type: string
                                      required:
                                        - id
                                        - speaker_id
                                        - text
                                      additionalProperties: false
                                required:
                                  - speakers
                                  - turns
                                additionalProperties: false
                              - type: 'null'
                          caption:
                            type:
                              - string
                              - 'null'
                          hashtags:
                            type: array
                            items:
                              type: string
                          post_caption:
                            description: >-
                              The caption with its hashtags, as it is posted by
                              default
                            type:
                              - string
                              - 'null'
                          music:
                            anyOf:
                              - type: object
                                properties:
                                  library:
                                    type: string
                                    enum:
                                      - lumisreach
                                      - epidemic
                                      - generated
                                      - commercial
                                    description: >-
                                      `generated`: a track an AI model made for
                                      your organization in the dashboard.
                                      `commercial`: a song from TikTok's charts,
                                      used once your organization confirmed it
                                      holds the rights in the dashboard
                                  track_id:
                                    type: string
                                  title:
                                    type: string
                                  status:
                                    type: string
                                    enum:
                                      - pending
                                      - mixing
                                      - applied
                                      - failed
                                required:
                                  - library
                                  - track_id
                                  - title
                                  - status
                                additionalProperties: false
                              - type: 'null'
                          brief:
                            description: >-
                              What the video was asked to be, when a `brief` was
                              given
                            type:
                              - string
                              - 'null'
                          language:
                            type: string
                            description: >-
                              The language it is made in, as a code (`en`, `fr`,
                              ...)
                          source_url:
                            type:
                              - string
                              - 'null'
                          target_duration_seconds:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          avatar_provider:
                            type: string
                            enum:
                              - heygen
                              - tavus
                              - elevenlabs
                          avatar_layout:
                            type: string
                            enum:
                              - center
                              - bubble_bottom_left
                              - bubble_bottom_right
                              - audio_only
                          background_mode:
                            type: string
                            enum:
                              - static
                              - scrolling
                              - footage
                              - automated_demo
                              - original
                              - image
                          subtitle_style:
                            type: string
                            enum:
                              - none
                              - classic
                              - boxed
                              - bold_words
                              - dynamic
                              - dynamic_highlight
                              - emphasis
                              - enlarge
                              - one_word
                              - comic
                              - highlight
                          subtitle_emojis:
                            type: boolean
                          video_model:
                            type:
                              - string
                              - 'null'
                          videographer:
                            anyOf:
                              - type: object
                                properties:
                                  sources:
                                    type: array
                                    items:
                                      type: string
                                      enum:
                                        - any
                                        - motion_graphics
                                        - stock
                                        - ai
                                        - talking_avatar
                                        - uploaded
                                        - image
                                        - youtube
                                        - online_image
                                  model:
                                    type: string
                                  actions:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  presenter_narrates:
                                    type: boolean
                                required:
                                  - sources
                                  - model
                                  - actions
                                  - presenter_narrates
                                additionalProperties: false
                              - type: 'null'
                            description: >-
                              An `ai_videographer` video's settings; null on
                              every other template
                          narration:
                            anyOf:
                              - type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              - type: 'null'
                            description: >-
                              How much of it a narrator speaks over, 0 to 100,
                              on the templates that have the setting
                          post_format:
                            anyOf:
                              - type: string
                                enum:
                                  - text
                                  - image
                                  - carousel
                              - type: 'null'
                            description: A `slideshow` post's format; null on a video
                          post_orientation:
                            anyOf:
                              - type: string
                                enum:
                                  - square
                                  - vertical
                                  - horizontal
                              - type: 'null'
                            description: >-
                              The shape of a post's pictures; null on a video
                              and on a text post
                          dashboard_url:
                            type: string
                            format: uri
                        required:
                          - id
                          - title
                          - status
                          - template
                          - preset
                          - format
                          - duration_seconds
                          - video_url
                          - thumbnail_url
                          - billed_cents
                          - error
                          - created_at
                          - updated_at
                          - posts
                          - price_cents
                          - price_estimated
                          - script_approved
                          - user_script
                          - script
                          - script_sections
                          - scenes
                          - slides
                          - interview
                          - caption
                          - hashtags
                          - post_caption
                          - music
                          - brief
                          - language
                          - source_url
                          - target_duration_seconds
                          - avatar_provider
                          - avatar_layout
                          - background_mode
                          - subtitle_style
                          - subtitle_emojis
                          - video_model
                          - videographer
                          - narration
                          - post_format
                          - post_orientation
                          - dashboard_url
                        additionalProperties: false
                    required:
                      - changed
                      - price_cents
                      - video
                    additionalProperties: false
                required:
                  - data
                additionalProperties: false
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          description: Conflict (incl. idempotency conflicts)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            fields:
              type: object
              additionalProperties:
                type: string
            doc_url:
              type: string
              format: uri
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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