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

# Apply many video edits

> Adds up to 200 sound effects, text overlays, zooms, blurs, highlights, and image/video overlays across clips in one video. Operations run in array order and commit as one editor revision. Use this instead of repeated single-add requests.



## OpenAPI

````yaml /openapi.json post /v1/videos/{id}/edits
openapi: 3.0.3
info:
  description: >-
    The Tella Public API allows you to programmatically access your videos and
    playlists, including transcripts, chapters, and thumbnails.


    ## Authentication


    All requests require a Bearer token in the Authorization header:

    ```

    Authorization: Bearer tella_pk_xxxxx...

    ```


    API keys can be generated in your Tella workspace settings.


    ## Rate Limiting


    The API is rate-limited to 100 requests per minute per user within a
    workspace.

    Rate limit information is returned in response headers:

    - `RateLimit-Policy`: Named quota, request limit, and window in seconds

    - `RateLimit`: Remaining quota and seconds until reset

    - `X-RateLimit-Limit`: Maximum requests per window

    - `X-RateLimit-Remaining`: Remaining requests in current window

    - `X-RateLimit-Reset`: Unix timestamp in milliseconds when the window resets


    A `429 Too Many Requests` response also includes `Retry-After` in seconds.
  title: Tella Public API
  version: 1.0.0
servers:
  - description: Production
    url: https://api.tella.com
security: []
tags:
  - description: Video operations
    name: Videos
  - description: Sections of a video
    name: Clips
  - description: Playlist operations
    name: Playlists
  - description: Sidebar groups for organizing playlists
    name: Playlist Groups
  - description: Tags for categorizing and filtering videos
    name: Tags
  - description: >-
      Viewing analytics for a video or across the workspace: plays, watch time,
      retention, geography, referrers
    name: Analytics
  - description: Personal, workspace, and default video backgrounds
    name: Backgrounds
  - description: >-
      Reusable media saved to a workspace, plus Tella's curated sound effect and
      background music catalogs — the same items the editor's media panels show
    name: Library
  - description: Webhook endpoint management
    name: Webhooks
externalDocs:
  description: API versioning and deprecation policy
  url: https://www.tella.com/docs/versioning
paths:
  /v1/videos/{id}/edits:
    post:
      tags:
        - Videos
      summary: Apply many video edits
      description: >-
        Adds up to 200 sound effects, text overlays, zooms, blurs, highlights,
        and image/video overlays across clips in one video. Operations run in
        array order and commit as one editor revision. Use this instead of
        repeated single-add requests.
      operationId: applyVideoEdits
      parameters:
        - description: Unique video identifier
          in: path
          name: id
          required: true
          schema:
            description: Unique video identifier
            example: vid_abc123def456
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplyVideoEditsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplyVideoEditsResponse'
          description: Edits applied
          headers:
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Sunset:
              $ref: '#/components/headers/Sunset'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
        '400':
          content:
            application/json:
              example:
                docsUrl: https://docs.tella.com/
                error: bad_request
                message: The request was malformed or contained invalid parameters.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: The request was malformed or contained invalid parameters.
          headers:
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Sunset:
              $ref: '#/components/headers/Sunset'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
        '401':
          content:
            application/json:
              example:
                docsUrl: https://docs.tella.com/
                error: unauthorized
                message: Authentication is required. Provide a valid API key.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Authentication is required. Provide a valid API key.
          headers:
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Sunset:
              $ref: '#/components/headers/Sunset'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
        '403':
          content:
            application/json:
              example:
                docsUrl: https://docs.tella.com/
                error: forbidden
                message: You don't have permission to access this resource.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: You don't have permission to access this resource.
          headers:
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Sunset:
              $ref: '#/components/headers/Sunset'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
        '404':
          content:
            application/json:
              example:
                docsUrl: https://docs.tella.com/
                error: not_found
                message: The requested resource was not found.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: The requested resource was not found.
          headers:
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Sunset:
              $ref: '#/components/headers/Sunset'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
        '409':
          content:
            application/json:
              example:
                docsUrl: https://docs.tella.com/
                error: conflict
                message: >-
                  The request conflicts with the resource's current state, e.g.
                  an Idempotency-Key whose first request is still in progress.
                  Retry once it settles.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            The request conflicts with the resource's current state, e.g. an
            Idempotency-Key whose first request is still in progress. Retry once
            it settles.
          headers:
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Sunset:
              $ref: '#/components/headers/Sunset'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
        '429':
          content:
            application/json:
              example:
                docsUrl: https://docs.tella.com/
                error: rate_limited
                message: You have exceeded the rate limit. Please slow down.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: You have exceeded the rate limit. Please slow down.
          headers:
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Retry-After:
              $ref: '#/components/headers/RetryAfter'
            Sunset:
              $ref: '#/components/headers/Sunset'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
        '500':
          content:
            application/json:
              example:
                docsUrl: https://docs.tella.com/
                error: server_error
                message: An unexpected error occurred
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: An unexpected error occurred
          headers:
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Sunset:
              $ref: '#/components/headers/Sunset'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
        '501':
          content:
            application/json:
              example:
                docsUrl: https://docs.tella.com/
                error: not_implemented
                message: The requested operation is not implemented.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: The requested operation is not implemented.
          headers:
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Sunset:
              $ref: '#/components/headers/Sunset'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
        '503':
          content:
            application/json:
              example:
                docsUrl: https://docs.tella.com/
                error: unavailable
                message: >-
                  A dependency was unavailable and the request was not executed.
                  Safe to resend unchanged after the Retry-After delay.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            A dependency was unavailable and the request was not executed. Safe
            to resend unchanged after the Retry-After delay.
          headers:
            Deprecation:
              $ref: '#/components/headers/Deprecation'
            RateLimit:
              $ref: '#/components/headers/RateLimit'
            RateLimit-Policy:
              $ref: '#/components/headers/RateLimitPolicy'
            Sunset:
              $ref: '#/components/headers/Sunset'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
      security:
        - BearerAuth: []
