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

# Generate ranged timelapse clip

> Generate a timelapse where each device facet contributes footage only during its own time ranges.



## OpenAPI

````yaml https://api2.rhombussystems.com/api/openapi/public.json post /api/video/generateRangedTimelapseClip
openapi: 3.0.1
info:
  contact:
    email: developer@rhombussystems.com
  description: >-
    This API is for use by Rhombus customers and partners.


    ## Authentication


    All requests require two headers:

    - `x-auth-scheme` — The authentication scheme identifier. Use `api-token`
    for standard API key auth, or `partner-api-token` for partner API auth.

    - `x-auth-apikey` — Your Rhombus API key.


    Example:

    ```

    POST /api/camera/getMinimalCameraStateList

    x-auth-scheme: api-token

    x-auth-apikey: YOUR_API_KEY

    Content-Type: application/json

    ```
  title: Rhombus API
  version: '1.0'
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/video/generateRangedTimelapseClip:
    post:
      tags:
        - Video Webservice
      summary: Generate ranged timelapse clip
      description: >-
        Generate a timelapse where each device facet contributes footage only
        during its own time ranges.
      operationId: generateRangedTimelapseClip
      parameters:
        - description: >-
            Authentication scheme identifier. Use `api-token` for standard API
            key authentication, `partner-api-token` for partner API key
            authentication. Must be paired with the `x-auth-apikey` header
            containing your API key.
          example: api-token
          in: header
          name: x-auth-scheme
          required: true
          schema:
            type: string
            default: api-token
            enum:
              - api-token
              - api
              - partner-api-token
              - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Video_GenerateRangedTimelapseClipWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Video_GenerateRangedTimelapseClipWSResponse
          description: OK
components:
  schemas:
    Video_GenerateRangedTimelapseClipWSRequest:
      type: object
      description: >-
        Request for generating a timelapse where each facet contributes footage
        only during its own time ranges.
      properties:
        description:
          type: string
          description: Description for the timelapse
          nullable: true
        drawCameraDetails:
          type: boolean
          description: Whether to draw camera details on the video
          example: true
          nullable: true
        drawTimestamp:
          type: boolean
          description: Whether to draw timestamps on the video
          example: true
          nullable: true
        sources:
          type: array
          description: >-
            One entry per device facet. Each carries its own list of time
            ranges.
          items:
            $ref: '#/components/schemas/Video_RangedTimelapseSource'
          nullable: true
        title:
          type: string
          description: Title for the timelapse
          example: Subject Tour 2026-04-21
          nullable: true
        videoDuration:
          type: integer
          format: int32
          description: Duration in seconds for the output video
          example: 60
          nullable: true
      required:
        - sources
        - videoDuration
    Video_GenerateRangedTimelapseClipWSResponse:
      type: object
      description: Response from generating a ranged timelapse clip.
      properties:
        clipUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        error:
          type: boolean
          nullable: true
        errorMsg:
          type: string
          nullable: true
        warningMsg:
          type: string
          nullable: true
    Video_RangedTimelapseSource:
      type: object
      description: >-
        A single device-facet input to a ranged timelapse, with one or more time
        ranges during which this facet should contribute footage.
      properties:
        deviceUuid:
          type: string
          format: DeviceFacetUuid
          description: RUUID with optional appended facet information
          example: AAAAAAAAAAAAAAAAAAAAAA.v0
          nullable: true
        ranges:
          type: array
          description: >-
            List of time ranges (milliseconds) during which this facet should
            appear in the timelapse. Must be non-empty.
          items:
            $ref: '#/components/schemas/TimeInterval'
          nullable: true
      required:
        - deviceUuid
        - ranges
    TimeInterval:
      type: object
      properties:
        endMs:
          type: integer
          format: int64
          nullable: true
        startMs:
          type: integer
          format: int64
          nullable: true
  securitySchemes:
    ApiKeyAuth:
      description: >-
        Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header
        set to `api-token` (or `partner-api-token` for partner endpoints).
      in: header
      name: x-auth-apikey
      type: apiKey

````