Video
Get exact frame URI
Generate URL to get an exact frame with optional crop from a camera. The URL is served by the media relay the camera is connected to right now, so use it promptly. The response always has HTTP status 200; check the status field, and only treat the frame as retrievable when it is AVAILABLE.
POST/ api/ video/ getExactFrameUriAuthorizations
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.
OAuth explains tokens and scopes.
Headers
Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.
Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token
Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.
Length: 22 to 22
Body
application/json · object
Request object for generating URL to get an exact frame with optional crop from a camera.
RUUID with optional appended facet information
Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"
Ratio to shrink the image pixels by
Range: 1 to …
Adjust quality of image compression
Range: 0 to 100
Precise ratio to crop the height by. Capped at 10000, which is 100.00% of the image
Range: 0 to 10000
Precise ratio to crop the width by. Capped at 10000, which is 100.00% of the image
Range: 0 to 10000
Proportional location to start horizontal crop at. Where 10000 is 100.00% of, or the end of the image
Range: 0 to 10000
Proportional location to start vertical crop at. Where 10000 is 100.00% of, or the end of the image
Range: 0 to 10000
Timestamp in epoch milliseconds
Response
200 OK
application/json · object
Response object containing the exact frame URI.
Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.
URI to access the exact frame
Example: "https://example.com/frame/12345.jpg"
Response message from the frame generation
Example: "Frame generated successfully"
Outcome of an exact frame request. AVAILABLE is the only value under which a frame URI or frame data is returned; every other value explains why the frame cannot be served.
Available options: AVAILABLE, FUTURE_TIMESTAMP, CAMERA_DELETED, CAMERA_STATE_UNAVAILABLE, CAMERA_NOT_CONNECTED, MEDIA_STORAGE_DEVICE_NOT_CONNECTED, NOT_RECORDING_AT_TIMESTAMP, NO_FOOTAGE_AT_TIMESTAMP, MEDIA_ADDRESS_UNAVAILABLE, FRAME_RETRIEVAL_FAILED
Errors
Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.
400Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND, SELF_PROVISIONING_DISABLED, SKU_NOT_ALLOWED, QUANTITY_INVALID, AUTO_RENEW_REQUIRED, PROVISION_CAP_EXCEEDED, ACKNOWLEDGEMENT_REQUIRED, SIGNATURE_REQUIRED, APEX_VALIDATION, SKU_NOT_IN_PRICEBOOK.401Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.403Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT, NOT_VERIFIED_MSP, ORDER_NOT_YOURS.429Too Many Requests. errorCode is one of: RATE_LIMITED, QUOTE_RATE_LIMITED.500Internal Server Error. errorCode is one of: INTERNAL_ERROR.503Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE, SALESFORCE_UNAVAILABLE.