Rhombus Systems Camera Webservice API
The Camera Webservice API from Rhombus Systems — 61 operation(s) for camera webservice.
The Camera Webservice API from Rhombus Systems — 61 operation(s) for camera 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-camera-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 Camera Webservice API
version: '1.0'
servers:
- description: Production Server
url: https://api2.rhombussystems.com
security:
- ApiKeyAuth: []
tags:
- name: Camera Webservice
paths:
/api/camera/calibrateFloorplanProjection:
post:
description: Generate the homography to project detections onto a floorplan.
operationId: cameraCalibrateFloorplanProjection
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/Common_devices_CalibrateFloorplanProjectionWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Common_devices_CalibrateFloorplanProjectionWSResponse'
description: OK
summary: Calibrate floorplan projection
tags:
- Camera Webservice
/api/camera/createCustomFootageSeekpoints:
post:
description: Create custom activity seekpoints for a specified camera
operationId: createCustomFootageSeekpoints
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/Camera_CreateCustomFootageSeekpointsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_CreateFootageSeekpointsWSResponse'
description: OK
summary: Create custom footage seekpoints
tags:
- Camera Webservice
/api/camera/createFootageBoundingBoxes:
post:
description: Create an activity bounding box for specified camera
operationId: createFootageBoundingBoxes
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/Camera_CreateFootageBoundingBoxesWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_CreateFootageBoundingBoxesWSResponse'
description: OK
summary: Create footage bounding boxes
tags:
- Camera Webservice
/api/camera/createProtectedSharedLiveVideoStream:
post:
description: Share a password protected live video stream for a camera
operationId: createProtectedSharedLiveVideoStream
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/Camera_CreateSharedLiveVideoStreamWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_CreateSharedLiveVideoStreamWSResponse'
description: OK
summary: Create protected shared live video stream
tags:
- Camera Webservice
/api/camera/createProtectedSharedVideoWall:
post:
description: Share a password protected video wall
operationId: createProtectedSharedVideoWall
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/Camera_CreateSharedVideoWallWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_CreateSharedVideoWallWSResponse'
description: OK
summary: Create protected shared video wall
tags:
- Camera Webservice
/api/camera/createRawHttpStream:
post:
description: Create a raw HTTP stream for a camera
operationId: createCameraRawHttpStream
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/Common_devices_rawstream_CreateRawHttpStreamWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Common_devices_rawstream_CreateRawHttpStreamWSResponse'
description: OK
summary: Create camera raw HTTP stream
tags:
- Camera Webservice
/api/camera/createSharedLiveVideoStream:
post:
description: Share an unprotected live video stream for a camera
operationId: createCameraSharedLiveVideoStream
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/Camera_CreateSharedLiveVideoStreamWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_CreateSharedLiveVideoStreamWSResponse'
description: OK
summary: Create shared live video stream
tags:
- Camera Webservice
/api/camera/createSharedVideoWall:
post:
description: Share an unprotected video wall
operationId: createSharedVideoWall
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/Camera_CreateSharedVideoWallWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_CreateSharedVideoWallWSResponse'
description: OK
summary: Create shared video wall
tags:
- Camera Webservice
/api/camera/createVideoWall:
post:
description: Create a video wall for user
operationId: createVideoWall
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/Camera_CreateVideoWallWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_CreateVideoWallWSResponse'
description: OK
summary: Create video wall
tags:
- Camera Webservice
/api/camera/delete:
post:
description: Remove a camera from organization
operationId: deleteCamera
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/Camera_DeleteCameraWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_DeleteCameraWSResponse'
description: OK
summary: Delete camera
tags:
- Camera Webservice
/api/camera/deleteCustomFootageSeekpoints:
post:
description: Delete custom seekpoints for specified cameras
operationId: deleteCustomFootageSeekpoints
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/Camera_DeleteCustomFootageSeekpointsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_DeleteCustomFootageSeekpointsWSResponse'
description: OK
summary: Delete custom footage seekpoints
tags:
- Camera Webservice
/api/camera/deleteRawHttpStream:
post:
description: Delete a raw HTTP stream for a camera
operationId: deleteCameraRawHttpStream
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/Common_devices_rawstream_DeleteRawHttpStreamWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Common_devices_rawstream_DeleteRawHttpStreamWSResponse'
description: OK
summary: Delete camera raw HTTP stream
tags:
- Camera Webservice
/api/camera/deleteSharedLiveVideoStream:
post:
description: Remove a shared live stream from camera
operationId: deleteSharedLiveVideoStream
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/Camera_DeleteSharedLiveVideoStreamWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteSharedLiveVideoStreamForDeviceResponse'
description: OK
summary: Delete shared live video stream
tags:
- Camera Webservice
/api/camera/deleteSharedVideoWall:
post:
description: Remove a shared video wall
operationId: deleteSharedVideoWall
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/Camera_DeleteSharedVideoWallWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_DeleteSharedVideoWallWSResponse'
description: OK
summary: Delete shared video wall
tags:
- Camera Webservice
/api/camera/deleteVideoWall:
post:
description: Delete a video wall
operationId: deleteVideoWall
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/Camera_DeleteVideoWallWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_DeleteVideoWallWSResponse'
description: OK
summary: Delete video wall
tags:
- Camera Webservice
/api/camera/erase:
post:
description: Wipes the SD card on a camera
operationId: eraseCamera
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/Camera_EraseCameraWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_EraseCameraWSResponse'
description: OK
summary: Erase camera
tags:
- Camera Webservice
/api/camera/findAllRawHttpStreams:
post:
description: Get a list of all cameras raw HTTP streams
operationId: findAllCameraRawHttpStreams
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/Common_devices_rawstream_FindAllRawHttpStreamsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Common_devices_rawstream_FindAllRawHttpStreamsWSResponse'
description: OK
summary: Find all camera raw HTTP streams
tags:
- Camera Webservice
/api/camera/findAllSharedLiveVideoStreams:
post:
description: Get list of all shared live streams
operationId: findAllSharedLiveVideoStreams
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/Camera_FindAllSharedLiveVideoStreamsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_FindAllSharedLiveVideoStreamsWSResponse'
description: OK
summary: Find all shared live video streams
tags:
- Camera Webservice
/api/camera/findSharedLiveVideoStreams:
post:
description: Get list of all shared live streams for camera
operationId: findCameraSharedLiveVideoStreams
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/Camera_FindSharedLiveVideoStreamsForWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_FindSharedLiveVideoStreamsWSResponse'
description: OK
summary: Find camera shared live video streams
tags:
- Camera Webservice
/api/camera/findSharedVideoWalls:
post:
description: Get list of all shares for a video wall
operationId: findSharedVideoWalls
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/Camera_FindSharedVideoWallsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_FindSharedVideoWallsWSResponse'
description: OK
summary: Find shared video walls
tags:
- Camera Webservice
/api/camera/generateBatchRegistrationInfo:
post:
description: Create camera registration information for QR code generation
operationId: generateBatchRegistrationInfo
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/Camera_GenerateBatchRegistrationInfoRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_GenerateBatchRegistrationInfoResponse'
description: OK
summary: Generate batch registration info
tags:
- Camera Webservice
/api/camera/generateWifiChangeAuthorizationToken:
post:
description: Create a change wifi request for QR code generation
operationId: generateWifiChangeAuthorizationToken
parameters:
- in: header
name: RHOMBUS_MY_IP
schema:
type:
- string
- 'null'
default: ''
- 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/Camera_GenerateWifiChangeAuthorizationTokenWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_GenerateWifiChangeAuthorizationTokenWSResponse'
description: OK
summary: Generate WiFi change authorization token
tags:
- Camera Webservice
/api/camera/getBatchRegistrationUsage:
post:
description: Get detailed usage information for a registration token
operationId: getBatchRegistrationUsage
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/Camera_GetBatchRegistrationTokenUsageRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_GetBatchRegistrationTokenUsageResponse'
description: OK
summary: Get batch registration usage
tags:
- Camera Webservice
/api/camera/getCameraAIThresholds:
post:
description: Get AI normalized confidence thresholds for a camera
operationId: getCameraAIThresholds
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/Camera_GetCameraAIThresholdsWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_GetCameraAIThresholdsWSResponse'
description: OK
summary: Get camera AI thresholds
tags:
- Camera Webservice
/api/camera/getCloudArchivedMediaInfo:
post:
description: Get information on archived video for specified camera
operationId: getCloudArchivedMediaInfo
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/Camera_GetCloudArchivedMediaInfoWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_GetCloudArchivedMediaInfoWSResponse'
description: OK
summary: Get cloud archived media info
tags:
- Camera Webservice
/api/camera/getCloudArchivingConfig:
post:
description: Get the cloud archiving scheduling config applicable to a camera
operationId: getCloudArchivingConfig
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/Camera_GetCloudArchivingConfigWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_GetCloudArchivingConfigWSResponse'
description: OK
summary: Get cloud archiving config
tags:
- Camera Webservice
/api/camera/getConfig:
post:
deprecated: true
description: Get a camera's config
operationId: getCameraConfig
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/Camera_GetConfigWSRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Camera_GetConfigWSResponse'
description: OK
summary: Get camera config
tags:
- Camera Webservice
/api/camera/getCurrentState:
post:
deprecated: true
description: Use /getFullCameraState instead
operationId: getCurrentCameraState
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:
ap
# --- truncated at 32 KB (242 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rhombus-systems/refs/heads/main/openapi/rhombus-systems-camera-webservice-api-openapi.yml