---
title: "Get raw frame metadata"
method: GET
path: "/frames"
tags: ["frames"]
---

# Get raw frame metadata

`GET /frames`

## Query parameters

- `sensorId` string, required
- `frameId` string
- `timestamp` string
- `fromTimestamp` string, date-time
- `toTimestamp` string, date-time
- `maxResultSize` integer

## Response `200`

Successful Operation.

- RawFrames
  - `frames` object[], required
    - `version` string, required
    - `id` integer, required
    - `objects` object[], required
      - `bbox` Bbox, required
        - `topY` number, double, required
        - `rightX` number, double, required
        - `bottomY` number, double, required
        - `leftX` number, double, required
        - `embeddings` object[], required
          - `vector` number[], required
        - `confidence` number, float, required
        - `info` object
      - `confidence` number, float, required
      - `type` string, required
      - `speed` number, float, required
      - `id` string, required
      - `info` object
      - `embedding` object, required
        - `vector` number[], required
        - `info` object
    - `timestamp` string, date-time, required
    - `sensorId` string, required
    - `info` object

## Other responses

- `400` — Bad Request. This response will be sent if any of the required params are not present or if extra params are passed. It will also be sent if parameter dependencies (mentioned in parameter descriptions) are not satisfied.
- `404` — Resource Not Found
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/nvidia/apis/vss-video-analytics-apis.md) · [All operations](https://skmtc.net/nvidia/apis/vss-video-analytics-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nvidia/vss-video-analytics-apis/versions/0ff2b2f41244/schema)