Skip to content

Request live frame

Request

Get a recent video frame from a camera.

Security
api_key
Bodyapplication/jsonrequired

The FrameRequest that contains the camera to fetch a frame for.

cameraIdstring, (uuid)required
curl -i -X POST \
  https://coreapi.hoxton.ai/_mock/v1/frame-requests \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "cameraId": "cbc3283e-6217-4855-9934-148717cbeefe"
  }'

Responses

OK.

Bodyapplication/json
imagestring
timestampstring, (date-time)
Response
{
  "image": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}