Update a draft

PUT

/v1/datasets/{datasetId}/annotations/draft

curl -X PUT 'https://api.embodiflow.io/v1/datasets/{datasetId}/annotations/draft' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "datasetVersionId": "00000000-0000-0000-0000-000000000000",
    "timeRangeAnnotations": [
      {
        "datasetVersionId": "00000000-0000-0000-0000-000000000000",
        "annotationSchemaId": "00000000-0000-0000-0000-000000000000",
        "segmentKind": "action",
        "startSec": 0,
        "startNsec": 0,
        "endSec": 0,
        "endNsec": 0,
        "timeReference": "string",
        "title": "string",
        "naturalLanguageInstruction": "string",
        "success": true,
        "score": 0,
        "failureReason": "string",
        "parentId": "00000000-0000-0000-0000-000000000000",
        "orderIndex": 0,
        "reviewStatus": "string",
        "status": "string",
        "attributesJson": {}
      }
    ],
    "frameSpatialAnnotations": [
      {
        "datasetVersionId": "00000000-0000-0000-0000-000000000000",
        "datasetVersionFileId": "00000000-0000-0000-0000-000000000000",
        "frameIndex": 0,
        "frameStampSec": 0,
        "frameStampNsec": 0,
        "timeReference": "string",
        "datasetClassId": "00000000-0000-0000-0000-000000000000",
        "className": "string",
        "trackId": "string",
        "trackKey": "string",
        "bboxX": 0,
        "bboxY": 0,
        "bboxWidth": 0,
        "bboxHeight": 0,
        "occluded": true,
        "truncated": true,
        "reviewStatus": "string",
        "status": "string",
        "attributesJson": {}
      }
    ]
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

datasetIdstringrequired

Request body

Content-Typeapplication/json

datasetVersionIdstring (uuid) | null
ADR 0172 D6 optional version scope; additive, omission keeps legacy behavior.
timeRangeAnnotationsarray<CreateDatasetTimeRangeAnnotationBodyDto>required
- datasetVersionIdstring (uuid) | null
- annotationSchemaIdstring (uuid) | null
- segmentKindstring
  Allowed values
  action
  segment
  event
  phase
  quality-issue
  task
  subtask
  skill
- startSecnumberrequired
- startNsecnumber
- endSecnumberrequired
- endNsecnumber
- timeReferencestringrequired
- titlestring | null
- naturalLanguageInstructionstring | null
- successboolean | null
- scorenumber | null
- failureReasonstring | null
- parentIdstring (uuid) | null
- orderIndexnumber
- reviewStatusstring
- statusstring
- attributesJsonobject | null
frameSpatialAnnotationsarray<CreateDatasetFrameSpatialAnnotationBodyDto>required
- datasetVersionIdstring (uuid) | null
- datasetVersionFileIdstring (uuid)required
- frameIndexnumberrequired
- frameStampSecnumber | null
- frameStampNsecnumber | null
- timeReferencestringrequired
- datasetClassIdstring (uuid) | null
- classNamestring | null
- trackIdstring | null
- trackKeystring | null
- bboxXnumberrequired
- bboxYnumberrequired
- bboxWidthnumberrequired
- bboxHeightnumberrequired
- occludedboolean | null
- truncatedboolean | null
- reviewStatusstring
- statusstring
- attributesJsonobject | null

Responses

Success

dataobjectrequired
- timeRangeAnnotationsarray<DatasetTimeRangeAnnotationDto>required
- frameSpatialAnnotationsarray<DatasetFrameSpatialAnnotationDto>required

Response example

{
  "data": {
    "timeRangeAnnotations": [
      {
        "id": "string",
        "tenantId": "string",
        "projectId": "string",
        "datasetId": "string",
        "datasetVersionId": "string",
        "annotationSchemaId": "string",
        "segmentKind": "string",
        "startSec": 0,
        "startNsec": 0,
        "endSec": 0,
        "endNsec": 0,
        "timeReference": "string",
        "title": "string",
        "naturalLanguageInstruction": "string",
        "success": false,
        "score": 0,
        "failureReason": "string",
        "parentId": "string",
        "orderIndex": 0,
        "reviewStatus": "string",
        "status": "string",
        "publishedSnapshotId": "string",
        "createdBy": "string",
        "updatedBy": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "deletedAt": "string",
        "attributesJson": {}
      }
    ],
    "frameSpatialAnnotations": [
      {
        "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": {}
      }
    ]
  }
}

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