Skip to main content
POST
/
api
/
video
/
spliceV3
Splice V3
curl --request POST \
  --url https://api2.rhombussystems.com/api/video/spliceV3 \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "accessSettings": {
    "allowedRoles": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "allowedUsers": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  },
  "alteredViewMap": {},
  "audioIncluded": true,
  "description": "Review of security incident from main entrance",
  "deviceIntervalMap": {},
  "deviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "durationSec": 60,
  "integrationUploadMap": {},
  "saveToConsole": true,
  "sendToSharedStorage": false,
  "sendToUserStorage": false,
  "startTimeMillis": 1640995200000,
  "title": "Security Incident Review"
}
'
{
  "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "clipUuidList": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

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.

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:api-token
required

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.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request object for splicing video clips V3 with multiple cameras and advanced options.

accessSettings
object

Visibility setting for the clip

alteredViewMap
object

Map of device facet UUIDs to altered view configurations

audioIncluded
boolean | null

Whether to include audio in the clip

Example:

true

clipVisibility
enum<string>

Use accessSettings instead

Available options:
PRIVATE,
ROLE_RESTRICTED,
ORG_WIDE
description
string | null

Description for the spliced clip

Example:

"Review of security incident from main entrance"

deviceIntervalMap
object

Optional map of device facet UUIDs to a list of time intervals (start/end millis) for multi-interval splicing. When provided and non-empty, the request is treated as multi-interval and the top-level startTimeMillis/durationSec are ignored. The sum of all interval durations across all devices is capped at 60 minutes, and each interval must be at least 1 second long.

deviceUuids
(string<DeviceFacetUuid> | null)[] | null

List of device facet UUIDs to splice video from

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

durationSec
integer<int32> | null

Duration in seconds for the splice

Example:

60

integrationUploadMap
object

Map of integration names to upload flags

saveToConsole
boolean | null

Whether to save the clip to console

Example:

true

sendToSharedStorage
boolean | null

Whether to send to shared storage

Example:

false

sendToUserStorage
boolean | null

Whether to send to user storage

Example:

false

startTimeMillis
integer<int64> | null

Start time in milliseconds for the splice

Example:

1640995200000

title
string | null

Title for the spliced clip

Example:

"Security Incident Review"

Response

200 - application/json

OK

Response object for splicing video clips V3.

clipUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

clipUuidList
(string<RUUID> | null)[] | null

List of UUIDs for created spliced clips

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

error
boolean | null
errorMsg
string | null
warningMsg
string | null
Last modified on May 24, 2026