Update a time range annotation

PATCH

/v1/datasets/{datasetId}/time-range-annotations/{annotationId}

curl -X PATCH 'https://api.embodiflow.io/v1/datasets/{datasetId}/time-range-annotations/{annotationId}' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT' \
  -H 'Content-Type: application/json' \
  -d '{
    "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": {}
  }'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

datasetIdstringrequired
annotationIdstringrequired

Header parameters

If-Matchstring
Optional precondition. A matching tag proceeds and returns the new ETag. A stale tag returns 412 PRECONDITION_FAILED with no write. Absent proceeds (opt-in this release). If-Match: * succeeds when the resource exists. Malformed values return 400 IF_MATCH_INVALID.

Request body

Content-Typeapplication/json

datasetVersionIdstring (uuid) | null
annotationSchemaIdstring (uuid) | null
segmentKindstring
Allowed values
action
segment
event
phase
quality-issue
task
subtask
skill
startSecnumber
startNsecnumber
endSecnumber
endNsecnumber
timeReferencestring
titlestring | null
naturalLanguageInstructionstring | null
successboolean | null
scorenumber | null
failureReasonstring | null
parentIdstring (uuid) | null
orderIndexnumber
reviewStatusstring
statusstring
attributesJsonobject | null

Responses

Success

dataobjectrequired
- idstringrequired
- tenantIdstringrequired
- projectIdstringrequired
- datasetIdstringrequired
- datasetVersionIdstring | nullrequired
- annotationSchemaIdstring | nullrequired
- segmentKindstringrequired
- startSecnumberrequired
- startNsecnumberrequired
- endSecnumberrequired
- endNsecnumberrequired
- timeReferencestringrequired
- titlestring | nullrequired
- naturalLanguageInstructionstring | nullrequired
- successone of | nullrequired
- scorenumber | nullrequired
- failureReasonstring | nullrequired
- parentIdstring | nullrequired
- orderIndexnumberrequired
- reviewStatusstringrequired
- statusstringrequired
- publishedSnapshotIdstring | nullrequired
- createdBystring | nullrequired
- updatedBystring | nullrequired
- createdAtstringrequired
- updatedAtstringrequired
- deletedAtstring | nullrequired
- attributesJsonobject | nullrequired

Response example

{
  "data": {
    "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": {}
  }
}

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