components:
  schemas:
    ApplyVideoEditsRequest:
      additionalProperties: false
      description: >-
        Add, update, and remove up to 200 sound effects, text overlays, zooms,
        blurs, highlights, image/video overlays, and layouts in one editor
        revision. Operations run in array order; the complete batch is validated
        before anything is applied. Cuts, transcript edits, clip settings, and
        auto layouts are not batchable.
      properties:
        operations:
          items:
            $ref: '#/components/schemas/VideoEditOperation'
          maxItems: 200
          minItems: 1
          type: array
      required:
        - operations
      type: object
    ApplyVideoEditsResponse:
      additionalProperties: false
      description: >-
        One result per operation, in request order: the created resource ID for
        adds, the affected resource ID for updates and removes.
      properties:
        results:
          items:
            additionalProperties: false
            properties:
              id:
                description: Created or affected resource ID
                type: string
              operationId:
                type: string
              type:
                enum:
                  - sound_effect
                  - text_overlay
                  - zoom
                  - blur
                  - highlight
                  - media_overlay
                  - layout
                type: string
            required:
              - operationId
              - type
              - id
            type: object
          type: array
        revision:
          maximum: 9007199254740991
          minimum: 0
          type: integer
      required:
        - revision
        - results
      type: object
    ErrorResponse:
      additionalProperties: false
      description: Standard error response format
      properties:
        docsUrl:
          description: Link to Tella API documentation
          example: https://docs.tella.com/
          format: uri
          type: string
        error:
          description: Machine-readable error code
          enum:
            - bad_request
            - unauthorized
            - forbidden
            - not_found
            - rate_limited
            - server_error
            - conflict
            - edit_conflict
            - not_implemented
            - unavailable
          example: not_found
          type: string
        message:
          description: Human-readable error message
          example: Resource not found
          type: string
      required:
        - error
        - message
        - docsUrl
      type: object
    VideoEditOperation:
      description: >-
        One timeline edit — an add, update, or remove. Operations may target
        different clips in the same video, and update/remove operations may
        reference a resource added earlier in the batch by that operation's
        operationId.
      discriminator:
        mapping:
          add_blur: '#/components/schemas/BatchAddBlurOperation'
          add_highlight: '#/components/schemas/BatchAddHighlightOperation'
          add_layout: '#/components/schemas/BatchAddLayoutOperation'
          add_media_overlay: '#/components/schemas/BatchAddMediaOverlayOperation'
          add_sound_effect: '#/components/schemas/BatchAddSoundEffectOperation'
          add_text_overlay: '#/components/schemas/BatchAddTextOverlayOperation'
          add_zoom: '#/components/schemas/BatchAddZoomOperation'
          remove_blur: '#/components/schemas/BatchRemoveBlurOperation'
          remove_highlight: '#/components/schemas/BatchRemoveHighlightOperation'
          remove_layout: '#/components/schemas/BatchRemoveLayoutOperation'
          remove_media_overlay: '#/components/schemas/BatchRemoveMediaOverlayOperation'
          remove_sound_effect: '#/components/schemas/BatchRemoveSoundEffectOperation'
          remove_text_overlay: '#/components/schemas/BatchRemoveTextOverlayOperation'
          remove_zoom: '#/components/schemas/BatchRemoveZoomOperation'
          update_blur: '#/components/schemas/BatchUpdateBlurOperation'
          update_highlight: '#/components/schemas/BatchUpdateHighlightOperation'
          update_layout: '#/components/schemas/BatchUpdateLayoutOperation'
          update_media_overlay: '#/components/schemas/BatchUpdateMediaOverlayOperation'
          update_sound_effect: '#/components/schemas/BatchUpdateSoundEffectOperation'
          update_text_overlay: '#/components/schemas/BatchUpdateTextOverlayOperation'
          update_zoom: '#/components/schemas/BatchUpdateZoomOperation'
        propertyName: type
      oneOf:
        - $ref: '#/components/schemas/BatchAddSoundEffectOperation'
        - $ref: '#/components/schemas/BatchAddTextOverlayOperation'
        - $ref: '#/components/schemas/BatchAddZoomOperation'
        - $ref: '#/components/schemas/BatchAddBlurOperation'
        - $ref: '#/components/schemas/BatchAddHighlightOperation'
        - $ref: '#/components/schemas/BatchAddMediaOverlayOperation'
        - $ref: '#/components/schemas/BatchUpdateZoomOperation'
        - $ref: '#/components/schemas/BatchRemoveZoomOperation'
        - $ref: '#/components/schemas/BatchUpdateBlurOperation'
        - $ref: '#/components/schemas/BatchRemoveBlurOperation'
        - $ref: '#/components/schemas/BatchUpdateHighlightOperation'
        - $ref: '#/components/schemas/BatchRemoveHighlightOperation'
        - $ref: '#/components/schemas/BatchUpdateMediaOverlayOperation'
        - $ref: '#/components/schemas/BatchRemoveMediaOverlayOperation'
        - $ref: '#/components/schemas/BatchUpdateTextOverlayOperation'
        - $ref: '#/components/schemas/BatchRemoveTextOverlayOperation'
        - $ref: '#/components/schemas/BatchUpdateSoundEffectOperation'
        - $ref: '#/components/schemas/BatchRemoveSoundEffectOperation'
        - $ref: '#/components/schemas/BatchAddLayoutOperation'
        - $ref: '#/components/schemas/BatchUpdateLayoutOperation'
        - $ref: '#/components/schemas/BatchRemoveLayoutOperation'
      type: object
    BatchAddBlurOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        dimensions:
          $ref: '#/components/schemas/MaskDimensions'
        durationMs:
          example: 2000
          exclusiveMinimum: true
          maximum: 9007199254740991
          minimum: 0
          type: integer
        intensity:
          description: >-
            Strength from 0 to 1. Blur: 0 is the standard blur and 1 blurs three
            times as heavily; the content stays fully hidden at every value
            (defaults to 0). Highlight: how dark the area outside the highlight
            goes, 0 = no dimming, 1 = black (defaults to 0.7).
          example: 0.7
          maximum: 1
          minimum: 0
          type: number
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        point:
          $ref: '#/components/schemas/MaskPoint'
        startTimeMs:
          description: Start time in ms on the clip's playback timeline (cuts applied)
          example: 1000
          maximum: 9007199254740991
          minimum: 0
          type: integer
        type:
          enum:
            - add_blur
          type: string
      required:
        - type
        - operationId
        - clipId
        - startTimeMs
        - durationMs
        - point
        - dimensions
      type: object
    BatchAddHighlightOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        dimensions:
          $ref: '#/components/schemas/MaskDimensions'
        durationMs:
          example: 2000
          exclusiveMinimum: true
          maximum: 9007199254740991
          minimum: 0
          type: integer
        intensity:
          description: >-
            Strength from 0 to 1. Blur: 0 is the standard blur and 1 blurs three
            times as heavily; the content stays fully hidden at every value
            (defaults to 0). Highlight: how dark the area outside the highlight
            goes, 0 = no dimming, 1 = black (defaults to 0.7).
          example: 0.7
          maximum: 1
          minimum: 0
          type: number
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        point:
          $ref: '#/components/schemas/MaskPoint'
        startTimeMs:
          description: Start time in ms on the clip's playback timeline (cuts applied)
          example: 1000
          maximum: 9007199254740991
          minimum: 0
          type: integer
        type:
          enum:
            - add_highlight
          type: string
      required:
        - type
        - operationId
        - clipId
        - startTimeMs
        - durationMs
        - point
        - dimensions
      type: object
    BatchAddLayoutOperation:
      additionalProperties: false
      description: >-
        Add a layout. With startTimeMs and durationMs, overlapping layouts are
        trimmed, split, or removed to make room, exactly like the single-call
        add; without them the clip's base layout is set and the result ID is
        `base`.
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        crop:
          allOf:
            - $ref: '#/components/schemas/ClipLayoutCrop'
          description: >-
            Crop the clip's screen recording for this layout only — the editor's
            crop modal on “This layout only”. Other layouts keep following the
            clip's crop; `null` makes this layout follow it again. Masks that
            start in the layout stay anchored to their content, and a custom
            layout's screen box keeps its on-canvas scale unless the same
            request writes `layout` geometry. Needs a screen recording in the
            clip. To crop the recording across the whole clip use auto-crop.
          nullable: true
        durationMs:
          description: >-
            Optional. Provide together with startTimeMs for a time-ranged
            layout. Minimum 200ms.
          maximum: 9007199254740991
          minimum: 200
          type: integer
        layout:
          allOf:
            - $ref: '#/components/schemas/ClipLayoutShape'
          description: >-
            Layout shape. May be omitted when media is provided to use the
            default full-frame B-roll layout.
        media:
          allOf:
            - $ref: '#/components/schemas/ClipMedia'
          description: >-
            Optional media content to show during this layout. Only valid on
            time-ranged layouts.
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        popOut:
          allOf:
            - $ref: '#/components/schemas/ClipPopOut'
          description: >-
            Pop the presenter out of the camera frame. Omitted or null leaves it
            off.
          nullable: true
        startTimeMs:
          description: >-
            Optional. Provide together with durationMs for a time-ranged layout.
            In ms on the clip's playback timeline (cuts applied).
          maximum: 9007199254740991
          minimum: 0
          type: integer
        transitionStyle:
          allOf:
            - $ref: '#/components/schemas/LayoutTransitionStyle'
          description: >-
            Optional. Only valid on time-ranged layouts. Defaults to the user's
            saved layout intro transition when omitted. The user's saved layout
            outro transition is applied when the following layout begins or
            resumes.
        type:
          enum:
            - add_layout
          type: string
      required:
        - type
        - operationId
        - clipId
      type: object
    BatchAddMediaOverlayOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        dimensions:
          allOf:
            - $ref: '#/components/schemas/OverlayDimensions'
        durationMs:
          example: 5000
          exclusiveMinimum: true
          maximum: 9007199254740991
          minimum: 0
          type: integer
        name:
          example: Logo
          type: string
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        point:
          allOf:
            - $ref: '#/components/schemas/OverlayPoint'
        sourceId:
          description: >-
            Source ID from `POST /v1/sources` (`kind: image` or `kind: video`).
            The overlay type follows the source's kind.
          example: su_abc123
          type: string
        startTimeMs:
          description: >-
            Start time. Milliseconds on the clip playback timeline (with cuts
            applied) — the same timeline as the cut transcript.
          example: 1000
          maximum: 9007199254740991
          minimum: 0
          type: integer
        type:
          enum:
            - add_media_overlay
          type: string
      required:
        - type
        - operationId
        - clipId
        - sourceId
        - startTimeMs
        - durationMs
      type: object
    BatchAddSoundEffectOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        durationMs:
          example: 3000
          exclusiveMinimum: true
          maximum: 9007199254740991
          minimum: 0
          type: integer
        name:
          example: Whoosh
          type: string
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        presetId:
          description: >-
            Preset ID of a curated Tella sound effect, from a `default` item in
            `GET /v1/library?scope=default`. Placing one copies the effect into
            a source owned by your workspace, so nothing needs uploading.
            Mutually exclusive with `sourceId`; exactly one is required.
          example: cha-ching
          type: string
        sourceId:
          description: >-
            Source ID for the audio, from `POST /v1/sources` (`kind: audio` with
            the audio's duration) or from a `private`/`workspace` item in `GET
            /v1/library?type=sound-effect`. When uploading, send the audio file
            as-is — MP3, WAV, M4A, … — no need to wrap it in an MP4. Mutually
            exclusive with `presetId`; exactly one is required.
          example: su_abc123
          type: string
        startTimeMs:
          description: >-
            Start time. Milliseconds on the clip playback timeline (with cuts
            applied) — the same timeline as the cut transcript.
          example: 1000
          maximum: 9007199254740991
          minimum: 0
          type: integer
        type:
          enum:
            - add_sound_effect
          type: string
        volume:
          description: Playback volume (0 = muted, 1 = original). Defaults to 1.
          example: 1
          minimum: 0
          type: number
      required:
        - type
        - operationId
        - clipId
        - startTimeMs
        - durationMs
      type: object
    BatchAddTextOverlayOperation:
      additionalProperties: false
      properties:
        background:
          allOf:
            - $ref: '#/components/schemas/TextOverlayBackground'
          description: Background behind the text. Defaults to transparent.
        backgroundShape:
          allOf:
            - $ref: '#/components/schemas/TextOverlayBackgroundShape'
          description: Defaults to none.
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        color:
          description: Defaults to white.
          example: '#FFFFFFFF'
          pattern: ^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$
          type: string
        dimensions:
          allOf:
            - $ref: '#/components/schemas/OverlayDimensions'
        durationMs:
          example: 5000
          exclusiveMinimum: true
          maximum: 9007199254740991
          minimum: 0
          type: integer
        fontFamily:
          allOf:
            - $ref: '#/components/schemas/TextOverlayFontFamily'
          description: >-
            One of Tella's catalog font families. Defaults to Inter. Anything
            outside the catalog is rejected rather than silently falling back.
        fontSize:
          description: >-
            Font size in artboard pixels. Defaults to 7.5% of the video's
            shorter side, which is the editor's default and readable at any
            canvas size.
          example: 81
          exclusiveMinimum: true
          minimum: 0
          type: number
        fontWeight:
          description: >-
            Variable-font weight axis — 100 (thin) to 900 (black), 500 by
            default. Values outside the chosen font's own axis range are clamped
            when rendered.
          example: 500
          maximum: 1000
          minimum: 1
          type: number
        fontWidth:
          description: >-
            Variable-font width axis, as a percentage — 100 is normal, 50
            ultra-condensed, 150 extra-expanded, 100 by default. Values outside
            the chosen font's own axis range are clamped when rendered.
          example: 100
          exclusiveMinimum: true
          minimum: 0
          type: number
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        outline:
          allOf:
            - $ref: '#/components/schemas/TextOverlayOutline'
          description: Defaults to no outline, or the preset's.
        point:
          allOf:
            - $ref: '#/components/schemas/OverlayPoint'
        presetId:
          description: >-
            A preset from GET /v1/text-presets — `default:<id>` for a built-in
            style or a saved preset's ID. Supplies the font, weight, width,
            color, size, alignment, background, background shape and outline
            (not the shadow); any of those fields sent alongside overrides the
            preset's value.
          example: default:label
          minLength: 1
          type: string
        shadow:
          allOf:
            - $ref: '#/components/schemas/TextOverlayShadow'
          description: Defaults to none.
        startTimeMs:
          description: >-
            Start time. Milliseconds on the clip playback timeline (with cuts
            applied) — the same timeline as the cut transcript.
          example: 1000
          maximum: 9007199254740991
          minimum: 0
          type: integer
        text:
          example: Welcome back
          minLength: 1
          type: string
        textAlign:
          allOf:
            - $ref: '#/components/schemas/TextOverlayTextAlign'
          description: Defaults to center.
        type:
          enum:
            - add_text_overlay
          type: string
      required:
        - type
        - operationId
        - clipId
        - text
        - startTimeMs
        - durationMs
      type: object
    BatchAddZoomOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        durationMs:
          example: 2000
          exclusiveMinimum: true
          maximum: 9007199254740991
          minimum: 0
          type: integer
        focusPoint:
          allOf:
            - $ref: '#/components/schemas/ZoomFocusPoint'
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        scale:
          description: >-
            Magnification factor (1 = no zoom, 3.5 = max). Required — a zoom
            without a scale cannot be rendered.
          example: 2
          maximum: 3.5
          minimum: 1
          type: number
        startTimeMs:
          description: Start time in ms on the clip's playback timeline (cuts applied)
          example: 1000
          maximum: 9007199254740991
          minimum: 0
          type: integer
        type:
          enum:
            - add_zoom
          type: string
        zoomType:
          description: 'Zoom variant: manualZoom or trackingZoom.'
          enum:
            - manualZoom
            - trackingZoom
          example: manualZoom
          type: string
      required:
        - type
        - operationId
        - clipId
        - zoomType
        - startTimeMs
        - durationMs
        - scale
      type: object
    BatchRemoveBlurOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        maskId:
          description: >-
            Blur ID, or the operationId of an add operation earlier in this
            batch.
          minLength: 1
          type: string
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        type:
          enum:
            - remove_blur
          type: string
      required:
        - type
        - operationId
        - clipId
        - maskId
      type: object
    BatchRemoveHighlightOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        maskId:
          description: >-
            Highlight ID, or the operationId of an add operation earlier in this
            batch.
          minLength: 1
          type: string
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        type:
          enum:
            - remove_highlight
          type: string
      required:
        - type
        - operationId
        - clipId
        - maskId
      type: object
    BatchRemoveLayoutOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        layoutId:
          description: >-
            Layout ID, or the operationId of an add operation earlier in this
            batch.
          minLength: 1
          type: string
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        type:
          enum:
            - remove_layout
          type: string
      required:
        - type
        - operationId
        - clipId
        - layoutId
      type: object
    BatchRemoveMediaOverlayOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        overlayId:
          description: >-
            Overlay ID, or the operationId of an add operation earlier in this
            batch.
          minLength: 1
          type: string
        type:
          enum:
            - remove_media_overlay
          type: string
      required:
        - type
        - operationId
        - clipId
        - overlayId
      type: object
    BatchRemoveSoundEffectOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        soundEffectId:
          description: >-
            Sound effect ID, or the operationId of an add operation earlier in
            this batch.
          minLength: 1
          type: string
        type:
          enum:
            - remove_sound_effect
          type: string
      required:
        - type
        - operationId
        - clipId
        - soundEffectId
      type: object
    BatchRemoveTextOverlayOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        textOverlayId:
          description: >-
            Text overlay ID, or the operationId of an add operation earlier in
            this batch.
          minLength: 1
          type: string
        type:
          enum:
            - remove_text_overlay
          type: string
      required:
        - type
        - operationId
        - clipId
        - textOverlayId
      type: object
    BatchRemoveZoomOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        type:
          enum:
            - remove_zoom
          type: string
        zoomId:
          description: >-
            Zoom ID, or the operationId of an add operation earlier in this
            batch.
          minLength: 1
          type: string
      required:
        - type
        - operationId
        - clipId
        - zoomId
      type: object
    BatchUpdateBlurOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        dimensions:
          allOf:
            - $ref: '#/components/schemas/MaskDimensions'
        durationMs:
          exclusiveMinimum: true
          maximum: 9007199254740991
          minimum: 0
          type: integer
        intensity:
          description: >-
            Strength from 0 to 1. Blur: 0 is the standard blur and 1 blurs three
            times as heavily; the content stays fully hidden at every value
            (defaults to 0). Highlight: how dark the area outside the highlight
            goes, 0 = no dimming, 1 = black (defaults to 0.7).
          example: 0.7
          maximum: 1
          minimum: 0
          type: number
        maskId:
          description: >-
            Blur ID, or the operationId of an add operation earlier in this
            batch.
          minLength: 1
          type: string
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        point:
          allOf:
            - $ref: '#/components/schemas/MaskPoint'
        startTimeMs:
          description: Start time in ms on the clip's playback timeline (cuts applied)
          maximum: 9007199254740991
          minimum: 0
          type: integer
        type:
          enum:
            - update_blur
          type: string
      required:
        - type
        - operationId
        - clipId
        - maskId
      type: object
    BatchUpdateHighlightOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        dimensions:
          allOf:
            - $ref: '#/components/schemas/MaskDimensions'
        durationMs:
          exclusiveMinimum: true
          maximum: 9007199254740991
          minimum: 0
          type: integer
        intensity:
          description: >-
            Strength from 0 to 1. Blur: 0 is the standard blur and 1 blurs three
            times as heavily; the content stays fully hidden at every value
            (defaults to 0). Highlight: how dark the area outside the highlight
            goes, 0 = no dimming, 1 = black (defaults to 0.7).
          example: 0.7
          maximum: 1
          minimum: 0
          type: number
        maskId:
          description: >-
            Highlight ID, or the operationId of an add operation earlier in this
            batch.
          minLength: 1
          type: string
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        point:
          allOf:
            - $ref: '#/components/schemas/MaskPoint'
        startTimeMs:
          description: Start time in ms on the clip's playback timeline (cuts applied)
          maximum: 9007199254740991
          minimum: 0
          type: integer
        type:
          enum:
            - update_highlight
          type: string
      required:
        - type
        - operationId
        - clipId
        - maskId
      type: object
    BatchUpdateLayoutOperation:
      additionalProperties: false
      description: >-
        Update a layout. Time-ranged layouts support the same b-roll media
        replacement and layout-shape changes as the single-call update. The base
        layout accepts `layout` only.
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        crop:
          allOf:
            - $ref: '#/components/schemas/ClipLayoutCrop'
          description: >-
            Crop the clip's screen recording for this layout only — the editor's
            crop modal on “This layout only”. Other layouts keep following the
            clip's crop; `null` makes this layout follow it again. Masks that
            start in the layout stay anchored to their content, and a custom
            layout's screen box keeps its on-canvas scale unless the same
            request writes `layout` geometry. Needs a screen recording in the
            clip. To crop the recording across the whole clip use auto-crop.
          nullable: true
        durationMs:
          maximum: 9007199254740991
          minimum: 200
          type: integer
        layout:
          allOf:
            - $ref: '#/components/schemas/ClipLayoutShape'
        layoutId:
          description: >-
            Layout ID, `base` for the clip-spanning layout, or the operationId
            of an add_layout operation earlier in this batch.
          minLength: 1
          type: string
        media:
          allOf:
            - $ref: '#/components/schemas/ClipMedia'
          description: >-
            Replace the layout's media content. Only valid on time-ranged
            layouts; rejected on the base (clip-spanning) layout.
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        popOut:
          allOf:
            - $ref: '#/components/schemas/ClipPopOut'
          description: >-
            Switch the camera pop-out on (an object merges over the current
            settings) or off (null). Omitted leaves it as it is, except that a
            cut-out layout drops it. On the base layout this and `crop` are
            accepted without `layout`.
          nullable: true
        startTimeMs:
          description: Start time in ms on the clip's playback timeline (cuts applied)
          maximum: 9007199254740991
          minimum: 0
          type: integer
        transitionStyle:
          allOf:
            - $ref: '#/components/schemas/LayoutTransitionStyle'
          description: >-
            Only valid on time-ranged layouts; rejected on the base
            (clip-spanning) layout.
        type:
          enum:
            - update_layout
          type: string
      required:
        - type
        - operationId
        - clipId
        - layoutId
      type: object
    BatchUpdateMediaOverlayOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        depth:
          allOf:
            - $ref: '#/components/schemas/OverlayDepth'
        dimensions:
          allOf:
            - $ref: '#/components/schemas/OverlayDimensions'
        durationMs:
          exclusiveMinimum: true
          maximum: 9007199254740991
          minimum: 0
          type: integer
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        overlayId:
          description: >-
            Overlay ID, or the operationId of an add operation earlier in this
            batch.
          minLength: 1
          type: string
        point:
          allOf:
            - $ref: '#/components/schemas/OverlayPoint'
        startTimeMs:
          description: >-
            Start time. Milliseconds on the clip playback timeline (with cuts
            applied) — the same timeline as the cut transcript.
          maximum: 9007199254740991
          minimum: 0
          type: integer
        transition:
          allOf:
            - $ref: '#/components/schemas/TransitionStyle'
          description: >-
            Intro/outro animation: `smooth` fades the overlay in at its start
            and out at its end, `hard_cut` pops it in and out.
        type:
          enum:
            - update_media_overlay
          type: string
      required:
        - type
        - operationId
        - clipId
        - overlayId
      type: object
    BatchUpdateSoundEffectOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        durationMs:
          exclusiveMinimum: true
          maximum: 9007199254740991
          minimum: 0
          type: integer
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        soundEffectId:
          description: >-
            Sound effect ID, or the operationId of an add operation earlier in
            this batch.
          minLength: 1
          type: string
        startTimeMs:
          description: >-
            Start time. Milliseconds on the clip playback timeline (with cuts
            applied) — the same timeline as the cut transcript.
          maximum: 9007199254740991
          minimum: 0
          type: integer
        type:
          enum:
            - update_sound_effect
          type: string
        volume:
          description: Playback volume (0 = muted, 1 = original).
          minimum: 0
          type: number
      required:
        - type
        - operationId
        - clipId
        - soundEffectId
      type: object
    BatchUpdateTextOverlayOperation:
      additionalProperties: false
      properties:
        background:
          allOf:
            - $ref: '#/components/schemas/TextOverlayBackground'
        backgroundShape:
          allOf:
            - $ref: '#/components/schemas/TextOverlayBackgroundShape'
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        color:
          description: >-
            Hex color in #RRGGBB or #RRGGBBAA form. Responses use uppercase
            #RRGGBBAA.
          example: '#FFFFFFFF'
          pattern: ^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$
          type: string
        depth:
          allOf:
            - $ref: '#/components/schemas/OverlayDepth'
        dimensions:
          allOf:
            - $ref: '#/components/schemas/OverlayDimensions'
        durationMs:
          exclusiveMinimum: true
          maximum: 9007199254740991
          minimum: 0
          type: integer
        fontFamily:
          allOf:
            - $ref: '#/components/schemas/TextOverlayFontFamily'
        fontSize:
          description: Font size in artboard pixels.
          exclusiveMinimum: true
          minimum: 0
          type: number
        fontWeight:
          maximum: 1000
          minimum: 1
          type: number
        fontWidth:
          exclusiveMinimum: true
          minimum: 0
          type: number
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        outline:
          allOf:
            - $ref: '#/components/schemas/TextOverlayOutline'
          description: Set an outline color, or null to remove the outline.
        point:
          allOf:
            - $ref: '#/components/schemas/OverlayPoint'
        presetId:
          description: >-
            Restyle the overlay with a preset from GET /v1/text-presets; its
            text, timing and placement stay. Style fields sent alongside
            override the preset's values.
          example: default:label
          minLength: 1
          type: string
        shadow:
          allOf:
            - $ref: '#/components/schemas/TextOverlayShadow'
        startTimeMs:
          description: >-
            Start time. Milliseconds on the clip playback timeline (with cuts
            applied) — the same timeline as the cut transcript.
          maximum: 9007199254740991
          minimum: 0
          type: integer
        text:
          minLength: 1
          type: string
        textAlign:
          allOf:
            - $ref: '#/components/schemas/TextOverlayTextAlign'
        textOverlayId:
          description: >-
            Text overlay ID, or the operationId of an add operation earlier in
            this batch.
          minLength: 1
          type: string
        transition:
          allOf:
            - $ref: '#/components/schemas/TransitionStyle'
          description: >-
            Intro/outro animation: `smooth` fades the text in at its start and
            out at its end, `hard_cut` pops it in and out.
        type:
          enum:
            - update_text_overlay
          type: string
      required:
        - type
        - operationId
        - clipId
        - textOverlayId
      type: object
    BatchUpdateZoomOperation:
      additionalProperties: false
      properties:
        clipId:
          description: Clip ID
          minLength: 1
          type: string
        durationMs:
          exclusiveMinimum: true
          maximum: 9007199254740991
          minimum: 0
          type: integer
        focusPoint:
          allOf:
            - $ref: '#/components/schemas/ZoomFocusPoint'
        operationId:
          description: >-
            Caller-chosen ID used to match this operation to its result. Must be
            unique within the batch.
          example: sound-1
          minLength: 1
          type: string
        scale:
          description: Magnification factor (1 = no zoom, 3.5 = max).
          example: 2
          maximum: 3.5
          minimum: 1
          type: number
        startTimeMs:
          description: Start time in ms on the clip's playback timeline (cuts applied)
          maximum: 9007199254740991
          minimum: 0
          type: integer
        type:
          enum:
            - update_zoom
          type: string
        zoomId:
          description: >-
            Zoom ID, or the operationId of an add operation earlier in this
            batch.
          minLength: 1
          type: string
        zoomType:
          description: 'Zoom variant: manualZoom or trackingZoom.'
          enum:
            - manualZoom
            - trackingZoom
          example: manualZoom
          type: string
      required:
        - type
        - operationId
        - clipId
        - zoomId
      type: object
    MaskDimensions:
      description: Size of the masked rectangle (percentages)
      properties:
        heightPct:
          example: 50
          maximum: 100
          minimum: 0
          type: number
        widthPct:
          example: 50
          maximum: 100
          minimum: 0
          type: number
      required:
        - widthPct
        - heightPct
      type: object
    MaskPoint:
      description: Top-left corner of the masked rectangle (percentages)
      properties:
        xPct:
          example: 25
          maximum: 100
          minimum: 0
          type: number
        yPct:
          example: 25
          maximum: 100
          minimum: 0
          type: number
      required:
        - xPct
        - yPct
      type: object
    ClipLayoutCrop:
      description: >-
        A crop of the clip's screen recording, as pixels of the recording
        removed from each edge. The edges must leave a visible area.
      properties:
        bottom:
          description: Pixels of the screen recording removed from its bottom edge
          minimum: 0
          type: number
        left:
          description: Pixels of the screen recording removed from its left edge
          minimum: 0
          type: number
        right:
          description: Pixels of the screen recording removed from its right edge
          minimum: 0
          type: number
        top:
          description: Pixels of the screen recording removed from its top edge
          minimum: 0
          type: number
      required:
        - top
        - right
        - bottom
        - left
      type: object
    ClipLayoutShape:
      description: >-
        Structured layout description, discriminated by `kind`. Valid named
        kinds depend on the clip's `layoutSceneType` and the video's aspect
        ratio; the server validates the kind+fields and returns a 400 if they
        don't fit. `custom` carries explicit per-slot geometry and is valid on
        any clip.
      discriminator:
        mapping:
          camera-bubble: '#/components/schemas/CameraBubbleLayout'
          camera-only: '#/components/schemas/CameraOnlyLayout'
          custom: '#/components/schemas/CustomLayout'
          cut-out: '#/components/schemas/CutOutLayout'
          fullscreen: '#/components/schemas/FullscreenLayout'
          middle: '#/components/schemas/MiddleLayout'
          screen-only: '#/components/schemas/ScreenOnlyLayout'
          side-by-side: '#/components/schemas/SideBySideLayout'
          tv-presenter: '#/components/schemas/TVPresenterLayout'
        propertyName: kind
      oneOf:
        - $ref: '#/components/schemas/FullscreenLayout'
        - $ref: '#/components/schemas/MiddleLayout'
        - $ref: '#/components/schemas/SideBySideLayout'
        - $ref: '#/components/schemas/TVPresenterLayout'
        - $ref: '#/components/schemas/CutOutLayout'
        - $ref: '#/components/schemas/CameraBubbleLayout'
        - $ref: '#/components/schemas/CameraOnlyLayout'
        - $ref: '#/components/schemas/ScreenOnlyLayout'
        - $ref: '#/components/schemas/CustomLayout'
      type: object
    ClipMedia:
      description: >-
        Media shown during a layout. `image` or `video`, each referencing a
        `sourceId` from `POST /v1/sources`.
      discriminator:
        mapping:
          image: '#/components/schemas/ClipMediaImage'
          video: '#/components/schemas/ClipMediaVideo'
        propertyName: type
      oneOf:
        - $ref: '#/components/schemas/ClipMediaImage'
        - $ref: '#/components/schemas/ClipMediaVideo'
      type: object
    ClipPopOut:
      additionalProperties: false
      description: >-
        Pop-out for the camera: the presenter is cut out of the camera feed and
        rises out of a frame that keeps the camera's shape (circle, square or
        squircle) and sits behind their head. Needs a camera recording on the
        clip and a layout that frames it (any camera layout except cut-out and
        screen-only). Every field is optional; a write merges over the layout's
        current settings, and a fresh pop-out takes the defaults for unset
        fields. Responses report every field.
      properties:
        amount:
          description: >-
            How far the frame shrinks below the presenter, as a fraction of the
            camera slot (0–0.5). Defaults to 0.22.
          maximum: 0.5
          minimum: 0
          type: number
        background:
          description: >-
            What fills the frame behind the presenter: `original` keeps the
            camera feed, `color` paints `color`. Defaults to `original`.
          enum:
            - original
            - color
          type: string
        color:
          description: >-
            Frame fill when `background` is `color`, as #RRGGBB or #RRGGBBAA.
            Defaults to #6366F1.
          pattern: ^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$
          type: string
        outlineColor:
          description: 'Outline colour as #RRGGBB or #RRGGBBAA. Defaults to #FFFFFF.'
          pattern: ^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$
          type: string
        outlineWidth:
          description: >-
            Outline around the frame as a fraction of its width (0–0.05); 0
            draws none. Defaults to 0.
          maximum: 0.05
          minimum: 0
          type: number
      type: object
    LayoutTransitionStyle:
      description: >-
        How the editor transitions into this layout from the previous one.
        `spring` is the default smooth motion; `hardCut` is an instant cut.
      enum:
        - spring
        - hardCut
      title: LayoutTransitionStyle
      type: string
    OverlayDimensions:
      description: >-
        Overlay size in artboard pixels. Absolute (not a percentage) so the
        overlay shape never distorts when the artboard dimensions change. Both
        sides must be greater than 0 — the renderer lays the overlay out into
        this box, so a zero or negative side has no valid meaning.
      properties:
        height:
          example: 540
          exclusiveMinimum: true
          minimum: 0
          type: number
        width:
          example: 960
          exclusiveMinimum: true
          minimum: 0
          type: number
      required:
        - width
        - height
      type: object
    OverlayPoint:
      description: >-
        Top-left corner of the overlay, as a percentage of the video canvas
        (0-100). Relative so the anchor survives video aspect ratio changes.
      properties:
        xPct:
          example: 30
          type: number
        yPct:
          example: 30
          type: number
      required:
        - xPct
        - yPct
      type: object
    TextOverlayBackground:
      description: >-
        Background behind a text overlay, in the same object shape as a clip
        background.
      properties:
        color:
          description: >-
            Hex color string. Required when type = 'solid'. Transparent
            backgrounds use #00000000.
          example: '#5E51F8FF'
          pattern: ^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$
          type: string
        type:
          description: >-
            Background variant. Text overlays take a solid background; the other
            `ClipBackground` variants are not supported behind text.
          enum:
            - solid
          example: solid
          type: string
      required:
        - type
        - color
      type: object
    TextOverlayBackgroundShape:
      description: Shape of the solid background behind the text.
      enum:
        - none
        - regular
        - squircle
      example: squircle
      type: string
    TextOverlayFontFamily:
      description: >-
        One of Tella's catalog font families — the same list the editor's font
        picker offers.
      enum:
        - Inter
        - Roboto Mono
        - Archivo
        - Barlow
        - Caveat
        - DM Sans
        - Figtree
        - Lora
        - Merriweather
        - Montserrat
        - Nunito Sans
        - Open Sans
        - Oswald
        - Playfair Display
        - Poppins
        - Raleway
        - Roboto
        - Roboto Flex
        - Source Sans 3
        - Space Grotesk
      example: Inter
      type: string
    TextOverlayOutline:
      description: >-
        Color of the outline (stroke) drawn around the letters, or null for no
        outline.
      example: '#000000FF'
      nullable: true
      pattern: ^#(?:[0-9A-Fa-f]{6}|[0-9A-Fa-f]{8})$
      type: string
    TextOverlayShadow:
      description: >-
        Drop shadow, matching the editor's Shadow menu. It falls from the
        background box when the text has one, else from the letters.
      enum:
        - none
        - subtle
        - deep
      example: subtle
      type: string
    TextOverlayTextAlign:
      description: Horizontal alignment of the text inside its overlay box.
      enum:
        - left
        - center
        - right
      example: center
      type: string
    ZoomFocusPoint:
      description: >-
        Point on the zoomed footage to zoom into, expressed as percentages of
        its dimensions. Required for `manualZoom`; ignored for `trackingZoom`.
      properties:
        xPct:
          description: Horizontal position on the screen frame (0-100). 0 = left edge.
          example: 50
          maximum: 100
          minimum: 0
          type: number
        yPct:
          description: Vertical position on the screen frame (0-100). 0 = top edge.
          example: 50
          maximum: 100
          minimum: 0
          type: number
      required:
        - xPct
        - yPct
      type: object
    OverlayDepth:
      description: >-
        Where the overlay sits relative to the presenter on a clip with a camera
        layout: `front` paints over everything, `behind_presenter` tucks it
        behind the cut-out presenter but above the clip background and screen.
        New overlays start on `front`. Without a camera in the layout the
        overlay paints in front either way.
      enum:
        - front
        - behind_presenter
      example: behind_presenter
      type: string
    TransitionStyle:
      description: >-
        How one thing gives way to the next: `smooth` eases across the change,
        `hard_cut` swaps instantly.
      enum:
        - smooth
        - hard_cut
      example: smooth
      type: string
    CameraBubbleLayout:
      additionalProperties: false
      description: >-
        Floating camera bubble over the screen recording. Combi (all ratios).
        Position is 9-way. Set `style: full` to put the screen fullscreen behind
        the bubble.
      properties:
        kind:
          enum:
            - camera-bubble
          type: string
        position:
          enum:
            - left
            - right
            - top
            - bottom
            - top-left
            - top-right
            - bottom-left
            - bottom-right
            - middle
          type: string
        screenFit:
          description: 'Only honoured when `style: "full"`. Defaults to cover.'
          enum:
            - cover
            - letterbox
          type: string
        shape:
          enum:
            - circle
            - square
            - landscape
            - portrait
          type: string
        size:
          enum:
            - S
            - M
            - L
          type: string
        style:
          description: >-
            `regular` (default) keeps the screen layered behind the bubble;
            `full` puts the screen fullscreen behind the bubble (and honours
            `screenFit`).
          enum:
            - regular
            - full
          type: string
      required:
        - kind
        - position
        - shape
        - size
      title: Camera Bubble
      type: object
    CameraOnlyLayout:
      additionalProperties: false
      description: >-
        Camera fills the frame or sits centered; the screen is hidden. Combi
        (all ratios).
      properties:
        kind:
          enum:
            - camera-only
          type: string
        punchIn:
          description: 'Only honoured when `style: "fullscreen"`. Defaults to false.'
          type: boolean
        shape:
          description: >-
            Required when `style: "middle"`, rejected otherwise. Allowed shapes
            vary by ratio (no `portrait` in portrait clips, no `square` in
            square clips).
          enum:
            - circle
            - square
            - landscape
            - portrait
          type: string
        style:
          description: >-
            `fullscreen` fills the frame with the camera (optional `punchIn`);
            `middle` centers a shaped camera (requires `shape`).
          enum:
            - fullscreen
            - middle
          type: string
      required:
        - kind
        - style
      title: Camera Only
      type: object
    CustomLayout:
      additionalProperties: false
      description: >-
        Explicit geometry per slot in artboard pixels (the video's
        `dimensions`), like a layout arranged by hand in the editor. Valid on
        any scene type. Read the clip's layouts first: a section that is already
        custom merges the fields you pass over its current geometry; any other
        layout needs full `subject` geometry. Custom layouts can't carry `media`
        and aren't accepted in batch edits.
      properties:
        kind:
          enum:
            - custom
          type: string
        presentation:
          allOf:
            - $ref: '#/components/schemas/CustomLayoutSlot'
          description: >-
            The camera on combi clips. When omitted on a clip that has a camera
            and no custom geometry yet, the camera is kept but hidden.
        subject:
          allOf:
            - $ref: '#/components/schemas/CustomLayoutSlot'
          description: >-
            The main layer: the screen recording on combi and basic-subject
            clips, the camera on camera-subject clips. A screen keeps its
            recording's aspect ratio: `dimensions` are fitted to it around the
            same centre.
      required:
        - kind
      title: Custom
      type: object
    CutOutLayout:
      additionalProperties: false
      description: >-
        The presenter is cut out of the camera feed (person matting). On combi
        clips they are blended over the screen recording; on camera-subject
        clips they cover the frame over the story background.
      properties:
        kind:
          enum:
            - cut-out
          type: string
        position:
          description: >-
            Combi clips only (required there): which side the cut-out presenter
            sits on in landscape. Portrait and square stories stack the two
            instead — `right` puts the presenter at the top, `left` at the
            bottom. Ignored on camera-subject clips.
          enum:
            - left
            - right
          type: string
      required:
        - kind
      title: Cut Out
      type: object
    FullscreenLayout:
      additionalProperties: false
      description: >-
        Single-layer fullscreen. Camera-subject clips take an optional `style`
        (regular/stretch); basic-subject clips take an optional `screenFit`.
      properties:
        kind:
          enum:
            - fullscreen
          type: string
        screenFit:
          description: >-
            Only honoured for basic-subject clips (Tella renders the screen
            fullscreen). Defaults to cover.
          enum:
            - cover
            - letterbox
          type: string
        style:
          description: >-
            Only honoured for camera-subject clips: `regular` (default) is plain
            fullscreen, `stretch` stretches the subject. Ignored on
            basic-subject clips.
          enum:
            - regular
            - stretch
          type: string
      required:
        - kind
      title: Fullscreen
      type: object
    MiddleLayout:
      additionalProperties: false
      description: >-
        Centered subject. Camera-subject clips take a `shape`; basic-subject
        clips take no fields.
      properties:
        kind:
          enum:
            - middle
          type: string
        shape:
          description: >-
            Required for camera-subject clips. Rejected on basic-subject clips,
            which have no camera.
          enum:
            - circle
            - square
            - landscape
            - portrait
          type: string
      required:
        - kind
      title: Middle
      type: object
    ScreenOnlyLayout:
      additionalProperties: false
      description: >-
        Screen fills the frame or sits centered; the camera is hidden. Combi
        (all ratios).
      properties:
        kind:
          enum:
            - screen-only
          type: string
        screenFit:
          description: 'Only honoured when `style: "fullscreen"`. Defaults to cover.'
          enum:
            - cover
            - letterbox
          type: string
        style:
          description: >-
            `fullscreen` fills the frame with the screen (optional `screenFit`);
            `middle` centers the screen.
          enum:
            - fullscreen
            - middle
          type: string
      required:
        - kind
        - style
      title: Screen Only
      type: object
    SideBySideLayout:
      additionalProperties: false
      description: >-
        Camera and screen side by side. Combi (all ratios). Landscape splits
        horizontally (`position: left/right`, style regular/even/overlap);
        portrait and square split vertically 50/50 (`position: top/bottom` for
        the camera half, `style: even` only). Note that `even` crops the screen
        recording to fill its half; see `style`.
      properties:
        kind:
          enum:
            - side-by-side
          type: string
        position:
          description: >-
            Where the camera sits. `left`/`right` on landscape clips;
            `top`/`bottom` on portrait and square clips.
          enum:
            - left
            - right
            - top
            - bottom
          type: string
        size:
          description: 'Camera size. Required when `style: "overlap"`; ignored otherwise.'
          enum:
            - S
            - M
            - L
          type: string
        style:
          description: >-
            `regular` weights camera and screen unevenly, `even` splits 50/50,
            `overlap` lets the camera bleed over the screen edge (and requires
            `size`). Portrait and square clips support `even` only. `regular`
            and `overlap` scale the whole screen recording to fit its panel;
            `even` fills each half edge to edge and center-crops the screen to
            that half-canvas box (roughly half its width on a landscape canvas),
            with no `screenFit`/letterbox option. Avoid `even` for terminals,
            code, spreadsheets or other dense screen content unless you check
            the result with a clip frame.
          enum:
            - regular
            - even
            - overlap
          type: string
      required:
        - kind
        - position
        - style
      title: Side by Side
      type: object
    TVPresenterLayout:
      additionalProperties: false
      description: >-
        Today-show layout: presenter on one side, screen on the other. Combi
        (landscape) only.
      properties:
        kind:
          enum:
            - tv-presenter
          type: string
        position:
          enum:
            - left
            - right
          type: string
        style:
          description: >-
            `regular` is the standard today-show framing, `full` puts the screen
            fullscreen behind the presenter, `overlap` tightens the
            camera-screen overlap.
          enum:
            - regular
            - full
            - overlap
          type: string
      required:
        - kind
        - position
        - style
      title: TV Presenter
      type: object
    ClipMediaImage:
      additionalProperties: false
      description: >-
        Image media. The image fills the section's layer per the chosen
        layoutName.
      properties:
        slot:
          description: >-
            Which slot the media fills: `screen` (the subject/main frame, the
            default) or `camera` (the bubble/presentation slot — a media bubble
            over the recording behind it). A `camera` slot requires a layout
            that renders the camera (e.g. camera-bubble, side-by-side,
            tv-presenter).
          enum:
            - screen
            - camera
          type: string
        sourceId:
          description: 'Source ID from `POST /v1/sources` (`kind: image`).'
          minLength: 1
          type: string
        type:
          enum:
            - image
          type: string
      required:
        - type
        - sourceId
      title: ClipMediaImage
      type: object
    ClipMediaVideo:
      additionalProperties: false
      description: Video media.
      properties:
        slot:
          description: >-
            Which slot the media fills: `screen` (the subject/main frame, the
            default) or `camera` (the bubble/presentation slot — a media bubble
            over the recording behind it). A `camera` slot requires a layout
            that renders the camera (e.g. camera-bubble, side-by-side,
            tv-presenter).
          enum:
            - screen
            - camera
          type: string
        sourceId:
          description: Source ID from `POST /v1/sources`.
          minLength: 1
          type: string
        type:
          enum:
            - video
          type: string
      required:
        - type
        - sourceId
      title: ClipMediaVideo
      type: object
    CustomLayoutSlot:
      additionalProperties: false
      description: >-
        Geometry of one slot. `point` and `dimensions` are required unless the
        layout being written is already custom, in which case omitted fields
        keep their current values. Responses report every field.
      properties:
        corners:
          description: Corner rounding of a rectangular frame. Defaults to `regular`.
          enum:
            - none
            - regular
            - squircle
          type: string
        dimensions:
          allOf:
            - $ref: '#/components/schemas/CustomLayoutDimensions'
        hidden:
          description: Leave the layer out of the picture. Defaults to false.
          type: boolean
        order:
          description: >-
            Stacking order; higher draws on top. Defaults to 0 for the subject
            and 1 for the presentation.
          maximum: 9007199254740991
          minimum: -9007199254740991
          type: integer
        point:
          allOf:
            - $ref: '#/components/schemas/CustomLayoutPoint'
        shape:
          description: >-
            Frame the layer is drawn in: `none` (default) is the plain rectangle
            given by `dimensions`; `circle`, `square` and `portrait` are the
            camera-bubble frames; `cutout` cuts the presenter out of the camera
            feed; `blob` is a wobbling bubble that grows toward the presenter's
            hands, and `blob-outline` is the same with a white line around it.
          enum:
            - none
            - circle
            - square
            - portrait
            - cutout
            - blob
            - blob-outline
          type: string
      type: object
    CustomLayoutDimensions:
      additionalProperties: false
      description: Slot size in artboard pixels.
      properties:
        height:
          exclusiveMinimum: true
          minimum: 0
          type: number
        width:
          exclusiveMinimum: true
          minimum: 0
          type: number
      required:
        - width
        - height
      type: object
    CustomLayoutPoint:
      additionalProperties: false
      description: Top-left corner of the slot in artboard pixels.
      properties:
        x:
          type: number
        'y':
          type: number
      required:
        - x
        - 'y'
      type: object
  headers:
    Deprecation:
      description: Indicates that an API operation is deprecated, following RFC 9745
      example: '@1767225600'
      schema:
        type: string
    RateLimit:
      description: >-
        Current quota with remaining requests (`r`) and seconds until reset
        (`t`)
      example: '"public-api";r=95;t=42'
      schema:
        type: string
    RateLimitPolicy:
      description: >-
        Named quota policy with the request limit (`q`) and window in seconds
        (`w`)
      example: '"public-api";q=100;w=60'
      schema:
        type: string
    Sunset:
      description: >-
        Indicates when a deprecated API operation will become unavailable,
        following RFC 8594
      example: Tue, 30 Jun 2026 23:59:59 GMT
      schema:
        type: string
    XRateLimitLimit:
      description: Maximum requests allowed in the current window
      example: 100
      schema:
        type: integer
    XRateLimitRemaining:
      description: Requests remaining in the current window
      example: 95
      schema:
        type: integer
    XRateLimitReset:
      description: Unix timestamp in milliseconds when the window resets
      example: 1704067200000
      schema:
        format: int64
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying a rate-limited request
      example: 45
      schema:
        minimum: 1
        type: integer
  securitySchemes:
    BearerAuth:
      description: API key obtained from your Tella account settings
      scheme: bearer
      type: http

````

## Related topics

- [Batch edits](/docs/mcp-tools/batch-edits.md)
- [Edit faster with low-res mode](/docs/help/editing/low-res-mode.md)
- [Apply a subtitle preset](/docs/api-reference/videos/apply-a-subtitle-preset.md)
- [Edit a video](/docs/help/editing/edit-a-video.md)
- [Video tutorials](/docs/help/introduction/tutorials.md)


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