Skip to main content
POST
Get exact frame URI

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 generating URL to get an exact frame with optional crop 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

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

Adjust quality of image compression

Required range: 0 <= x <= 100
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 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
Last modified on August 21, 2026