Skip to main content
POST
/
api
/
video
/
getExactFrameUri
Get exact frame URI
curl --request POST \
  --url https://api2.rhombussystems.com/api/video/getExactFrameUri \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "timestampMs": 123,
  "downscaleFactor": 2,
  "jpgQuality": 50,
  "permyriadCropHeight": 5000,
  "permyriadCropWidth": 5000,
  "permyriadCropX": 5000,
  "permyriadCropY": 5000
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "frameUri": "https://example.com/frame/12345.jpg",
  "responseMessage": "Frame generated successfully",
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for generating URL to get an exact frame with optional crop from a camera.

​
cameraUuid
string<DeviceFacetUuid> | null
required

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

​
timestampMs
integer<int64> | null
required

Timestamp in epoch milliseconds

​
downscaleFactor
integer<int32> | null

Ratio to shrink the image pixels by

Required range: x >= 1
​
jpgQuality
integer<int32> | null

Adjust quality of image compression

Required range: 0 <= x <= 100
​
permyriadCropHeight
integer<int32> | null

Precise ratio to crop the height by. Capped at 10000, which is 100.00% of the image

Required range: 0 <= x <= 10000
​
permyriadCropWidth
integer<int32> | null

Precise ratio to crop the width by. Capped at 10000, which is 100.00% of the image

Required range: 0 <= x <= 10000
​
permyriadCropX
integer<int32> | null

Proportional location to start horizontal crop at. Where 10000 is 100.00% of, or the end of the image

Required range: 0 <= x <= 10000
​
permyriadCropY
integer<int32> | null

Proportional location to start vertical crop at. Where 10000 is 100.00% of, or the end of the image

Required range: 0 <= x <= 10000

Response

200 - application/json

OK

Response object containing the exact frame URI.

​
error
boolean | null
​
errorMsg
string | null
​
frameUri
string | null

URI to access the exact frame

Example:

"https://example.com/frame/12345.jpg"

​
responseMessage
string | null

Response message from the frame generation

Example:

"Frame generated successfully"

​
warningMsg
string | null