Skip to main content
POST
Get exact frame data

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 fetching the bytes of an exact frame from a camera.

cameraUuid
string<DeviceFacetUuid> | null
required
DeviceFacetUuid

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

timestampMs
integer<int64> | null
required
int64

Timestamp in epoch milliseconds

downscaleFactor
integer<int32> | null
int32

Ratio to shrink the image pixels by. Defaults to 1 (full resolution).

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

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
int32

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
int32

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
int32

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 bytes of the requested frame data in base64 format

error
boolean | null
errorMsg
string | null
frameData
string | null

Base64-encoded image bytes for the requested frame. Null if no frame could be retrieved.

mimeType
string | null

MIME type of the encoded frame data

Example:

"image/jpeg"

responseMessage
string | null

Human-readable message describing the result

Example:

"Frame retrieved successfully"

warningMsg
string | null
Last modified on August 2, 2026