Video Webservice

Splice frame

Send a request to create a single image from a point in time

post/api/video/spliceFrame

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/video/spliceFrame
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

deviceUuidstring DeviceFacetUuid nullable

RUUID with optional appended facet information

timestampMsinteger nullable

Timestamp in milliseconds for the frame

Example request

{
  "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
  "timestampMs": 1640995200000
}

Response

OK

clipUuidstring RUUID nullable

base 64 (url-safe) uuid string

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
regionstring nullable

Region where the frame clip is stored

warningMsgstring nullable

Example response

{
  "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "region": "us-west-2"
}

Changes

No recorded changes to this operation across all 1 revision of this API.