How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rhombus Systems Video Webservice API

The Video Webservice API from Rhombus Systems — 21 operation(s) for video webservice.

Rhombus Systems Video Webservice API is one of 65 APIs that Rhombus Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Video Webservice. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 21 operations across 21 paths, and defines 63 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api2.rhombussystems.com.

21 operations 21 paths 63 schemas 21 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api2.rhombussystems.com/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Rhombus Systems Video Webservice API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-auth-apikey (ApiKeyAuth). By default, every request must be authenticated.

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

Paths & Operations 21

Across 21 paths, the API surfaces 21 operations — 21 POST. Each is listed below with its method, path, parameters, and response codes.

Video Webservice 21
POST
/api/video/cancelSplicedeprecated
Cancel splice
cancelSplice 1 param body → 200
POST
/api/video/cancelSpliceV2
Cancel splice V2
cancelSpliceV2 1 param body → 200
POST
/api/video/createSharedTimelapseGroup
Create shared timelapse group
createSharedTimelapseGroup 1 param body → 200
POST
/api/video/deleteSharedTimelapseGroup
Delete shared timelapse group
deleteSharedTimelapseGroup 1 param body → 200
POST
/api/video/deleteTimelapseClips
Delete timelapse clips
deleteTimelapseClips 1 param body → 200
POST
/api/video/generateRangedTimelapseClip
Generate ranged timelapse clip
generateRangedTimelapseClip 1 param body → 200
POST
/api/video/generateTimelapseClip
Generate timelapse clip
generateTimelapseClip 1 param body → 200
POST
/api/video/getExactFrameData
Get exact frame data
getExactFrameData 1 param body → 200
POST
/api/video/getExactFrameUri
Get exact frame URI
getExactFrameUri 1 param body → 200
POST
/api/video/getMaxSpliceDuration
Get max splice duration
getMaxSpliceDuration 1 param body → 200
POST
/api/video/getSharedTimelapseGroups
Get shared timelapse groups
getSharedTimelapseGroups 1 param body → 200
POST
/api/video/getSplicedClipsInProgress
Get spliced clips in progress
getSplicedClipsInProgress 1 param body → 200
POST
/api/video/getTimelapseClips
Get timelapse clips
getTimelapseClips 1 param body → 200
POST
/api/video/getTimelapseMetadata
Get timelapse metadata
getTimelapseMetadata 1 param body → 200
POST
/api/video/retrySplice
Retry splice
retrySplice 1 param body → 200
POST
/api/video/shareTimelapseClipsdeprecated
Share timelapse clips
shareTimelapseClips 1 param body → 200
POST
/api/video/splicedeprecated
Splice
splice 1 param body → 200
POST
/api/video/spliceFrame
Splice frame
spliceFrame 1 param body → 200
POST
/api/video/spliceV2deprecated
Splice V2
spliceV2 1 param body → 200
POST
/api/video/spliceV3
Splice V3
spliceV3 1 param body → 200
POST
/api/video/updateSharedTimelapseGroup
Update shared timelapse group
updateSharedTimelapseGroup 1 param body → 200

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are SplicedClipType (37 properties), TimelapseClipType (19 properties), Video_SpliceV3WSRequest (14 properties), Video_GenerateTimelapseClipWSRequest (11 properties). Each schema is shown below with its type and property counts.

