List frame spatial annotations for a dataset

GET

/v1/datasets/{datasetId}/frame-spatial-annotations

curl -X GET 'https://api.embodiflow.io/v1/datasets/{datasetId}/frame-spatial-annotations' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

datasetIdstringrequired

Query parameters

pageSizenumber
pageTokenstring
includeDeletedboolean

Responses

Success

dataarray<DatasetFrameSpatialAnnotationDto>required
- idstringrequired
- tenantIdstringrequired
- projectIdstringrequired
- datasetIdstringrequired
- datasetVersionIdstring | nullrequired
- datasetVersionFileIdstringrequired
- frameIndexnumberrequired
- frameStampSecnumber | nullrequired
- frameStampNsecnumber | nullrequired
- timeReferencestringrequired
- datasetClassIdstring | nullrequired
- classNamestring | nullrequired
- trackIdstring | nullrequired
- trackKeystring | nullrequired
- bboxXnumberrequired
- bboxYnumberrequired
- bboxWidthnumberrequired
- bboxHeightnumberrequired
- occludedone of | nullrequired
- truncatedone of | nullrequired
- reviewStatusstringrequired
- statusstringrequired
- publishedSnapshotIdstring | nullrequired
- createdBystring | nullrequired
- updatedBystring | nullrequired
- createdAtstringrequired
- updatedAtstringrequired
- deletedAtstring | nullrequired
- attributesJsonobject | nullrequired
metaobjectrequired
- pageSizenumberrequired
- requestIdstring
nextPageTokenstring
Opaque AIP-158 page token. Omitted when the collection is exhausted.

Response example

{
  "data": [
    {
      "id": "string",
      "tenantId": "string",
      "projectId": "string",
      "datasetId": "string",
      "datasetVersionId": "string",
      "datasetVersionFileId": "string",
      "frameIndex": 0,
      "frameStampSec": 0,
      "frameStampNsec": 0,
      "timeReference": "string",
      "datasetClassId": "string",
      "className": "string",
      "trackId": "string",
      "trackKey": "string",
      "bboxX": 0,
      "bboxY": 0,
      "bboxWidth": 0,
      "bboxHeight": 0,
      "occluded": false,
      "truncated": false,
      "reviewStatus": "string",
      "status": "string",
      "publishedSnapshotId": "string",
      "createdBy": "string",
      "updatedBy": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "deletedAt": "string",
      "attributesJson": {}
    }
  ],
  "meta": {
    "pageSize": 0,
    "requestId": "string"
  },
  "nextPageToken": "string"
}

Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1

{ "data": [ { "id": "string", "tenantId": "string", "projectId": "string", "datasetId": "string", "datasetVersionId": "string", "datasetVersionFileId": "string", "frameIndex": 0, "frameStampSec": 0, "frameStampNsec": 0, "timeReference": "string", "datasetClassId": "string", "className": "string", "trackId": "string", "trackKey": "string", "bboxX": 0, "bboxY": 0, "bboxWidth": 0, "bboxHeight": 0, "occluded": false, "truncated": false, "reviewStatus": "string", "status": "string", "publishedSnapshotId": "string", "createdBy": "string", "updatedBy": "string", "createdAt": "string", "updatedAt": "string", "deletedAt": "string", "attributesJson": {} } ], "meta": { "pageSize": 0, "requestId": "string" }, "nextPageToken": "string" }