Get an episode

GET

/v1/projects/{projectId}/episodes/{episodeId}

curl -X GET 'https://api.embodiflow.io/v1/projects/{projectId}/episodes/{episodeId}' \
  -H 'Authorization: Bearer $EMBODIFLOW_PAT'

Authorization

Send a personal access token with every request.

Authorization: Bearer PAT

Authentication guide

Path parameters

projectIdstringrequired
episodeIdstringrequired

Responses

Success

dataobjectrequired
- previewobjectrequired
- episodeIdstringrequired
- recordingIdstringrequired
- recordingNamestringrequired
- startNsnumberrequired
- endNsnumberrequired
- durationNsnumberrequired
- cameraKeysarray<string>required
- posterUrlstring | nullrequired
- taskobject | nullrequired
- outcomestring | nullrequired
- subtaskCountnumberrequired
- tagsarray<string>required
- attributesobjectrequired
- splitTagstring | nullrequired
- labelStatestringrequired
- verdictstringrequired
  Allowed values
  warning
  fail
  pass
  incomplete
  not_checked
- verdictReasonstring | nullrequired
- issueCountnumberrequired
- collectorany | nullrequired
- headRevisionIdstring | nullrequired
- confidencenumber | nullrequired
- excludedone ofrequired
- provenancestringrequired
  Allowed values
  human
  ai_proposed
- reviewedone ofrequired
- semanticScorenumber

Response example

{
  "data": {
    "preview": {
      "videoUrl": "string",
      "startSeconds": 0
    },
    "episodeId": "string",
    "recordingId": "string",
    "recordingName": "string",
    "startNs": 0,
    "endNs": 0,
    "durationNs": 0,
    "cameraKeys": [
      "string"
    ],
    "posterUrl": "string",
    "task": {
      "en": "string",
      "zh": "string"
    },
    "outcome": "string",
    "subtaskCount": 0,
    "tags": [
      "string"
    ],
    "attributes": {},
    "splitTag": "string",
    "labelState": "string",
    "verdict": "warning",
    "verdictReason": "string",
    "issueCount": 0,
    "collector": null,
    "headRevisionId": "string",
    "confidence": 0,
    "excluded": false,
    "provenance": "human",
    "reviewed": false,
    "semanticScore": 0
  }
}

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

{ "data": { "preview": { "videoUrl": "string", "startSeconds": 0 }, "episodeId": "string", "recordingId": "string", "recordingName": "string", "startNs": 0, "endNs": 0, "durationNs": 0, "cameraKeys": [ "string" ], "posterUrl": "string", "task": { "en": "string", "zh": "string" }, "outcome": "string", "subtaskCount": 0, "tags": [ "string" ], "attributes": {}, "splitTag": "string", "labelState": "string", "verdict": "warning", "verdictReason": "string", "issueCount": 0, "collector": null, "headRevisionId": "string", "confidence": 0, "excluded": false, "provenance": "human", "reviewed": false, "semanticScore": 0 } }