Rhombus Systems Video Webservice API
The Video Webservice API from Rhombus Systems — 21 operation(s) for video webservice.
The Video Webservice API from Rhombus Systems — 21 operation(s) for video webservice.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/rhombus-systems-video-webservice-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
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 Video Webservice API
version: '1.0'
servers:
- description: Production Server
url: https://api2.rhombussystems.com
security:
- ApiKeyAuth: []
tags:
- name: Video Webservice
paths:
/api/video/cancelSplice:
post:
deprecated: true
description: Use /cancelSpliceV2 instead
operationId: cancelSplice
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_CancelSpliceWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_CancelSpliceWSResponse'
description: OK
summary: Cancel splice
tags:
- Video Webservice
/api/video/cancelSpliceV2:
post:
description: Cancel a spliced clip request
operationId: cancelSpliceV2
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_CancelSpliceV2WSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_CancelSpliceV2WSResponse'
description: OK
summary: Cancel splice V2
tags:
- Video Webservice
/api/video/createSharedTimelapseGroup:
post:
description: Share multiple timelapses in one link
operationId: createSharedTimelapseGroup
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_CreateSharedTimelapseGroupWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_CreateSharedTimelapseGroupWSResponse'
description: OK
summary: Create shared timelapse group
tags:
- Video Webservice
/api/video/deleteSharedTimelapseGroup:
post:
description: Delete a shared timelapse link
operationId: deleteSharedTimelapseGroup
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_DeleteSharedTimelapseGroupWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_DeleteSharedTimelapseGroupWSResponse'
description: OK
summary: Delete shared timelapse group
tags:
- Video Webservice
/api/video/deleteTimelapseClips:
post:
description: Delete a timelapse
operationId: deleteTimelapseClips
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_DeleteTimelapseClipsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_DeleteTimelapseClipsWSResponse'
description: OK
summary: Delete timelapse clips
tags:
- Video Webservice
/api/video/generateRangedTimelapseClip:
post:
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
summary: Generate ranged timelapse clip
tags:
- Video Webservice
/api/video/generateTimelapseClip:
post:
description: Generate a timelapse
operationId: generateTimelapseClip
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_GenerateTimelapseClipWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_GenerateTimelapseClipWSResponse'
description: OK
summary: Generate timelapse clip
tags:
- Video Webservice
/api/video/getExactFrameData:
post:
description: Fetches and return bytes in base64 format of an the frame at the given timestamp for a device. Use this instead of getExactFrameUri if, for whatever reason, either the URI is not useful or the client is unable to hit the media servers
operationId: getExactFrameData
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_GetExactFrameDataWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_GetExactFrameDataWSResponse'
description: OK
summary: Get exact frame data
tags:
- Video Webservice
/api/video/getExactFrameUri:
post:
description: Generate URL to get an exact frame with optional crop from a camera
operationId: getExactFrameUri
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_GetExactFrameUriWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_GetExactFrameUriWSResponse'
description: OK
summary: Get exact frame URI
tags:
- Video Webservice
/api/video/getMaxSpliceDuration:
post:
description: Get the max splice duration an organization can set
operationId: getMaxSpliceDuration
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_GetMaxSpliceDurationWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_GetMaxSpliceDurationWSResponse'
description: OK
summary: Get max splice duration
tags:
- Video Webservice
/api/video/getSharedTimelapseGroups:
post:
description: Get details of all shared timelapse links for organization
operationId: getSharedTimelapseGroups
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_GetSharedTimelapseGroupsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_GetSharedTimelapseGroupsWSResponse'
description: OK
summary: Get shared timelapse groups
tags:
- Video Webservice
/api/video/getSplicedClipsInProgress:
post:
description: Get all spliced clips in progress
operationId: getSplicedClipsInProgress
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_GetSplicedClipsInProgressWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_GetSplicedClipsInProgressWSResponse'
description: OK
summary: Get spliced clips in progress
tags:
- Video Webservice
/api/video/getTimelapseClips:
post:
description: Get all timelapse clips for organization
operationId: getTimelapseClips
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_GetTimelapseClipsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_GetTimelapseClipsWSResponse'
description: OK
summary: Get timelapse clips
tags:
- Video Webservice
/api/video/getTimelapseMetadata:
post:
description: Get information about earliest available timelapse images for cameras
operationId: getTimelapseMetadata
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_GetTimelapseMetadataWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_GetTimelapseMetadataWSResponse'
description: OK
summary: Get timelapse metadata
tags:
- Video Webservice
/api/video/retrySplice:
post:
description: Send a request to retry splicing a clip
operationId: retrySplice
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_RetrySpliceWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_RetrySpliceWSResponse'
description: OK
summary: Retry splice
tags:
- Video Webservice
/api/video/shareTimelapseClips:
post:
deprecated: true
description: Use /CreateSharedTimelapseGroup instead
operationId: shareTimelapseClips
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_ShareTimelapseClipsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_ShareTimelapseClipsWSResponse'
description: OK
summary: Share timelapse clips
tags:
- Video Webservice
/api/video/splice:
post:
deprecated: true
description: Use /spliceV3 instead
operationId: splice
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_SpliceWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_SpliceWSResponse'
description: OK
summary: Splice
tags:
- Video Webservice
/api/video/spliceFrame:
post:
description: Send a request to create a single image from a point in time
operationId: spliceFrame
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_SpliceFrameWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_SpliceFrameWSResponse'
description: OK
summary: Splice frame
tags:
- Video Webservice
/api/video/spliceV2:
post:
deprecated: true
description: Use /spliceV3 instead
operationId: spliceV2
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_SpliceV2WSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_SpliceV2WSResponse'
description: OK
summary: Splice V2
tags:
- Video Webservice
/api/video/spliceV3:
post:
description: Send a request to create an arbitrary clip for multiple cameras
operationId: spliceV3
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_SpliceV3WSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_SpliceV3WSResponse'
description: OK
summary: Splice V3
tags:
- Video Webservice
/api/video/updateSharedTimelapseGroup:
post:
description: Update title, description, or expiration on a shared timelapse link
operationId: updateSharedTimelapseGroup
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_UpdateSharedTimelapseGroupWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Video_UpdateSharedTimelapseGroupWSResponse'
description: OK
summary: Update shared timelapse group
tags:
- Video Webservice
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
- 'null'
description: Description for the timelapse
drawCameraDetails:
type:
- boolean
- 'null'
description: Whether to draw camera details on the video
example: true
drawTimestamp:
type:
- boolean
- 'null'
description: Whether to draw timestamps on the video
example: true
sources:
type:
- array
- 'null'
description: One entry per device facet. Each carries its own list of time ranges.
items:
$ref: '#/components/schemas/Video_RangedTimelapseSource'
title:
type:
- string
- 'null'
description: Title for the timelapse
example: Subject Tour 2026-04-21
videoDuration:
type:
- integer
- 'null'
format: int32
description: Duration in seconds for the output video
example: 60
required:
- sources
- videoDuration
SplicedClipType:
type: object
description: List of spliced clips currently in progress
properties:
accessSettings:
$ref: '#/components/schemas/ClipAccessSettings'
analyzeClip:
type:
- boolean
- 'null'
clipTargetLocation:
$ref: '#/components/schemas/MetaDataLocationType'
clipUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
completedSubClipCount:
type:
- integer
- 'null'
format: int32
consoleDelete:
type:
- boolean
- 'null'
deleted:
type:
- boolean
- 'null'
description:
type:
- string
- 'null'
deviceIntervalMap:
type:
- object
- 'null'
additionalProperties:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/TimeInterval'
deviceMap:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/SplicedClipProgress'
devicePresentationOrder:
type:
- array
- 'null'
items:
type:
- string
- 'null'
format: DeviceFacetUuid
description: RUUID with optional appended facet information
example: AAAAAAAAAAAAAAAAAAAAAA.v0
deviceUuid:
type:
- string
- 'null'
format: DeviceFacetUuid
description: RUUID with optional appended facet information
example: AAAAAAAAAAAAAAAAAAAAAA.v0
deviceUuidMap:
type:
- object
- 'null'
additionalProperties:
$ref: '#/components/schemas/SplicedClipProgress'
deviceUuidToAlteredViewMap:
type:
- object
- 'null'
additionalProperties:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/AlteredView'
deviceUuidToFisheyePresentationMap:
type:
- object
- 'null'
additionalProperties:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/DewarpedView'
duration:
type:
- integer
- 'null'
format: int32
expectedSubClipCount:
type:
- integer
- 'null'
format: int32
integrationUploadList:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/IntegrationEnum'
isPolicyEvent:
type:
- boolean
- 'null'
metadataBucketRegion:
type:
- string
- 'null'
orgUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
parentClipUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
pendingConsumers:
type:
- array
- 'null'
items:
type:
- string
- 'null'
uniqueItems: true
policyEventPipeline:
$ref: '#/components/schemas/PolicyEventPipelineEnum'
saveClip:
type:
- boolean
- 'null'
saveFrame:
type:
- boolean
- 'null'
segmentsUploaded:
type:
- integer
- 'null'
format: int32
sendToSharedStorage:
type:
- boolean
- 'null'
startTime:
type:
- integer
- 'null'
format: int64
status:
$ref: '#/components/schemas/ClipStatusEnum'
statusUpdatedAtMs:
type:
- integer
- 'null'
format: int64
thumbnailRelativeSecond:
type:
- number
- 'null'
format: float
timestampMs:
type:
- integer
- 'null'
format: int64
title:
type:
- string
- 'null'
totalSegments:
type:
- integer
- 'null'
format: int32
transactionUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
userUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
Video_CancelSpliceWSRequest:
type: object
description: Request object for canceling a spliced clip (deprecated).
properties:
clipUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
deviceUuid:
type:
- string
- 'null'
format: RUUID
description: base 64 (url-safe) uuid string
example: AAAAAAAAAAAAAAAAAAAAAA
Video_CancelSpliceWSResponse:
type: object
description: Response object for canceling a spliced clip (deprecated).
properties:
error:
type:
- boolean
- 'null'
errorMsg:
type:
- string
- 'null'
warningMsg:
type:
- string
- 'null'
Video_GetSharedTimelapseGroupsWSRequest:
type: object
description: Request object for getting all shared timelapse groups for the organization.
Video_GetExactFrameUriWSRequest:
type: object
description: Request object for generating URL to get an exact frame with optional crop from a camera.
properties:
cameraUuid:
type:
- string
- 'null'
format: DeviceFacetUuid
description: RUUID with optional appended facet information
example: AAAAAAAAAAAAAAAAAAAAAA.v0
downscaleFactor:
type:
- integer
- 'null'
format: int32
description: Ratio to shrink the image pixels by
minimum: 1
jpgQuality:
type:
- integer
- 'null'
format: int32
description: Adjust quality of image compression
maximum: 100
# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rhombus-systems/refs/heads/main/openapi/rhombus-systems-video-webservice-api-openapi.yml