Video_GenerateRangedTimelapseClipWSRequest
object
Request for generating a timelapse where each facet contributes footage only during its own time ranges.
6 properties 2 required
SplicedClipType
object
List of spliced clips currently in progress
37 properties
Video_CancelSpliceWSRequest
object
Request object for canceling a spliced clip (deprecated).
2 properties
Video_CancelSpliceWSResponse
object
Response object for canceling a spliced clip (deprecated).
3 properties
Video_GetSharedTimelapseGroupsWSRequest
object
Request object for getting all shared timelapse groups for the organization.
Video_GetExactFrameUriWSRequest
object
Request object for generating URL to get an exact frame with optional crop from a camera.
8 properties 2 required
Video_RetrySpliceWSRequest
object
Request object for retrying a spliced clip.
1 property
Video_GetTimelapseMetadataWSResponse
object
Response object containing timelapse metadata for cameras.
4 properties
Video_SpliceFrameWSResponse
object
Response object for creating a single image from a point in time.
5 properties
Video_GetExactFrameUriWSResponse
object
Response object containing the exact frame URI.
5 properties
Video_GetExactFrameDataWSResponse
object
Response object containing the bytes of the requested frame data in base64 format
6 properties
Video_GenerateTimelapseClipWSResponse
object
Response object for generating a timelapse clip.
4 properties
Video_CancelSpliceV2WSRequest
object
Request object for canceling a spliced clip V2.
3 properties
IntegrationEnum
string
TimeInterval
object
2 properties
Video_GetSplicedClipsInProgressWSRequest
object
Request object for getting all spliced clips in progress.
Video_UpdateSharedTimelapseGroupWSResponse
object
Response object for updating a shared timelapse group.
5 properties
TimelapseSource
object
2 properties
AspectRatio
object
2 properties
Video_SpliceV2WSRequest
object
Request object for splicing video clips V2 (deprecated).
6 properties
Video_RangedTimelapseSource
object
A single device-facet input to a ranged timelapse, with one or more time ranges during which this facet should contribute footage.
2 properties 2 required
Video_CreateSharedTimelapseGroupWSRequest
object
Request object for creating a shared timelapse group.
5 properties
TimelapseClipType
object
Updated timelapse clip information
19 properties
Video_DeleteTimelapseClipsWSRequest
object
Request object for deleting timelapse clips.
1 property
SharedTimelapseClipType
object
6 properties
Video_SpliceWSResponse
object
Response object for splicing video clips (deprecated).
4 properties
Video_ShareTimelapseClipsWSResponse
object
Response object for sharing timelapse clips (deprecated).
4 properties
MetaDataLocationType
object
1 property
Video_GetTimelapseClipsWSResponse
object
Response object containing all timelapse clips for the organization.
4 properties
Video_SpliceWSRequest
object
Request object for splicing video clips (deprecated).
3 properties
Video_CreateSharedTimelapseGroupWSResponse
object
Response object for creating a shared timelapse group.
5 properties
TimelapseStatusStateEnum
string
Video_GetExactFrameDataWSRequest
object
Request object for fetching the bytes of an exact frame from a camera.
7 properties 2 required
DewarpedView
object
5 properties
Video_CancelSpliceV2WSResponse
object
Response object for canceling a spliced clip V2.
3 properties
CroppedPermyriadRect
object
4 properties
Video_ShareTimelapseClipsWSRequest
object
Request object for sharing timelapse clips (deprecated).
1 property
Video_RetrySpliceWSResponse
object
Response object for retrying a spliced clip.
3 properties
Video_DeleteSharedTimelapseGroupWSResponse
object
Response object for deleting a shared timelapse group.
3 properties
Video_GetTimelapseClipsWSRequest
object
Request object for getting all timelapse clips for the organization.
SplicedClipProgress
object
3 properties
Video_GenerateRangedTimelapseClipWSResponse
object
Response from generating a ranged timelapse clip.
4 properties
Video_GetTimelapseMetadataWSRequest
object
Request object for getting timelapse metadata for cameras.
1 property
PolicyEventPipelineEnum
string
Video_GetSharedTimelapseGroupsWSResponse
object
Response object containing all shared timelapse groups for the organization.
4 properties
Video_GetMaxSpliceDurationWSResponse
object
Response object containing the max splice duration for the organization.
4 properties
Video_GetMaxSpliceDurationWSRequest
object
Request object for getting the max splice duration an organization can set.
Video_DeleteTimelapseClipsWSResponse
object
Response object for deleting timelapse clips.
3 properties
Video_UpdateSharedTimelapseGroupWSRequest
object
Request object for updating a shared timelapse group.
9 properties
ClipVisibilityEnum
string
Use accessSettings instead
Video_SpliceV2WSResponse
object
Response object for splicing video clips V2 (deprecated).
4 properties
ClipStatusEnum
string
Video_GenerateTimelapseClipWSRequest
object
Request object for generating a timelapse clip.
11 properties
Video_SpliceFrameWSRequest
object
Request object for creating a single image from a point in time.
2 properties
Video_SpliceV3WSResponse
object
Response object for splicing video clips V3.
5 properties
Video_DeleteSharedTimelapseGroupWSRequest
object
Request object for deleting a shared timelapse group.
1 property
Video_SpliceV3WSRequest
object
Request object for splicing video clips V3 with multiple cameras and advanced options.
14 properties
Video_GetSplicedClipsInProgressWSResponse
object
Response object containing all spliced clips in progress.
4 properties
TimelapseStatus
object
2 properties
TimelapseClipFormatEnum
string
SharedTimelapseGroupWrapperType
object
List of shared timelapse groups for the organization
8 properties
AlteredView
object
Map of device facet UUIDs to altered view configurations
2 properties
ClipAccessSettings
object
Visibility setting for the clip
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rhombus-systems-video-webservice-api-openapi.yml Raw ↑

Other APIs Rhombus Systems publishes across the network.

Rhombus Console WebSocket API
Rhombus Systems Access Control Integrations Webservice API
Rhombus Systems Access Control Webservice API
Rhombus Systems Alarm Monitoring Keypad Webservice API
Rhombus Systems Alert Monitoring Webservice API
Rhombus Systems AudioGateway Webservice API
Rhombus Systems AudioPlayback Webservice API
Rhombus Systems Badge Reader Webservice API
Rhombus Systems BLE Webservice API
Rhombus Systems Button Webservice API
Rhombus Systems Camera Webservice API
Rhombus Systems ClaimKey Webservice API
Where this information came from

This is an independent, third-party profile of Rhombus Systems Video Webservice API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.