List camera images for a camera and time range

Returns a list of camera images for the specified camera and time range. For each image, the response includes the timestamp and a URL that can be used to download the image. These URLs are already signed, so no extra authentication is required.

GET /robots/{robotId}/cameraImages

List camera images for a camera and time range

cURL

curl --request GET \
  --url https://api.inorbit.ai/robots/{robotId}/cameraImages \
  --header 'x-auth-inorbit-app-key: <api-key>'

200

{
  "data": [
    [
      {
        "ts": 123,
        "url": "<unknown>"
      }
    ]
  ],
  "pagination": {
    "limit": 123,
    "page": 123,
    "hasMorePages": true
  }
}

Authorizations

x-auth-inorbit-app-key · string · header · required

InOrbit appKey authenticates API requests using a token.

You can obtain your appKey in the Authentication docs.

Path Parameters

robotId · string · required

The robot's id

Query Parameters

cameraId · string · required

The camera id (not to be confused with the camera topic). It can be obtained from the robot's camera configuration using the Config API or the InOrbit CLI (inorbit get config --kind RobotCamera).

startTs · string · required

The start timestamp

endTs · string · required

The end timestamp

limit · integer

Elements per page

page · integer

Page number

Response

200

application/json

Camera images

data · object[][]

Show child attributes

pagination · object

Show child attributes